libvirt-python-api.xml

   1 <?xml version="1.0"?>
   2 <api name='libvir-python'>
   3   <symbols>
   4     <function name="virConnectListDomainsID" file='python'>
   5       <info>Returns the list of the ID of the domains on the hypervisor</info>
   6       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
   7       <return type='int *' info="the list of ID or None in case of error"/>
   8     </function>
   9     <function name='virConnectListDefinedDomains' file='python'>
  10       <info>list the defined domains, stores the pointers to the names in @names</info>
  11       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  12       <return type='str *' info='the list of Names of None in case of error'/>
  13     </function>
  14     <function name='virConnectListNetworks' file='python'>
  15       <info>list the networks, stores the pointers to the names in @names</info>
  16       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  17       <return type='str *' info='the list of Names of None in case of error'/>
  18     </function>
  19     <function name='virConnectListDefinedNetworks' file='python'>
  20       <info>list the defined networks, stores the pointers to the names in @names</info>
  21       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  22       <return type='str *' info='the list of Names of None in case of error'/>
  23     </function>
  24     <function name='virDomainLookupByUUID' file='python'>
  25       <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
  26       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
  27       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  28       <arg name='uuid' type='const unsigned char *' info='the UUID string for the domain, must be 16 bytes'/>
  29     </function>
  30     <function name='virNetworkLookupByUUID' file='python'>
  31       <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
  32       <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
  33       <arg name='conn' type='virNetworkPtr' info='pointer to the hypervisor connection'/>
  34       <arg name='uuid' type='const unsigned char *' info='the UUID string for the network, must be 16 bytes'/>
  35     </function>
  36     <function name='virDomainGetInfo' file='python'>
  37       <info>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
  38       <return type='int *' info='the list of information or None in case of error'/>
  39       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  40     </function>
  41     <function name='virNodeGetInfo' file='python'>
  42       <info>Extract hardware information about the Node.</info>
  43       <return type='int *' info='the list of information or None in case of error'/>
  44       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  45     </function>
  46     <function name='virDomainGetUUID' file='python'>
  47       <info>Extract the UUID unique Identifier of a domain.</info>
  48       <return type='char *' info='the 16 bytes string or None in case of error'/>
  49       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  50     </function>
  51     <function name='virDomainGetUUIDString' file='python'>
  52       <info>Fetch globally unique ID of the domain as a string.</info>
  53       <return type='char *' info='the UUID string or None in case of error'/>
  54       <arg name='pool' type='virDomainPtr' info='a domain object'/>
  55     </function>
  56     <function name='virNetworkGetUUID' file='python'>
  57       <info>Extract the UUID unique Identifier of a network.</info>
  58       <return type='char *' info='the 16 bytes string or None in case of error'/>
  59       <arg name='domain' type='virNetworkPtr' info='a network object'/>
  60     </function>
  61     <function name='virNetworkGetUUIDString' file='python'>
  62       <info>Fetch globally unique ID of the network as a string.</info>
  63       <return type='char *' info='the UUID string or None in case of error'/>
  64       <arg name='net' type='virNetworkPtr' info='a network object'/>
  65     </function>
  66     <function name='virStoragePoolGetUUID' file='python'>
  67       <info>Extract the UUID unique Identifier of a storage pool.</info>
  68       <return type='char *' info='the 16 bytes string or None in case of error'/>
  69       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
  70     </function>
  71     <function name='virStoragePoolGetUUIDString' file='python'>
  72       <info>Fetch globally unique ID of the storage pool as a string.</info>
  73       <return type='char *' info='the UUID string or None in case of error'/>
  74       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
  75     </function>
  76     <function name='virNetworkGetAutostart' file='python'>
  77       <info>Extract the autostart flag for a network.</info>
  78       <return type='int' info='the autostart flag, or None in case of error'/>
  79       <arg name='domain' type='virNetworkPtr' info='a network object'/>
  80     </function>
  81     <function name='virDomainGetAutostart' file='python'>
  82       <info>Extract the autostart flag for a domain</info>
  83       <return type='int' info='the autostart flag, or None in case of error'/>
  84       <arg name='domain' type='virDomainPtr' info='a network object'/>
  85     </function>
  86     <function name='virDomainBlockStats' file='python'>
  87       <info>Extracts block device statistics for a domain</info>
  88       <return type='virDomainBlockStats' info='a tuple of statistics'/>
  89       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  90       <arg name='path' type='char *' info='the path for the block device'/>
  91     </function>
  92     <function name='virDomainInterfaceStats' file='python'>
  93       <info>Extracts interface device statistics for a domain</info>
  94       <return type='virDomainInterfaceStats' info='a tuple of statistics'/>
  95       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  96       <arg name='path' type='char *' info='the path for the interface device'/>
  97     </function>
  98     <function name="virNodeGetCellsFreeMemory" file='python'>
  99       <info>Returns the available memory for a list of cells</info>
 100       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 101       <arg name='startCell' type='int' info='first cell in the list'/>
 102       <arg name='maxCells' type='int' info='number of cell in the list'/>
 103       <return type='int *' info="the list available memory in the cells"/>
 104     </function>
 105     <function name='virDomainGetSchedulerParameters' file='python'>
 106       <info>Get the scheduler parameters, the @params array will be filled with the values.</info>
 107       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 108       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 109     </function>
 110     <function name='virDomainGetSchedulerType' file='python'>
 111       <info>Get the scheduler type.</info>
 112       <return type='char *' info='NULL in case of error. The caller must free the returned string.'/>
 113       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 114     </function>
 115     <function name='virDomainGetVcpus' file='python'>
 116       <info>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer is&apos;nt NULL.</info>
 117       <return type='int' info='the number of info filled in case of success, -1 in case of failure.'/>
 118       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 119     </function>
 120     <function name='virDomainPinVcpu' file='python'>
 121       <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
 122       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 123       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 124       <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
 125       <arg name='cpumap' type='unsigned char *' info='pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.'/>
 126     </function>
 127     <function name='virDomainSetSchedulerParameters' file='python'>
 128       <info>Change the scheduler parameters</info>
 129       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 130       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 131       <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
 132     </function>
 133     <function name='virConnectListStoragePools' file='python'>
 134       <info>list the storage pools, stores the pointers to the names in @names</info>
 135       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 136       <return type='str *' info='the list of Names of None in case of error'/>
 137     </function>
 138     <function name='virConnectListDefinedStoragePools' file='python'>
 139       <info>list the defined storage pool, stores the pointers to the names in @names</info>
 140       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 141       <return type='str *' info='the list of Names of None in case of error'/>
 142     </function>
 143     <function name='virStoragePoolListVolumes' file='python'>
 144       <info>list the storage volumes, stores the pointers to the names in @names</info>
 145       <arg name='pool' type='virStoragePoolPtr' info='pointer to the storage pool'/>
 146       <return type='str *' info='the list of Names of None in case of error'/>
 147     </function>
 148     <function name='virStoragePoolGetInfo' file='python'>
 149       <info>Extract information about a storage pool. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
 150       <return type='int *' info='the list of information or None in case of error'/>
 151       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
 152     </function>
 153     <function name='virStorageVolGetInfo' file='python'>
 154       <info>Extract information about a storage pool. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
 155       <return type='int *' info='the list of information or None in case of error'/>
 156       <arg name='vol' type='virStorageVolPtr' info='a storage vol object'/>
 157     </function>
 158   </symbols>
 159 </api>