libvirt-override-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='virStoragePoolGetAutostart' file='python'>
  87       <info>Extract the autostart flag for a storage pool</info>
  88       <return type='int' info='the autostart flag, or None in case of error'/>
  89       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
  90     </function>
  91     <function name='virDomainBlockStats' file='python'>
  92       <info>Extracts block device statistics for a domain</info>
  93       <return type='virDomainBlockStats' info='a tuple of statistics'/>
  94       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  95       <arg name='path' type='char *' info='the path for the block device'/>
  96     </function>
  97     <function name='virDomainInterfaceStats' file='python'>
  98       <info>Extracts interface device statistics for a domain</info>
  99       <return type='virDomainInterfaceStats' info='a tuple of statistics'/>
 100       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 101       <arg name='path' type='char *' info='the path for the interface device'/>
 102     </function>
 103     <function name="virNodeGetCellsFreeMemory" file='python'>
 104       <info>Returns the available memory for a list of cells</info>
 105       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 106       <arg name='startCell' type='int' info='first cell in the list'/>
 107       <arg name='maxCells' type='int' info='number of cell in the list'/>
 108       <return type='int *' info="the list available memory in the cells"/>
 109     </function>
 110     <function name='virDomainGetSchedulerParameters' file='python'>
 111       <info>Get the scheduler parameters, the @params array will be filled with the values.</info>
 112       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 113       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 114     </function>
 115     <function name='virDomainGetSchedulerType' file='python'>
 116       <info>Get the scheduler type.</info>
 117       <return type='char *' info='NULL in case of error. The caller must free the returned string.'/>
 118       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 119     </function>
 120     <function name='virDomainGetVcpus' file='python'>
 121       <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>
 122       <return type='int' info='the number of info filled 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     </function>
 125     <function name='virDomainPinVcpu' file='python'>
 126       <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
 127       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 128       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 129       <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
 130       <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.'/>
 131     </function>
 132     <function name='virDomainSetSchedulerParameters' file='python'>
 133       <info>Change the scheduler parameters</info>
 134       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 135       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 136       <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
 137     </function>
 138     <function name='virConnectListStoragePools' file='python'>
 139       <info>list the storage pools, 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='virConnectListDefinedStoragePools' file='python'>
 144       <info>list the defined storage pool, stores the pointers to the names in @names</info>
 145       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 146       <return type='str *' info='the list of Names of None in case of error'/>
 147     </function>
 148     <function name='virStoragePoolListVolumes' file='python'>
 149       <info>list the storage volumes, stores the pointers to the names in @names</info>
 150       <arg name='pool' type='virStoragePoolPtr' info='pointer to the storage pool'/>
 151       <return type='str *' info='the list of Names of None in case of error'/>
 152     </function>
 153     <function name='virStoragePoolGetInfo' 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='pool' type='virStoragePoolPtr' info='a storage pool object'/>
 157     </function>
 158     <function name='virStorageVolGetInfo' file='python'>
 159       <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>
 160       <return type='int *' info='the list of information or None in case of error'/>
 161       <arg name='vol' type='virStorageVolPtr' info='a storage vol object'/>
 162     </function>
 163     <function name='virNodeListDevices' file='python'>
 164       <info>list the node devices</info>
 165       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 166       <arg name='cap' type='const unsigned char *' info='capability name'/>
 167       <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
 168       <return type='str *' info='the list of Names or None in case of error'/>
 169     </function>
 170     <function name='virNodeDeviceListCaps' file='python'>
 171       <info>list the node device's capabilities</info>
 172       <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
 173       <return type='str *' info='the list of Names or None in case of error'/>
 174     </function>
 175     <function name='virSecretGetValue' file='libvirt' module='libvirt'>
 176       <info>Fetches the value associated with a secret.</info>
 177       <return type='char *' info='the secret value or None in case of error'/>
 178       <arg name='secret' type='virSecretPtr' info='virSecret secret'/>
 179       <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
 180     </function>
 181     <function name='virConnectListSecrets' file='libvirt' module='libvirt'>
 182       <info>List the defined secret IDs</info>
 183       <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
 184       <return type='str *' info='the list of secret IDs or None in case of error'/>
 185     </function>
 186     <function name='virSecretSetValue' file='libvirt' module='libvirt'>
 187       <info>Associates a value with a secret.</info>
 188       <return type='int' info='0 on success, -1 on failure.'/>
 189       <arg name='secret' type='virSecretPtr' info='virSecret secret'/>
 190       <arg name='value' type='const char *' info='The secret value'/>
 191       <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
 192     </function>
 193     <function name='virSecretLookupByUUID' file='python'>
 194       <info>Try to lookup a secret on the given hypervisor based on its UUID.</info>
 195       <return type='virSecretPtr' info='a new secret object or NULL in case of failure'/>
 196       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 197       <arg name='uuid' type='const unsigned char *' info='the UUID string for the secret, must be 16 bytes'/>
 198     </function>
 199     <function name='virSecretGetUUID' file='python'>
 200       <info>Extract the UUID unique Identifier of a secret.</info>
 201       <return type='char *' info='the 16 bytes string or None in case of error'/>
 202       <arg name='secret' type='virSecretPtr' info='a secret object'/>
 203     </function>
 204     <function name='virSecretGetUUIDString' file='python'>
 205       <info>Fetch globally unique ID of the secret as a string.</info>
 206       <return type='char *' info='the UUID string or None in case of error'/>
 207       <arg name='secret' type='virSecretPtr' info='a secret object'/>
 208     </function>
 209   </symbols>
 210 </api>