mirror of https://gitee.com/openkylin/libvirt.git
553 lines
36 KiB
XML
553 lines
36 KiB
XML
<?xml version="1.0"?>
|
|
<api name='libvir-python'>
|
|
<symbols>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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 or None in case of error'/>
|
|
</function>
|
|
<function name='virConnectListAllDomains' file='python'>
|
|
<info>returns list of all defined domains</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='domain *' info='the list of domains or None in case of error'/>
|
|
</function>
|
|
<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 or 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 or None in case of error'/>
|
|
</function>
|
|
<function name='virConnectListAllNetworks' file='python'>
|
|
<info>returns list of all networks</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='network *' info='the list of networks or None in case of error'/>
|
|
</function>
|
|
<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>
|
|
<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'/>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='uuid' type='const unsigned char *' info='the UUID string for the network, must be 16 bytes'/>
|
|
</function>
|
|
<function name='virDomainGetInfo' file='python'>
|
|
<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'/>
|
|
<arg name='domain' type='virDomainPtr' info='a domain object'/>
|
|
</function>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<function name='virNodeGetInfo' file='python'>
|
|
<info>Extract hardware information about the Node.</info>
|
|
<return type='int *' info='the list of information or None in case of error'/>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
</function>
|
|
<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>
|
|
<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>
|
|
<function name='virDomainGetUUID' file='python'>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<function name='virDomainBlockStatsFlags' file='python'>
|
|
<info>Extracts block device statistics parameters of a running domain</info>
|
|
<return type='str *' info='None in case of error, returns a dictionary of params'/>
|
|
<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>
|
|
<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 or 0, 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 or 1, 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>
|
|
<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>
|
|
<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>
|
|
<function name="virNodeGetCellsFreeMemory" file='python'>
|
|
<info>Returns the available memory for a list of cells</info>
|
|
<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>
|
|
<function name='virDomainGetSchedulerParameters' file='python'>
|
|
<info>Get the scheduler parameters, the @params array will be filled with the values.</info>
|
|
<return type='str *' info='None in case of error, returns a dictionary of params.'/>
|
|
<arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
|
|
</function>
|
|
<function name='virDomainGetSchedulerParametersFlags' file='python'>
|
|
<info>Get the scheduler parameters</info>
|
|
<return type='str *' info='None in case of error, returns a dictionary of params'/>
|
|
<arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
|
|
<arg name='flags' type='int' info='an OR'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<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'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'>
|
|
<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.'/>
|
|
</function>
|
|
<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>
|
|
<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'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<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>
|
|
<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'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<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'/>
|
|
<arg name='flags' type='int' info='an OR'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<function name='virDomainGetBlkioParameters' file='python'>
|
|
<info>Get the blkio parameters</info>
|
|
<return type='str *' info='None in case of error, returns a dictionary of params'/>
|
|
<arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
|
|
<arg name='flags' type='int' info='an OR'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<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'/>
|
|
<arg name='flags' type='int' info='an OR'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<function name='virDomainGetMemoryParameters' file='python'>
|
|
<info>Get the memory parameters</info>
|
|
<return type='str *' info='None in case of error, returns a dictionary of params'/>
|
|
<arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
|
|
<arg name='flags' type='int' info='an OR'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<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'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'ed set of virDomainModificationImpact'/>
|
|
</function>
|
|
<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'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'ed set of virDomainModificationImpact'/>
|
|
<return type='str *' info='the bandwidth tunables value or None in case of error'/>
|
|
</function>
|
|
|
|
<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='virConnectListAllStoragePools' file='python'>
|
|
<info>returns list of all storage pools</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='pool *' info='the list of pools or 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 or None in case of error'/>
|
|
</function>
|
|
<function name='virStoragePoolListAllVolumes' file='python'>
|
|
<info>return list of storage volume objects</info>
|
|
<arg name='pool' type='virStoragePoolPtr' info='pointer to the storage pool'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='volume *' info='the list of volumes or 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'>
|
|
<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>
|
|
<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>
|
|
<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='virConnectListAllNodeDevices' file='python'>
|
|
<info>returns list of all host node devices</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='device *' info='the list of host node device 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>
|
|
<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='virConnectListAllSecrets' file='python'>
|
|
<info>returns list of all interfaces</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='secret *' info='the list of secrets 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>
|
|
<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>
|
|
<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='virConnectListAllNWFilters' file='python'>
|
|
<info>returns list of all network fitlers</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='nwfilter *' info='the list of network filters 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>
|
|
<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>
|
|
<function name='virConnectListAllInterfaces' file='python'>
|
|
<info>returns list of all interfaces</info>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='unsigned int' info='optional flags'/>
|
|
<return type='interface *' info='the list of interfaces or None in case of error'/>
|
|
</function>
|
|
<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>
|
|
<function name='virDomainSnapshotListNames' file='python'>
|
|
<info>collect the list of snapshot names for the given domain</info>
|
|
<arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
|
|
<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='virDomainListAllSnapshots' file='python'>
|
|
<info>returns the list of snapshots for the given domain</info>
|
|
<arg name='dom' type='virDomainPtr' info='pointer to the domain'/>
|
|
<arg name='flags' type='unsigned int' info='flags'/>
|
|
<return type='snapshot *' info='the list of snapshots or None in case of error'/>
|
|
</function>
|
|
<function name='virDomainSnapshotListChildrenNames' file='python'>
|
|
<info>collect the list of child snapshot names 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'/>
|
|
</function>
|
|
<function name='virDomainSnapshotListAllChildren' file='python'>
|
|
<info>returns 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='snapshot *' info='the list of snapshots or None in case of error'/>
|
|
</function>
|
|
<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'/>
|
|
<arg name='flags' type='unsigned int' info='flags'/>
|
|
<return type='int' info="0 on success, -1 on error"/>
|
|
</function>
|
|
<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>
|
|
<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>
|
|
<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'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'ed set of virDomainModificationImpact'/>
|
|
<return type='str *' info='the I/O tunables value or None in case of error'/>
|
|
</function>
|
|
<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'ed set of virDomainMemoryFlags'/>
|
|
<return type='char *' info='the returned buffer or None in case of error'/>
|
|
</function>
|
|
<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>
|
|
<function name='virNodeSetMemoryParameters' file='python'>
|
|
<info>Change the node memory tunables</info>
|
|
<return type='int' info='-1 in case of error, 0 in case of success.'/>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='params' type='virTypedParameterPtr' info='pointer to the memory tunable objects'/>
|
|
<arg name='flags' type='int' info='unused, always pass 0'/>
|
|
</function>
|
|
<function name='virNodeGetMemoryParameters' file='python'>
|
|
<info>Get the node memory parameters</info>
|
|
<return type='str *' info='None in case of error, returns a dictionary of params'/>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='int' info='unused, always pass 0'/>
|
|
</function>
|
|
<function name='virNodeGetCPUMap' file='python'>
|
|
<info>Get node CPU information</info>
|
|
<return type='str *' info='(cpunum, cpumap, online) on success, None on error'/>
|
|
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
|
<arg name='flags' type='int' info='unused, pass 0'/>
|
|
</function>
|
|
</symbols>
|
|
</api>
|