libvirt-override-api.xml 30.8 KB
Newer Older
1 2
<?xml version="1.0"?>
<api name='libvir-python'>
3
  <symbols>
T
Taizo ITO 已提交
4 5 6 7 8
    <function name="virConnectGetVersion" file='python'>
      <info>Returns the running hypervisor version of the connection host</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='int' info="0 on success, -1 on error"/>
    </function>
9 10 11 12 13
    <function name="virConnectGetLibVersion" file='python'>
      <info>Returns the libvirt version of the connection host</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='int' info="0 on success, -1 on error"/>
    </function>
14 15 16 17 18
    <function name="virConnectListDomainsID" file='python'>
      <info>Returns the list of the ID of the domains on the hypervisor</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='int *' info="the list of ID or None in case of error"/>
    </function>
19 20 21 22 23
    <function name='virConnectListDefinedDomains' file='python'>
      <info>list the defined domains, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
24 25 26 27 28 29 30 31 32 33
    <function name='virConnectListNetworks' file='python'>
      <info>list the networks, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
    <function name='virConnectListDefinedNetworks' file='python'>
      <info>list the defined networks, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
34 35 36 37 38 39
    <function name='virDomainLookupByUUID' file='python'>
      <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
      <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the UUID string for the domain, must be 16 bytes'/>
    </function>
40 41 42
    <function name='virNetworkLookupByUUID' file='python'>
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
P
Philip Hahn 已提交
43
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
44 45
      <arg name='uuid' type='const unsigned char *' info='the UUID string for the network, must be 16 bytes'/>
    </function>
46
    <function name='virDomainGetInfo' file='python'>
47 48
      <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>
      <return type='int *' info='the list of information or None in case of error'/>
49 50
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
J
Jiri Denemark 已提交
51 52 53 54 55 56
    <function name='virDomainGetState' file='python'>
      <info>Extract domain state.</info>
      <return type='int *' info='the list containing state and reason or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='additional flags'/>
    </function>
57 58 59 60 61 62
    <function name='virDomainGetControlInfo' file='python'>
      <info>Extract details about current state of control interface to a domain.</info>
      <return type='int *' info='the list of information or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='additional flags'/>
    </function>
63 64 65 66 67 68 69
    <function name='virDomainGetBlockInfo' file='python'>
      <info>Extract information about a domain block device size</info>
      <return type='int *' info='the list of information or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='path' type='const char *' info='path to the block device or file'/>
      <arg name='flags' type='unsigned int' info='currently unused'/>
    </function>
70 71 72 73 74
    <function name='virDomainGetJobInfo' file='python'>
      <info>Extract information about an active job being processed for a domain.</info>
      <return type='int *' info='the list of information or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
75
    <function name='virNodeGetInfo' file='python'>
76 77
      <info>Extract hardware information about the Node.</info>
      <return type='int *' info='the list of information or None in case of error'/>
78 79
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
80 81 82 83 84 85 86
    <function name='virNodeGetCPUStats' file='python'>
      <info>Extract node's CPU statistics.</info>
      <return type='virNodeCPUStats' info='dictionary mapping field names to values or None in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='cpuNum' type='int' info='number of node cpu. (VIR_NODE_CPU_STATS_ALL_CPUS means total cpu statistics)'/>
      <arg name='flags' type='unsigned int' info='additional flags'/>
    </function>
87 88 89 90 91 92 93
    <function name='virNodeGetMemoryStats' file='python'>
      <info>Extract node's memory statistics.</info>
      <return type='virNodeMemoryStats' info='dictionary mapping field names to values or None in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='cellNum' type='int' info='number of node cell. (VIR_NODE_MEMORY_STATS_ALL_CELLS means total cell statistics)'/>
      <arg name='flags' type='unsigned int' info='additional flags'/>
    </function>
94
    <function name='virDomainGetUUID' file='python'>
95 96 97 98
      <info>Extract the UUID unique Identifier of a domain.</info>
      <return type='char *' info='the 16 bytes string or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
99 100 101 102 103
    <function name='virDomainGetUUIDString' file='python'>
      <info>Fetch globally unique ID of the domain as a string.</info>
      <return type='char *' info='the UUID string or None in case of error'/>
      <arg name='pool' type='virDomainPtr' info='a domain object'/>
    </function>
104 105 106 107 108
    <function name='virNetworkGetUUID' file='python'>
      <info>Extract the UUID unique Identifier of a network.</info>
      <return type='char *' info='the 16 bytes string or None in case of error'/>
      <arg name='domain' type='virNetworkPtr' info='a network object'/>
    </function>
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
    <function name='virNetworkGetUUIDString' file='python'>
      <info>Fetch globally unique ID of the network as a string.</info>
      <return type='char *' info='the UUID string or None in case of error'/>
      <arg name='net' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virStoragePoolGetUUID' file='python'>
      <info>Extract the UUID unique Identifier of a storage pool.</info>
      <return type='char *' info='the 16 bytes string or None in case of error'/>
      <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
    </function>
    <function name='virStoragePoolGetUUIDString' file='python'>
      <info>Fetch globally unique ID of the storage pool as a string.</info>
      <return type='char *' info='the UUID string or None in case of error'/>
      <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
    </function>
124 125 126 127 128 129 130 131 132 133
    <function name='virNetworkGetAutostart' file='python'>
      <info>Extract the autostart flag for a network.</info>
      <return type='int' info='the autostart flag, or None in case of error'/>
      <arg name='domain' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virDomainGetAutostart' file='python'>
      <info>Extract the autostart flag for a domain</info>
      <return type='int' info='the autostart flag, or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a network object'/>
    </function>
134 135 136 137 138
    <function name='virStoragePoolGetAutostart' file='python'>
      <info>Extract the autostart flag for a storage pool</info>
      <return type='int' info='the autostart flag, or None in case of error'/>
      <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
    </function>
139 140 141 142 143 144
    <function name='virDomainBlockStats' file='python'>
      <info>Extracts block device statistics for a domain</info>
      <return type='virDomainBlockStats' info='a tuple of statistics'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='path' type='char *' info='the path for the block device'/>
    </function>
145 146
    <function name='virDomainBlockStatsFlags' file='python'>
      <info>Extracts block device statistics parameters of a running domain</info>
147
      <return type='str *' info='None in case of error, returns a dictionary of params'/>
148 149 150 151
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='path' type='char *' info='the path for the block device'/>
      <arg name='flags' type='int' info='flags (unused; pass 0)'/>
    </function>
152 153 154 155 156 157 158 159 160 161 162 163 164
    <function name='virDomainGetCPUStats' file='python'>
      <info>Extracts CPU statistics for a running domain. On success it will
   return a list of data of dictionary type. If boolean total is False, the
   first element of the list refers to CPU0 on the host, second element is
   CPU1, and so on. The format of data struct is as follows:
   [{cpu_time:xxx}, {cpu_time:xxx}, ...]
   If it is True, it returns total domain CPU statistics in the format of
   [{cpu_time:xxx, user_time:xxx, system_time:xxx}]</info>
     <return type='str *' info='returns a list of dictionary in case of success, None in case of error'/>
     <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
     <arg name='total' type='bool' info='on true, return total domain CPU statistics, false return per-cpu info'/>
     <arg name='flags' type='int' info='flags (unused; pass 0)'/>
    </function>
165 166 167 168 169 170
    <function name='virDomainInterfaceStats' file='python'>
      <info>Extracts interface device statistics for a domain</info>
      <return type='virDomainInterfaceStats' info='a tuple of statistics'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='path' type='char *' info='the path for the interface device'/>
    </function>
171 172 173 174 175
    <function name='virDomainMemoryStats' file='python'>
      <info>Extracts memory statistics for a domain</info>
      <return type='virDomainMemoryStats' info='a dictionary of statistics'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
176
    <function name="virNodeGetCellsFreeMemory" file='python'>
177
      <info>Returns the available memory for a list of cells</info>
178 179 180 181 182
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='startCell' type='int' info='first cell in the list'/>
      <arg name='maxCells' type='int' info='number of cell in the list'/>
      <return type='int *' info="the list available memory in the cells"/>
    </function>
183 184
    <function name='virDomainGetSchedulerParameters' file='python'>
      <info>Get the scheduler parameters, the @params array will be filled with the values.</info>
185
      <return type='str *' info='None in case of error, returns a dictionary of params.'/>
186 187
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
188 189
    <function name='virDomainGetSchedulerParametersFlags' file='python'>
      <info>Get the scheduler parameters</info>
190
     <return type='str *' info='None in case of error, returns a dictionary of params'/>
191 192 193
     <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
     <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
    </function>
194 195 196 197 198 199 200 201 202 203 204
    <function name='virDomainGetSchedulerType' file='python'>
      <info>Get the scheduler type.</info>
      <return type='char *' info='NULL in case of error. The caller must free the returned string.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
    <function name='virDomainGetVcpus' file='python'>
      <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>
      <return type='int' info='the number of info filled in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
    </function>
    <function name='virDomainPinVcpu' file='python'>
205
      <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
206 207 208 209 210
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
      <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
      <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.'/>
    </function>
211 212 213 214 215 216 217 218
    <function name='virDomainPinVcpuFlags' file='python'>
      <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
      <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
      <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.'/>
      <arg name='flags' type='int' info='flags to specify'/>
    </function>
219 220 221 222 223 224
    <function name='virDomainGetVcpuPinInfo' file='python'>
      <info>Query the CPU affinity setting of all virtual CPUs of domain</info>
      <return type='unsigned char *' info='the array of cpumap'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
      <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
    </function>
225 226 227 228 229 230
    <function name='virDomainSetSchedulerParameters' file='python'>
      <info>Change the scheduler parameters</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
    </function>
231 232 233 234 235 236 237
    <function name='virDomainSetSchedulerParametersFlags' file='python'>
      <info>Change the scheduler parameters</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
      <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
    </function>
238 239 240 241 242
    <function name='virDomainSetBlkioParameters' file='python'>
      <info>Change the blkio tunables</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virBlkioParameterPtr' info='pointer to blkio tunable objects'/>
243
      <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
244 245
    </function>
    <function name='virDomainGetBlkioParameters' file='python'>
246
      <info>Get the blkio parameters</info>
247
      <return type='str *' info='None in case of error, returns a dictionary of params'/>
248
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
249
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
250
    </function>
251 252 253 254 255
    <function name='virDomainSetMemoryParameters' file='python'>
      <info>Change the memory tunables</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virMemoryParameterPtr' info='pointer to memory tunable objects'/>
256
      <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
257 258
    </function>
    <function name='virDomainGetMemoryParameters' file='python'>
259
      <info>Get the memory parameters</info>
260
      <return type='str *' info='None in case of error, returns a dictionary of params'/>
261
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
262
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
263
    </function>
264 265 266 267 268 269 270 271 272 273 274 275 276
    <function name='virDomainSetNumaParameters' file='python'>
      <info>Change the NUMA tunables</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virTypedParameterPtr' info='pointer to numa tunable objects'/>
      <arg name='flags'  type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
    </function>
    <function name='virDomainGetNumaParameters' file='python'>
      <info>Get the NUMA parameters</info>
      <return type='str *' info='returns a dictionary of params in case of success, None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainModificationImpact'/>
    </function>
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
    <function name='virDomainSetInterfaceParameters' file='python'>
      <info>Change the bandwidth tunables for a interface device</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='device' type='const char *' info='interface name'/>
      <arg name='params' type='virTypedParameterPtr' info='Pointer to bandwidth tuning params object'/>
      <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
      <return type='int' info='0 in case of success, -1 in case of failure'/>
    </function>
    <function name='virDomainGetInterfaceParameters' file='python'>
      <info>Get the bandwidth tunables for a interface device</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='device' type='const char *' info='interface name'/>
      <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
      <return type='str *' info='the bandwidth tunables value or None in case of error'/>
    </function>

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
    <function name='virConnectListStoragePools' file='python'>
      <info>list the storage pools, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
    <function name='virConnectListDefinedStoragePools' file='python'>
      <info>list the defined storage pool, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
    <function name='virStoragePoolListVolumes' file='python'>
      <info>list the storage volumes, stores the pointers to the names in @names</info>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to the storage pool'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
    <function name='virStoragePoolGetInfo' file='python'>
      <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>
      <return type='int *' info='the list of information or None in case of error'/>
      <arg name='pool' type='virStoragePoolPtr' info='a storage pool object'/>
    </function>
    <function name='virStorageVolGetInfo' file='python'>
314
      <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>
315 316 317
      <return type='int *' info='the list of information or None in case of error'/>
      <arg name='vol' type='virStorageVolPtr' info='a storage vol object'/>
    </function>
318 319 320 321 322 323 324 325 326 327 328 329
    <function name='virNodeListDevices' file='python'>
      <info>list the node devices</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='cap' type='const unsigned char *' info='capability name'/>
      <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
      <return type='str *' info='the list of Names or None in case of error'/>
    </function>
    <function name='virNodeDeviceListCaps' file='python'>
      <info>list the node device's capabilities</info>
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
      <return type='str *' info='the list of Names or None in case of error'/>
    </function>
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
    <function name='virSecretGetValue' file='libvirt' module='libvirt'>
      <info>Fetches the value associated with a secret.</info>
      <return type='char *' info='the secret value or None in case of error'/>
      <arg name='secret' type='virSecretPtr' info='virSecret secret'/>
      <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
    </function>
    <function name='virConnectListSecrets' file='libvirt' module='libvirt'>
      <info>List the defined secret IDs</info>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <return type='str *' info='the list of secret IDs or None in case of error'/>
    </function>
    <function name='virSecretSetValue' file='libvirt' module='libvirt'>
      <info>Associates a value with a secret.</info>
      <return type='int' info='0 on success, -1 on failure.'/>
      <arg name='secret' type='virSecretPtr' info='virSecret secret'/>
      <arg name='value' type='const char *' info='The secret value'/>
      <arg name='flags' type='unsigned int' info='flags (unused; pass 0)'/>
    </function>
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
    <function name='virSecretLookupByUUID' file='python'>
      <info>Try to lookup a secret on the given hypervisor based on its UUID.</info>
      <return type='virSecretPtr' info='a new secret object or NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the UUID string for the secret, must be 16 bytes'/>
    </function>
    <function name='virSecretGetUUID' file='python'>
      <info>Extract the UUID unique Identifier of a secret.</info>
      <return type='char *' info='the 16 bytes string or None in case of error'/>
      <arg name='secret' type='virSecretPtr' info='a secret object'/>
    </function>
    <function name='virSecretGetUUIDString' file='python'>
      <info>Fetch globally unique ID of the secret as a string.</info>
      <return type='char *' info='the UUID string or None in case of error'/>
      <arg name='secret' type='virSecretPtr' info='a secret object'/>
    </function>
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
    <function name='virConnectListNWFilters' file='libvirt' module='libvirt'>
      <info>List the defined network filters</info>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <return type='str *' info='the list of network filter IDs or None in case of error'/>
    </function>
    <function name='virNWFilterLookupByUUID' file='python'>
      <info>Try to lookup a network filter on the given hypervisor based on its UUID.</info>
      <return type='virNWFilterPtr' info='a new network filter object or NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the UUID string for the secret, must be 16 bytes'/>
    </function>
    <function name='virNWFilterGetUUID' file='python'>
      <info>Extract the UUID unique Identifier of a network filter.</info>
      <return type='char *' info='the 16 bytes string or None in case of error'/>
      <arg name='nwfilter' type='virNWFilterPtr' info='a network filter object'/>
    </function>
    <function name='virNWFilterGetUUIDString' file='python'>
      <info>Fetch globally unique ID of the network filter as a string.</info>
      <return type='char *' info='the UUID string or None in case of error'/>
      <arg name='nwfilter' type='virNWFilterPtr' info='a network filter object'/>
    </function>
385 386 387 388 389 390 391 392 393 394
    <function name='virConnectListInterfaces' file='python'>
      <info>list the running interfaces, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
    <function name='virConnectListDefinedInterfaces' file='python'>
      <info>list the defined interfaces, stores the pointers to the names in @names</info>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <return type='str *' info='the list of Names of None in case of error'/>
    </function>
J
Jiri Denemark 已提交
395 396 397 398 399 400 401
    <function name='virConnectBaselineCPU' file='python'>
      <info>Computes the most feature-rich CPU which is compatible with all given host CPUs.</info>
      <return type='char *' info='XML description of the computed CPU or NULL on error.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <arg name='xmlCPUs' type='const char **' info='array of XML descriptions of host CPUs'/>
      <arg name='flags' type='unsigned int' info='fine-tuning flags, currently unused, pass 0.'/>
    </function>
402 403 404
    <function name='virDomainSnapshotListNames' file='python'>
      <info>collect the list of snapshots for the given domain</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
405 406 407 408 409 410 411 412
      <arg name='flags' type='unsigned int' info='flags'/>
      <return type='str *' info='the list of Names or None in case of error'/>
    </function>
    <function name='virDomainSnapshotListChildrenNames' file='python'>
      <info>collect the list of child snapshots for the given snapshot</info>
      <arg name='snapshot' type='virDomainSnapshotPtr' info='pointer to the snapshot'/>
      <arg name='flags' type='unsigned int' info='flags'/>
      <return type='str *' info='the list of Names or None in case of error'/>
413
    </function>
414 415 416 417
    <function name='virDomainRevertToSnapshot' file='python'>
      <info>revert the domain to the given snapshot</info>
      <arg name='dom' type='virDomainPtr' info='dummy domain pointer'/>
      <arg name='snap' type='virDomainSnapshotPtr' info='pointer to the snapshot'/>
418
      <arg name='flags' type='unsigned int' info='flags'/>
419 420
      <return type='int' info="0 on success, -1 on error"/>
    </function>
421 422 423 424 425 426 427
    <function name='virDomainGetBlockJobInfo' file='python'>
      <info>Get progress information for a block job</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='path' type='const char *' info='Fully-qualified filename of disk'/>
      <arg name='flags' type='unsigned int' info='fine-tuning flags, currently unused, pass 0.'/>
      <return type='virDomainBlockJobInfo' info='A dictionary containing job information.' />
    </function>
428 429 430 431 432 433
    <function name='virDomainMigrateGetMaxSpeed' file='python'>
      <info>Get currently configured maximum migration speed for a domain</info>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='flags, currently unused, pass 0.'/>
      <return type='unsigned long' info='current max migration speed, or None in case of error'/>
    </function>
434 435 436 437 438 439 440 441 442 443 444 445 446
    <function name='virDomainSetBlockIoTune' file='python'>
      <info>Change the I/O tunables for a block device</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='disk' type='const char *' info='disk name'/>
      <arg name='params' type='virTypedParameterPtr' info='Pointer to blkio tuning params object'/>
      <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
      <return type='int' info='0 in case of success, -1 in case of failure'/>
    </function>
    <function name='virDomainGetBlockIoTune' file='python'>
      <info>Get the I/O tunables for a block device</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='disk' type='const char *' info='disk name'/>
      <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainModificationImpact'/>
447
      <return type='str *' info='the I/O tunables value or None in case of error'/>
448
    </function>
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
    <function name='virDomainBlockPeek' file='python'>
      <info>Read the contents of domain's disk device</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='disk' type='const char *' info='disk name'/>
      <arg name='offset' type='unsigned long long' info='offset within block device'/>
      <arg name='size' type='size_t' info='size to read'/>
      <arg name='flags' type='unsigned int' info='unused, always pass 0'/>
      <return type='char *' info='the returned buffer or None in case of error'/>
    </function>
    <function name='virDomainMemoryPeek' file='python'>
      <info>Read the contents of domain's memory</info>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
      <arg name='start' type='unsigned long long' info='start of memory to peek'/>
      <arg name='size' type='size_t' info='size of memory to peek'/>
      <arg name='flags' type='unsigned int' info='an OR&apos;ed set of virDomainMemoryFlags'/>
      <return type='char *' info='the returned buffer or None in case of error'/>
    </function>
466 467 468 469 470 471
    <function name='virDomainGetDiskErrors' file='python'>
      <info>Extract errors on disk devices.</info>
      <return type='virDomainDiskErrorPtr' info='dictionary of disks and their errors or None in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='unused, always pass 0'/>
    </function>
472
  </symbols>
473
</api>