libvirt-override-api.xml

   1 <?xml version="1.0"?>
   2 <api name='libvir-python'>
   3   <!-- This file lists libvirt API functions whose Python stubs are
   4        written by hand in libvirt-override.c, but the Python-level code
   5        are still automatically generated by the generator.py script.
   6
   7        The type of return value is supposed to be C type. If a function's
   8        stub will return a python non-integer data type like string, list,
   9        tuple, dictionary, etc, please use "char *" as the type of its return
  10        value.
  11   -->
  12   <symbols>
  13     <function name="virConnectGetVersion" file='python'>
  14       <info>Returns the running hypervisor version of the connection host</info>
  15       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  16       <return type='int' info="0 on success, -1 on error"/>
  17     </function>
  18     <function name="virConnectGetLibVersion" file='python'>
  19       <info>Returns the libvirt version of the connection host</info>
  20       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  21       <return type='int' info="0 on success, -1 on error"/>
  22     </function>
  23     <function name="virConnectListDomainsID" file='python'>
  24       <info>Returns the list of the ID of the domains on the hypervisor</info>
  25       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  26       <return type='char *' info="the list of ID or None in case of error"/>
  27     </function>
  28     <function name='virConnectListDefinedDomains' file='python'>
  29       <info>list the defined domains, stores the pointers to the names in @names</info>
  30       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  31       <return type='char *' info='the list of Names or None in case of error'/>
  32     </function>
  33     <function name='virConnectListAllDomains' file='python'>
  34       <info>returns list of all defined domains</info>
  35       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  36       <arg name='flags' type='unsigned int' info='optional flags'/>
  37       <return type='char *' info='the list of domains or None in case of error'/>
  38     </function>
  39     <function name='virConnectListNetworks' file='python'>
  40       <info>list the networks, stores the pointers to the names in @names</info>
  41       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  42       <return type='char *' info='the list of Names or None in case of error'/>
  43     </function>
  44     <function name='virConnectListDefinedNetworks' file='python'>
  45       <info>list the defined networks, stores the pointers to the names in @names</info>
  46       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  47       <return type='char *' info='the list of Names or None in case of error'/>
  48     </function>
  49     <function name='virConnectListAllNetworks' file='python'>
  50       <info>returns list of all networks</info>
  51       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  52       <arg name='flags' type='unsigned int' info='optional flags'/>
  53       <return type='char *' info='the list of networks or None in case of error'/>
  54     </function>
  55     <function name='virDomainLookupByUUID' file='python'>
  56       <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
  57       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
  58       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  59       <arg name='uuid' type='const unsigned char *' info='the UUID string for the domain, must be 16 bytes'/>
  60     </function>
  61     <function name='virNetworkLookupByUUID' file='python'>
  62       <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
  63       <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
  64       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  65       <arg name='uuid' type='const unsigned char *' info='the UUID string for the network, must be 16 bytes'/>
  66     </function>
  67     <function name='virDomainGetInfo' file='python'>
  68       <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>
  69       <return type='char *' info='the list of information or None in case of error'/>
  70       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  71     </function>
  72     <function name='virDomainGetState' file='python'>
  73       <info>Extract domain state.</info>
  74       <return type='char *' info='the list containing state and reason or None in case of error'/>
  75       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  76       <arg name='flags' type='unsigned int' info='additional flags'/>
  77     </function>
  78     <function name='virDomainGetControlInfo' file='python'>
  79       <info>Extract details about current state of control interface to a domain.</info>
  80       <return type='char *' info='the list of information or None in case of error'/>
  81       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  82       <arg name='flags' type='unsigned int' info='additional flags'/>
  83     </function>
  84     <function name='virDomainGetBlockInfo' file='python'>
  85       <info>Extract information about a domain block device size</info>
  86       <return type='char *' info='the list of information or None in case of error'/>
  87       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  88       <arg name='path' type='const char *' info='path to the block device or file'/>
  89       <arg name='flags' type='unsigned int' info='currently unused'/>
  90     </function>
  91     <function name='virDomainGetJobInfo' file='python'>
  92       <info>Extract information about an active job being processed for a domain.</info>
  93       <return type='char *' info='the list of information or None in case of error'/>
  94       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  95     </function>
  96     <function name='virDomainGetJobStats' file='python'>
  97       <info>Extract information about an active job being processed for a domain.</info>
  98       <return type='char *' info='dictionary mapping field names to values or None in case of error'/>
  99       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 100       <arg name='flags' type='unsigned int' info='flags, currently unused, pass 0.'/>
 101     </function>
 102     <function name='virNodeGetInfo' file='python'>
 103       <info>Extract hardware information about the Node. Note that the memory size is reported in MiB instead of KiB.</info>
 104       <return type='char *' info='the list of information or None in case of error'/>
 105       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 106     </function>
 107     <function name='virNodeGetSecurityModel' file='python'>
 108       <info>Extract information about the hypervisor security model</info>
 109       <return type='char *' info='the list of information or None in case of error'/>
 110       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 111     </function>
 112     <function name='virDomainGetSecurityLabel' file='python'>
 113       <info>Extract information about the domain security label. Only the first label will be returned.</info>
 114       <return type='char *' info='the list of information or None in case of error'/>
 115       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 116     </function>
 117     <function name='virDomainGetSecurityLabelList' file='python'>
 118       <info>Extract information about the domain security label. A list of all labels will be returned.</info>
 119       <return type='char *' info='the list of information or None in case of error'/>
 120       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 121     </function>
 122     <function name='virNodeGetCPUStats' file='python'>
 123       <info>Extract node's CPU statistics.</info>
 124       <return type='char *' info='dictionary mapping field names to values or None in case of error'/>
 125       <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
 126       <arg name='cpuNum' type='int' info='number of node cpu. (VIR_NODE_CPU_STATS_ALL_CPUS means total cpu statistics)'/>
 127       <arg name='flags' type='unsigned int' info='additional flags'/>
 128     </function>
 129     <function name='virNodeGetMemoryStats' file='python'>
 130       <info>Extract node's memory statistics.</info>
 131       <return type='char *' info='dictionary mapping field names to values or None in case of error'/>
 132       <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
 133       <arg name='cellNum' type='int' info='number of node cell. (VIR_NODE_MEMORY_STATS_ALL_CELLS means total cell statistics)'/>
 134       <arg name='flags' type='unsigned int' info='additional flags'/>
 135     </function>
 136     <function name='virDomainGetUUID' file='python'>
 137       <info>Extract the UUID unique Identifier of a domain.</info>
 138       <return type='char *' info='the 16 bytes string or None in case of error'/>
 139       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 140     </function>
 141     <function name='virDomainGetUUIDString' file='python'>
 142       <info>Fetch globally unique ID of the domain as a string.</info>
 143       <return type='char *' info='the UUID string or None in case of error'/>
 144       <arg name='pool' type='virDomainPtr' info='a domain object'/>
 145     </function>
 146     <function name='virNetworkGetUUID' file='python'>
 147       <info>Extract the UUID unique Identifier of a network.</info>
 148       <return type='char *' info='the 16 bytes string or None in case of error'/>
 149       <arg name='domain' type='virNetworkPtr' info='a network object'/>
 150     </function>
 151     <function name='virNetworkGetUUIDString' file='python'>
 152       <info>Fetch globally unique ID of the network as a string.</info>
 153       <return type='char *' info='the UUID string or None in case of error'/>
 154       <arg name='net' type='virNetworkPtr' info='a network object'/>
 155     </function>
 156     <function name='virStoragePoolGetUUID' file='python'>
 157       <info>Extract the UUID unique Identifier of a storage pool.</info>
 158       <return type='char *' info='the 16 bytes string or None in case of error'/>
 159       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
 160     </function>
 161     <function name='virStoragePoolGetUUIDString' file='python'>
 162       <info>Fetch globally unique ID of the storage pool as a string.</info>
 163       <return type='char *' info='the UUID string or None in case of error'/>
 164       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
 165     </function>
 166     <function name='virNetworkGetAutostart' file='python'>
 167       <info>Extract the autostart flag for a network.</info>
 168       <return type='int' info='the autostart flag, or None in case of error'/>
 169       <arg name='domain' type='virNetworkPtr' info='a network object'/>
 170     </function>
 171     <function name='virDomainGetAutostart' file='python'>
 172       <info>Extract the autostart flag for a domain</info>
 173       <return type='int' info='the autostart flag, or None in case of error'/>
 174       <arg name='domain' type='virDomainPtr' info='a network object'/>
 175     </function>
 176     <function name='virStoragePoolGetAutostart' file='python'>
 177       <info>Extract the autostart flag for a storage pool</info>
 178       <return type='int' info='the autostart flag, or None in case of error'/>
 179       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
 180     </function>
 181     <function name='virDomainBlockStats' file='python'>
 182       <info>Extracts block device statistics for a domain</info>
 183       <return type='char *' info='a tuple of statistics'/>
 184       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 185       <arg name='path' type='char *' info='the path for the block device'/>
 186     </function>
 187     <function name='virDomainBlockStatsFlags' file='python'>
 188       <info>Extracts block device statistics parameters of a running domain</info>
 189       <return type='char *' info='None in case of error, returns a dictionary of params'/>
 190       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 191       <arg name='path' type='char *' info='the path for the block device'/>
 192       <arg name='flags' type='int' info='flags (unused; pass 0)'/>
 193     </function>
 194     <function name='virDomainGetCPUStats' file='python'>
 195       <info>Extracts CPU statistics for a running domain. On success it will
 196    return a list of data of dictionary type. If boolean total is False or 0, the
 197    first element of the list refers to CPU0 on the host, second element is
 198    CPU1, and so on. The format of data struct is as follows:
 199    [{cpu_time:xxx}, {cpu_time:xxx}, ...]
 200    If it is True or 1, it returns total domain CPU statistics in the format of
 201    [{cpu_time:xxx, user_time:xxx, system_time:xxx}]</info>
 202      <return type='char *' info='returns a list of dictionary in case of success, None in case of error'/>
 203      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 204      <arg name='total' type='bool' info='on true, return total domain CPU statistics, false return per-cpu info'/>
 205      <arg name='flags' type='int' info='flags (unused; pass 0)'/>
 206     </function>
 207     <function name='virDomainInterfaceStats' file='python'>
 208       <info>Extracts interface device statistics for a domain</info>
 209       <return type='char *' info='a tuple of statistics'/>
 210       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 211       <arg name='path' type='char *' info='the path for the interface device'/>
 212     </function>
 213     <function name='virDomainMemoryStats' file='python'>
 214       <info>Extracts memory statistics for a domain</info>
 215       <return type='char *' info='a dictionary of statistics'/>
 216       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 217     </function>
 218     <function name="virNodeGetCellsFreeMemory" file='python'>
 219       <info>Returns the available memory for a list of cells</info>
 220       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 221       <arg name='startCell' type='int' info='first cell in the list'/>
 222       <arg name='maxCells' type='int' info='number of cell in the list'/>
 223       <return type='char *' info="the list available memory in the cells"/>
 224     </function>
 225     <function name='virDomainGetSchedulerParameters' file='python'>
 226       <info>Get the scheduler parameters, the @params array will be filled with the values.</info>
 227       <return type='char *' info='None in case of error, returns a dictionary of params.'/>
 228       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 229     </function>
 230     <function name='virDomainGetSchedulerParametersFlags' file='python'>
 231       <info>Get the scheduler parameters</info>
 232      <return type='char *' info='None in case of error, returns a dictionary of params'/>
 233      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 234      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 235     </function>
 236     <function name='virDomainGetSchedulerType' file='python'>
 237       <info>Get the scheduler type.</info>
 238       <return type='char *' info='NULL in case of error. The caller must free the returned string.'/>
 239       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 240     </function>
 241     <function name='virDomainGetVcpus' file='python'>
 242       <info>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps.</info>
 243       <return type='char *' info='None in case of error, returns a tuple of vcpu info and vcpu map.'/>
 244       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 245     </function>
 246     <function name='virDomainPinVcpu' file='python'>
 247       <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
 248       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 249       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 250       <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
 251       <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.'/>
 252     </function>
 253     <function name='virDomainPinVcpuFlags' file='python'>
 254       <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
 255       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 256       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 257       <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
 258       <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.'/>
 259       <arg name='flags' type='int' info='flags to specify'/>
 260     </function>
 261     <function name='virDomainGetVcpuPinInfo' file='python'>
 262       <info>Query the CPU affinity setting of all virtual CPUs of domain</info>
 263       <return type='char *' info='the array of cpumap'/>
 264       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 265       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 266     </function>
 267     <function name='virDomainGetEmulatorPinInfo' file='python'>
 268       <info>Query the CPU affinity setting of the emulator process of domain</info>
 269       <return type='char *' info='the array of cpumap'/>
 270       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 271       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 272     </function>
 273     <function name='virDomainPinEmulator' file='python'>
 274       <info>Dynamically change the real CPUs which can be allocated to the emulator process of a domain.
 275             This function requires privileged access to the hypervisor.</info>
 276       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 277       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 278       <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.'/>
 279       <arg name='flags' type='int' info='flags to specify'/>
 280     </function>
 281     <function name='virDomainGetIOThreadInfo' file='python'>
 282       <info>Query the CPU affinity setting of the IOThreads of the domain</info>
 283       <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
 284       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 285       <return type='char *' info="list of IOThreads information including the iothread_id, the cpumap, and the cpumap length for each iothread_id."/>
 286     </function>
 287     <function name='virDomainPinIOThread' file='python'>
 288       <info>Dynamically change the real CPUs which can be allocated to an IOThread. This function requires privileged access to the hypervisor.</info>
 289       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 290       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 291       <arg name='iothread_val' type='unsigned int' info='iothread_id number'/>
 292       <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.'/>
 293       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 294     </function>
 295     <function name='virDomainSetSchedulerParameters' file='python'>
 296       <info>Change the scheduler parameters</info>
 297       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 298       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 299       <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
 300     </function>
 301     <function name='virDomainSetSchedulerParametersFlags' file='python'>
 302       <info>Change the scheduler parameters</info>
 303       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 304       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 305       <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
 306       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 307     </function>
 308     <function name='virDomainSetBlkioParameters' file='python'>
 309       <info>Change the blkio tunables</info>
 310       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 311       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 312       <arg name='params' type='virBlkioParameterPtr' info='pointer to blkio tunable objects'/>
 313       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 314     </function>
 315     <function name='virDomainGetBlkioParameters' file='python'>
 316       <info>Get the blkio parameters</info>
 317       <return type='char *' info='None in case of error, returns a dictionary of params'/>
 318       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 319       <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 320     </function>
 321     <function name='virDomainSetMemoryParameters' file='python'>
 322       <info>Change the memory tunables</info>
 323       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 324       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 325       <arg name='params' type='virMemoryParameterPtr' info='pointer to memory tunable objects'/>
 326       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 327     </function>
 328     <function name='virDomainGetMemoryParameters' file='python'>
 329       <info>Get the memory parameters</info>
 330       <return type='char *' info='None in case of error, returns a dictionary of params'/>
 331       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 332       <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 333     </function>
 334     <function name='virDomainSetNumaParameters' file='python'>
 335       <info>Change the NUMA tunables</info>
 336       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 337       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 338       <arg name='params' type='virTypedParameterPtr' info='pointer to numa tunable objects'/>
 339       <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 340     </function>
 341     <function name='virDomainGetNumaParameters' file='python'>
 342       <info>Get the NUMA parameters</info>
 343       <return type='char *' info='returns a dictionary of params in case of success, None in case of error'/>
 344       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 345       <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 346     </function>
 347     <function name='virDomainGetPerfEvents' file='python'>
 348       <info>Get all perf events setting.</info>
 349       <return type='char *' info='returns a dictionary of params in case of success, None in case of error'/>
 350       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 351       <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 352     </function>
 353     <function name='virDomainSetPerfEvents' file='python'>
 354       <info>Enable or disable the particular list of perf events</info>
 355       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 356       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 357       <arg name='params' type='virTypedParameterPtr' info='pointer to perf events parameter object'/>
 358       <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 359     </function>
 360     <function name='virDomainSetInterfaceParameters' file='python'>
 361       <info>Change the bandwidth tunables for a interface device</info>
 362       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 363       <arg name='device' type='const char *' info='interface name'/>
 364       <arg name='params' type='virTypedParameterPtr' info='Pointer to bandwidth tuning params object'/>
 365       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 366       <return type='int' info='0 in case of success, -1 in case of failure'/>
 367     </function>
 368     <function name='virDomainGetInterfaceParameters' file='python'>
 369       <info>Get the bandwidth tunables for a interface device</info>
 370       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 371       <arg name='device' type='const char *' info='interface name'/>
 372       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 373       <return type='char *' info='the bandwidth tunables value or None in case of error'/>
 374     </function>
 375
 376     <function name='virConnectListStoragePools' file='python'>
 377       <info>list the storage pools, stores the pointers to the names in @names</info>
 378       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 379       <return type='char *' info='the list of Names of None in case of error'/>
 380     </function>
 381     <function name='virConnectListDefinedStoragePools' file='python'>
 382       <info>list the defined storage pool, stores the pointers to the names in @names</info>
 383       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 384       <return type='char *' info='the list of Names of None in case of error'/>
 385     </function>
 386     <function name='virConnectListAllStoragePools' file='python'>
 387       <info>returns list of all storage pools</info>
 388       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 389       <arg name='flags' type='unsigned int' info='optional flags'/>
 390       <return type='char *' info='the list of pools or None in case of error'/>
 391     </function>
 392     <function name='virStoragePoolListVolumes' file='python'>
 393       <info>list the storage volumes, stores the pointers to the names in @names</info>
 394       <arg name='pool' type='virStoragePoolPtr' info='pointer to the storage pool'/>
 395       <return type='char *' info='the list of Names or None in case of error'/>
 396     </function>
 397     <function name='virStoragePoolListAllVolumes' file='python'>
 398       <info>return list of storage volume objects</info>
 399       <arg name='pool' type='virStoragePoolPtr' info='pointer to the storage pool'/>
 400       <arg name='flags' type='unsigned int' info='optional flags'/>
 401       <return type='char *' info='the list of volumes or None in case of error'/>
 402     </function>
 403     <function name='virStoragePoolGetInfo' file='python'>
 404       <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>
 405       <return type='char *' info='the list of information or None in case of error'/>
 406       <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
 407     </function>
 408     <function name='virStorageVolGetInfo' file='python'>
 409       <info>Extract information about a storage volume. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
 410       <return type='char *' info='the list of information or None in case of error'/>
 411       <arg name='vol' type='virStorageVolPtr' info='a storage vol object'/>
 412     </function>
 413     <function name='virStorageVolGetInfoFlags' file='python'>
 414       <info>Extract information about a storage volume. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
 415       <return type='char *' info='the list of information or None in case of error'/>
 416       <arg name='vol' type='virStorageVolPtr' info='a storage vol object'/>
 417       <arg name='flags' type='unsigned int' info='bitwise-OR of virStorageVolInfoFlags'/>
 418     </function>
 419     <function name='virNodeListDevices' file='python'>
 420       <info>list the node devices</info>
 421       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 422       <arg name='cap' type='const unsigned char *' info='capability name'/>
 423       <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
 424       <return type='char *' info='the list of Names or None in case of error'/>
 425     </function>
 426     <function name='virConnectListAllNodeDevices' file='python'>
 427       <info>returns list of all host node devices</info>
 428       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 429       <arg name='flags' type='unsigned int' info='optional flags'/>
 430       <return type='char *' info='the list of host node device or None in case of error'/>
 431     </function>
 432     <function name='virNodeDeviceListCaps' file='python'>
 433       <info>list the node device's capabilities</info>
 434       <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
 435       <return type='char *' info='the list of Names or None in case of error'/>
 436     </function>
 437     <function name='virSecretGetValue' file='libvirt' module='libvirt'>
 438       <info>Fetches the value associated with a secret.</info>
 439       <return type='char *' info='the secret value or None in case of error'/>
 440       <arg name='secret' type='virSecretPtr' info='virSecret secret'/>
 441       <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
 442     </function>
 443     <function name='virConnectListSecrets' file='libvirt' module='libvirt'>
 444       <info>List the defined secret IDs</info>
 445       <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
 446       <return type='char *' info='the list of secret IDs or None in case of error'/>
 447     </function>
 448     <function name='virConnectListAllSecrets' file='python'>
 449       <info>returns list of all interfaces</info>
 450       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 451       <arg name='flags' type='unsigned int' info='optional flags'/>
 452       <return type='char *' info='the list of secrets or None in case of error'/>
 453     </function>
 454     <function name='virSecretSetValue' file='libvirt' module='libvirt'>
 455       <info>Associates a value with a secret.</info>
 456       <return type='int' info='0 on success, -1 on failure.'/>
 457       <arg name='secret' type='virSecretPtr' info='virSecret secret'/>
 458       <arg name='value' type='const char *' info='The secret value'/>
 459       <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
 460     </function>
 461     <function name='virSecretLookupByUUID' file='python'>
 462       <info>Try to lookup a secret on the given hypervisor based on its UUID.</info>
 463       <return type='virSecretPtr' info='a new secret object or NULL in case of failure'/>
 464       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 465       <arg name='uuid' type='const unsigned char *' info='the UUID string for the secret, must be 16 bytes'/>
 466     </function>
 467     <function name='virSecretGetUUID' file='python'>
 468       <info>Extract the UUID unique Identifier of a secret.</info>
 469       <return type='char *' info='the 16 bytes string or None in case of error'/>
 470       <arg name='secret' type='virSecretPtr' info='a secret object'/>
 471     </function>
 472     <function name='virSecretGetUUIDString' file='python'>
 473       <info>Fetch globally unique ID of the secret as a string.</info>
 474       <return type='char *' info='the UUID string or None in case of error'/>
 475       <arg name='secret' type='virSecretPtr' info='a secret object'/>
 476     </function>
 477     <function name='virConnectListNWFilters' file='libvirt' module='libvirt'>
 478       <info>List the defined network filters</info>
 479       <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
 480       <return type='char *' info='the list of network filter IDs or None in case of error'/>
 481     </function>
 482     <function name='virConnectListAllNWFilters' file='python'>
 483       <info>returns list of all network fitlers</info>
 484       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 485       <arg name='flags' type='unsigned int' info='optional flags'/>
 486       <return type='char *' info='the list of network filters or None in case of error'/>
 487     </function>
 488     <function name='virConnectListAllNWFilterBindings' file='python'>
 489       <info>returns list of all network fitler bindings</info>
 490       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 491       <arg name='flags' type='unsigned int' info='optional flags'/>
 492       <return type='char *' info='the list of network filter bindings or None in case of error'/>
 493     </function>
 494     <function name='virNWFilterLookupByUUID' file='python'>
 495       <info>Try to lookup a network filter on the given hypervisor based on its UUID.</info>
 496       <return type='virNWFilterPtr' info='a new network filter object or NULL in case of failure'/>
 497       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 498       <arg name='uuid' type='const unsigned char *' info='the UUID string for the secret, must be 16 bytes'/>
 499     </function>
 500     <function name='virNWFilterGetUUID' file='python'>
 501       <info>Extract the UUID unique Identifier of a network filter.</info>
 502       <return type='char *' info='the 16 bytes string or None in case of error'/>
 503       <arg name='nwfilter' type='virNWFilterPtr' info='a network filter object'/>
 504     </function>
 505     <function name='virNWFilterGetUUIDString' file='python'>
 506       <info>Fetch globally unique ID of the network filter as a string.</info>
 507       <return type='char *' info='the UUID string or None in case of error'/>
 508       <arg name='nwfilter' type='virNWFilterPtr' info='a network filter object'/>
 509     </function>
 510     <function name='virConnectListInterfaces' file='python'>
 511       <info>list the running interfaces, stores the pointers to the names in @names</info>
 512       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 513       <return type='char *' info='the list of Names of None in case of error'/>
 514     </function>
 515     <function name='virConnectListDefinedInterfaces' file='python'>
 516       <info>list the defined interfaces, stores the pointers to the names in @names</info>
 517       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 518       <return type='char *' info='the list of Names of None in case of error'/>
 519     </function>
 520     <function name='virConnectListAllInterfaces' file='python'>
 521       <info>returns list of all interfaces</info>
 522       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 523       <arg name='flags' type='unsigned int' info='optional flags'/>
 524       <return type='char *' info='the list of interfaces or None in case of error'/>
 525     </function>
 526     <function name='virConnectBaselineCPU' file='python'>
 527       <info>Computes the most feature-rich CPU which is compatible with all given host CPUs.</info>
 528       <return type='char *' info='XML description of the computed CPU or NULL on error.'/>
 529       <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
 530       <arg name='xmlCPUs' type='const char **' info='array of XML descriptions of host CPUs'/>
 531       <arg name='flags' type='unsigned int' info='fine-tuning flags, currently unused, pass 0.'/>
 532     </function>
 533     <function name='virConnectGetCPUModelNames' file='python'>
 534       <info>Get the list of supported CPU models.</info>
 535       <return type='char *' info='list of supported CPU models'/>
 536       <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
 537       <arg name='arch' type='const char *' info='arch'/>
 538       <arg name='flags' type='unsigned int' info='fine-tuning flags, currently unused, pass 0.'/>
 539     </function>
 540     <function name='virDomainSnapshotListNames' file='python'>
 541       <info>collect the list of snapshot names for the given domain</info>
 542       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 543       <arg name='flags' type='unsigned int' info='flags'/>
 544       <return type='char *' info='the list of Names or None in case of error'/>
 545     </function>
 546     <function name='virDomainListAllSnapshots' file='python'>
 547       <info>returns the list of snapshots for the given domain</info>
 548       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 549       <arg name='flags' type='unsigned int' info='flags'/>
 550       <return type='char *' info='the list of snapshots or None in case of error'/>
 551     </function>
 552     <function name='virDomainSnapshotListChildrenNames' file='python'>
 553       <info>collect the list of child snapshot names for the given snapshot</info>
 554       <arg name='snapshot' type='virDomainSnapshotPtr' info='pointer to the snapshot'/>
 555       <arg name='flags' type='unsigned int' info='flags'/>
 556       <return type='char *' info='the list of Names or None in case of error'/>
 557     </function>
 558     <function name='virDomainSnapshotListAllChildren' file='python'>
 559       <info>returns the list of child snapshots for the given snapshot</info>
 560       <arg name='snapshot' type='virDomainSnapshotPtr' info='pointer to the snapshot'/>
 561       <arg name='flags' type='unsigned int' info='flags'/>
 562       <return type='char *' info='the list of snapshots or None in case of error'/>
 563     </function>
 564     <function name='virDomainRevertToSnapshot' file='python'>
 565       <info>revert the domain to the given snapshot</info>
 566       <arg name='dom' type='virDomainPtr' info='dummy domain pointer'/>
 567       <arg name='snap' type='virDomainSnapshotPtr' info='pointer to the snapshot'/>
 568       <arg name='flags' type='unsigned int' info='flags'/>
 569       <return type='int' info="0 on success, -1 on error"/>
 570     </function>
 571     <function name='virDomainGetBlockJobInfo' file='python'>
 572       <info>Get progress information for a block job</info>
 573       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 574       <arg name='path' type='const char *' info='Fully-qualified filename of disk'/>
 575       <arg name='flags' type='unsigned int' info='fine-tuning flags, currently unused, pass 0.'/>
 576       <return type='char *' info='A dictionary containing job information.' />
 577     </function>
 578     <function name='virDomainMigrateGetCompressionCache' file='python'>
 579       <info>Get current size of the cache (in bytes) used for compressing
 580             repeatedly transferred memory pages during live migration.</info>
 581       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 582       <arg name='flags' type='unsigned int' info='flags, currently unused, pass 0.'/>
 583       <return type='unsigned long long' info='current cache size, or None in case of error'/>
 584     </function>
 585     <function name='virDomainMigrateGetMaxSpeed' file='python'>
 586       <info>Get currently configured maximum migration speed for a domain</info>
 587       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 588       <arg name='flags' type='unsigned int' info='flags, currently unused, pass 0.'/>
 589       <return type='unsigned long' info='current max migration speed, or None in case of error'/>
 590     </function>
 591     <function name='virDomainMigrateGetMaxDowntime' file='python'>
 592       <info>Get the current value of the maximum downtime (in milliseconds)
 593             allowed during a migration of a guest.</info>
 594       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 595       <arg name='flags' type='unsigned int' info='flags, currently unused, pass 0.'/>
 596       <return type='unsigned long long' info='current downtime or None in case of error'/>
 597     </function>
 598     <function name='virDomainMigrate3' file='python'>
 599       <info>Migrate the domain object from its current host to the destination host
 600             given by dconn (a connection to the destination host).</info>
 601       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 602       <arg name='dconn' type='virConnectPtr' info='pointer to the destination host connection'/>
 603       <arg name='params' type='char *' info='dictionary with migration parameters'/>
 604       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainMigrateFlags'/>
 605       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
 606     </function>
 607     <function name='virDomainMigrateToURI3' file='python'>
 608       <info>Migrate the domain object from its current host to the destination host
 609             given by URI.</info>
 610       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 611       <arg name='dconnuri' type='char *' info='URI for target libvirtd if @flags includes VIR_MIGRATE_PEER2PEER'/>
 612       <arg name='params' type='char *' info='dictionary with migration parameters'/>
 613       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainMigrateFlags'/>
 614       <return type='int' info='0 in case of success, -1 in case of failure.'/>
 615     </function>
 616     <function name='virDomainSetBlockIoTune' file='python'>
 617       <info>Change the I/O tunables for a block device</info>
 618       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 619       <arg name='disk' type='const char *' info='disk name'/>
 620       <arg name='params' type='virTypedParameterPtr' info='Pointer to blkio tuning params object'/>
 621       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 622       <return type='int' info='0 in case of success, -1 in case of failure'/>
 623     </function>
 624     <function name='virDomainGetBlockIoTune' file='python'>
 625       <info>Get the I/O tunables for a block device</info>
 626       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 627       <arg name='disk' type='const char *' info='disk name'/>
 628       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
 629       <return type='char *' info='the I/O tunables value or None in case of error'/>
 630     </function>
 631     <function name='virDomainBlockPeek' file='python'>
 632       <info>Read the contents of domain's disk device</info>
 633       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 634       <arg name='disk' type='const char *' info='disk name'/>
 635       <arg name='offset' type='unsigned long long' info='offset within block device'/>
 636       <arg name='size' type='size_t' info='size to read'/>
 637       <arg name='flags' type='unsigned int' info='unused, always pass 0'/>
 638       <return type='char *' info='the returned buffer or None in case of error'/>
 639     </function>
 640     <function name='virDomainMemoryPeek' file='python'>
 641       <info>Read the contents of domain's memory</info>
 642       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 643       <arg name='start' type='unsigned long long' info='start of memory to peek'/>
 644       <arg name='size' type='size_t' info='size of memory to peek'/>
 645       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainMemoryFlags'/>
 646       <return type='char *' info='the returned buffer or None in case of error'/>
 647     </function>
 648     <function name='virDomainGetDiskErrors' file='python'>
 649       <info>Extract errors on disk devices.</info>
 650       <return type='char *' info='dictionary of disks and their errors or None in case of error'/>
 651       <arg name='domain' type='virDomainPtr' info='a domain object'/>
 652       <arg name='flags' type='unsigned int' info='unused, always pass 0'/>
 653     </function>
 654     <function name='virNodeSetMemoryParameters' file='python'>
 655       <info>Change the node memory tunables</info>
 656       <return type='int' info='-1 in case of error, 0 in case of success.'/>
 657       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 658       <arg name='params' type='virTypedParameterPtr' info='pointer to the memory tunable objects'/>
 659       <arg name='flags'  type='int' info='unused, always pass 0'/>
 660     </function>
 661     <function name='virNodeGetMemoryParameters' file='python'>
 662       <info>Get the node memory parameters</info>
 663       <return type='char *' info='None in case of error, returns a dictionary of params'/>
 664       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 665       <arg name='flags' type='int' info='unused, always pass 0'/>
 666     </function>
 667     <function name='virNodeGetCPUMap' file='python'>
 668       <info>Get node CPU information</info>
 669       <return type='char *' info='(cpunum, cpumap, online) on success, None on error'/>
 670       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 671       <arg name='flags' type='int' info='unused, pass 0'/>
 672     </function>
 673     <function name="virNodeGetFreePages" file='python'>
 674       <info>Returns the number of available pages for a list of cells and page sizes</info>
 675       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 676       <arg name='pages' type='char *' info='list of desired page sizes'/>
 677       <arg name='startCell' type='int' info='first cell in the list'/>
 678       <arg name='maxCells' type='int' info='number of cell in the list'/>
 679       <arg name='flags' type='int' info='unused, pass 0'/>
 680       <return type='char *' info='the list available memory in the cells'/>
 681     </function>
 682     <function name="virNetworkGetDHCPLeases" file='python'>
 683       <info>Returns a list of dhcp leases for interfaces connected to the given virtual network</info>
 684       <arg name='network' type='virNetworkPtr' info='a network object'/>
 685       <arg name='mac' type='const char *' info='optional mac address'/>
 686       <arg name='flags' type='unsigned int' info='unused, pass 0'/>
 687       <return type='char *' info="list of leases"/>
 688     </function>
 689     <function name="virDomainBlockCopy" file="python">
 690       <info>Copy the guest-visible contents of a disk image to a new file described by destxml</info>
 691       <arg name='dom' type='virDomainPtr' info='pointer to domain object'/>
 692       <arg name='disk' type='const char *' info='path to the block device, or device shorthand'/>
 693       <arg name='destxml' type='const char *' info='XML description of the copy destination'/>
 694       <arg name='params' type='virTypedParameterPtr' info='optional pointer to block copy parameter object, or NULL'/>
 695       <arg name='flags' type='unsigned int' info='bitwise-OR of virDomainBlockCopyFlags'/>
 696       <return type='int' info='0 if the operation has started, -1 on failure'/>
 697     </function>
 698     <function name="virNodeAllocPages" file='python'>
 699       <info>Allocate or free some pages in the huge pages pool</info>
 700       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 701       <arg name='pages' type='char *' info='dictionary of desired page sizes, key is page size, value is page count'/>
 702       <arg name='startCell' type='int' info='optional first cell in the list'/>
 703       <arg name='cellCount' type='int' info='optional number of cell in the list'/>
 704       <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virNodeAllocPagesFlags'/>
 705       <return type='int' info='the number of nodes successfully adjusted or -1 in case of an error'/>
 706     </function>
 707     <function name="virDomainGetFSInfo" file='python'>
 708       <info>Get a list of mapping information for each mounted file systems within the specified guest and the disks.</info>
 709       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 710       <arg name='flags' type='unsigned int' info='unused, pass 0'/>
 711       <return type='char *' info="list of mounted filesystems information"/>
 712     </function>
 713     <function name='virDomainInterfaceAddresses' file='python'>
 714       <info>returns a dictionary of domain interfaces along with their MAC and IP addresses</info>
 715       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 716       <arg name='source' type='unsigned int' info='the data source'/>
 717       <arg name='flags' type='unsigned int' info='extra flags; not used yet, so callers should always pass 0'/>
 718       <return type='char *' info="dictionary of domain interfaces along with their MAC and IP addresses"/>
 719     </function>
 720     <function name='virDomainGetGuestVcpus' file='python'>
 721       <info>returns a dictionary containing information regarding guest vcpus</info>
 722       <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
 723       <arg name='flags' type='unsigned int' info='extra flags; not used yet, so callers should always pass 0'/>
 724       <return type='int' info="dictionary of vcpu data returned by the guest agent"/>
 725     </function>
 726     <function name='virConnectBaselineHypervisorCPU' file='python'>
 727       <info>Computes the most feature-rich CPU which is compatible with all given CPUs and can be provided by the specified hypervisor.</info>
 728       <return type='char *' info='XML description of the computed CPU or NULL on error.'/>
 729       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 730       <arg name='emulator' type='const char *' info='path to the emulator binary'/>
 731       <arg name='arch' type='const char *' info='CPU architecture'/>
 732       <arg name='machine' type='const char *' info='machine type'/>
 733       <arg name='virttype' type='const char *' info='virtualization type'/>
 734       <arg name='xmlCPUs' type='const char **' info='array of XML descriptions of CPUs'/>
 735       <arg name='flags' type='unsigned int' info='bitwise-OR of virConnectBaselineCPUFlags'/>
 736     </function>
 737     <function name='virDomainGetLaunchSecurityInfo' file='python'>
 738       <info>Get launch security info for a domain</info>
 739       <return type='char *' info='None in case of error, returns a dictionary of params'/>
 740       <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 741       <arg name='flags' type='int' info='unused, always pass 0'/>
 742     </function>
 743     <function name='virNodeGetSEVInfo' file='python'>
 744       <info>Get platform specific information from the SEV firmware</info>
 745       <return type='char *' info='None in case of error, returns a dictionary of params'/>
 746       <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
 747       <arg name='flags' type='int' info='unused, always pass 0'/>
 748     </function>
 749   </symbols>
 750 </api>