Module libvirt from libvirt

Provides the interfaces of the libvirt library to handle virtualized domains Copyright (C) 2005-2006, 2010-2014 Red Hat, Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library. If not, see http://www.gnu.org/licenses/.

Table of Contents

Macros

#define LIBVIR_CHECK_VERSION
#define LIBVIR_VERSION_NUMBER
#define VIR_COPY_CPUMAP
#define VIR_CPU_MAPLEN
#define VIR_CPU_USABLE
#define VIR_CPU_USED
#define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE
#define VIR_DOMAIN_BANDWIDTH_IN_BURST
#define VIR_DOMAIN_BANDWIDTH_IN_PEAK
#define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE
#define VIR_DOMAIN_BANDWIDTH_OUT_BURST
#define VIR_DOMAIN_BANDWIDTH_OUT_PEAK
#define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS
#define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS
#define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT
#define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS
#define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS
#define VIR_DOMAIN_BLKIO_FIELD_LENGTH
#define VIR_DOMAIN_BLKIO_WEIGHT
#define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH
#define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE
#define VIR_DOMAIN_BLOCK_COPY_GRANULARITY
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC
#define VIR_DOMAIN_BLOCK_STATS_ERRS
#define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH
#define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ
#define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES
#define VIR_DOMAIN_BLOCK_STATS_READ_BYTES
#define VIR_DOMAIN_BLOCK_STATS_READ_REQ
#define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES
#define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES
#define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ
#define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES
#define VIR_DOMAIN_CPU_STATS_CPUTIME
#define VIR_DOMAIN_CPU_STATS_SYSTEMTIME
#define VIR_DOMAIN_CPU_STATS_USERTIME
#define VIR_DOMAIN_CPU_STATS_VCPUTIME
#define VIR_DOMAIN_EVENT_CALLBACK
#define VIR_DOMAIN_JOB_COMPRESSION_BYTES
#define VIR_DOMAIN_JOB_COMPRESSION_CACHE
#define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES
#define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW
#define VIR_DOMAIN_JOB_COMPRESSION_PAGES
#define VIR_DOMAIN_JOB_DATA_PROCESSED
#define VIR_DOMAIN_JOB_DATA_REMAINING
#define VIR_DOMAIN_JOB_DATA_TOTAL
#define VIR_DOMAIN_JOB_DISK_BPS
#define VIR_DOMAIN_JOB_DISK_PROCESSED
#define VIR_DOMAIN_JOB_DISK_REMAINING
#define VIR_DOMAIN_JOB_DISK_TOTAL
#define VIR_DOMAIN_JOB_DOWNTIME
#define VIR_DOMAIN_JOB_MEMORY_BPS
#define VIR_DOMAIN_JOB_MEMORY_CONSTANT
#define VIR_DOMAIN_JOB_MEMORY_NORMAL
#define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES
#define VIR_DOMAIN_JOB_MEMORY_PROCESSED
#define VIR_DOMAIN_JOB_MEMORY_REMAINING
#define VIR_DOMAIN_JOB_MEMORY_TOTAL
#define VIR_DOMAIN_JOB_SETUP_TIME
#define VIR_DOMAIN_JOB_TIME_ELAPSED
#define VIR_DOMAIN_JOB_TIME_REMAINING
#define VIR_DOMAIN_MEMORY_FIELD_LENGTH
#define VIR_DOMAIN_MEMORY_HARD_LIMIT
#define VIR_DOMAIN_MEMORY_MIN_GUARANTEE
#define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED
#define VIR_DOMAIN_MEMORY_SOFT_LIMIT
#define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT
#define VIR_DOMAIN_NUMA_MODE
#define VIR_DOMAIN_NUMA_NODESET
#define VIR_DOMAIN_SCHEDULER_CAP
#define VIR_DOMAIN_SCHEDULER_CPU_SHARES
#define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD
#define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA
#define VIR_DOMAIN_SCHEDULER_LIMIT
#define VIR_DOMAIN_SCHEDULER_RESERVATION
#define VIR_DOMAIN_SCHEDULER_SHARES
#define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD
#define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA
#define VIR_DOMAIN_SCHEDULER_WEIGHT
#define VIR_DOMAIN_SCHED_FIELD_LENGTH
#define VIR_DOMAIN_SEND_KEY_MAX_KEYS
#define VIR_DOMAIN_TUNABLE_BLKDEV_DISK
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES
#define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN
#define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD
#define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA
#define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN
#define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD
#define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA
#define VIR_GET_CPUMAP
#define VIR_MIGRATE_PARAM_BANDWIDTH
#define VIR_MIGRATE_PARAM_DEST_NAME
#define VIR_MIGRATE_PARAM_DEST_XML
#define VIR_MIGRATE_PARAM_GRAPHICS_URI
#define VIR_MIGRATE_PARAM_LISTEN_ADDRESS
#define VIR_MIGRATE_PARAM_URI
#define VIR_NETWORK_EVENT_CALLBACK
#define VIR_NODEINFO_MAXCPUS
#define VIR_NODE_CPU_STATS_FIELD_LENGTH
#define VIR_NODE_CPU_STATS_IDLE
#define VIR_NODE_CPU_STATS_INTR
#define VIR_NODE_CPU_STATS_IOWAIT
#define VIR_NODE_CPU_STATS_KERNEL
#define VIR_NODE_CPU_STATS_USER
#define VIR_NODE_CPU_STATS_UTILIZATION
#define VIR_NODE_MEMORY_STATS_BUFFERS
#define VIR_NODE_MEMORY_STATS_CACHED
#define VIR_NODE_MEMORY_STATS_FIELD_LENGTH
#define VIR_NODE_MEMORY_STATS_FREE
#define VIR_NODE_MEMORY_STATS_TOTAL
#define VIR_SECURITY_DOI_BUFLEN
#define VIR_SECURITY_LABEL_BUFLEN
#define VIR_SECURITY_MODEL_BUFLEN
#define VIR_TYPED_PARAM_FIELD_LENGTH
#define VIR_UNUSE_CPU
#define VIR_USE_CPU
#define VIR_UUID_BUFLEN
#define VIR_UUID_STRING_BUFLEN
#define _virBlkioParameter
#define _virMemoryParameter
#define _virSchedParameter

Types

typedef struct _virTypedParameter virBlkioParameter
typedef virBlkioParameter * virBlkioParameterPtr
typedef enum virBlkioParameterType
typedef enum virCPUCompareResult
typedef struct _virConnect virConnect
typedef struct _virConnectAuth virConnectAuth
typedef virConnectAuth * virConnectAuthPtr
typedef enum virConnectBaselineCPUFlags
typedef enum virConnectCloseReason
typedef enum virConnectCompareCPUFlags
typedef struct _virConnectCredential virConnectCredential
typedef virConnectCredential * virConnectCredentialPtr
typedef enum virConnectCredentialType
typedef enum virConnectDomainEventBlockJobStatus
typedef enum virConnectDomainEventDiskChangeReason
typedef enum virConnectFlags
typedef enum virConnectGetAllDomainStatsFlags
typedef enum virConnectListAllDomainsFlags
typedef enum virConnectListAllInterfacesFlags
typedef enum virConnectListAllNetworksFlags
typedef enum virConnectListAllNodeDeviceFlags
typedef enum virConnectListAllSecretsFlags
typedef enum virConnectListAllStoragePoolsFlags
typedef virConnect * virConnectPtr
typedef struct _virDomain virDomain
typedef enum virDomainBlockCommitFlags
typedef enum virDomainBlockCopyFlags
typedef struct _virDomainBlockInfo virDomainBlockInfo
typedef virDomainBlockInfo * virDomainBlockInfoPtr
typedef enum virDomainBlockJobAbortFlags
typedef unsigned long long virDomainBlockJobCursor
typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo
typedef enum virDomainBlockJobInfoFlags
typedef virDomainBlockJobInfo * virDomainBlockJobInfoPtr
typedef enum virDomainBlockJobSetSpeedFlags
typedef enum virDomainBlockJobType
typedef enum virDomainBlockPullFlags
typedef enum virDomainBlockRebaseFlags
typedef enum virDomainBlockResizeFlags
typedef virDomainBlockStatsStruct * virDomainBlockStatsPtr
typedef struct _virDomainBlockStats virDomainBlockStatsStruct
typedef enum virDomainBlockedReason
typedef enum virDomainChannelFlags
typedef enum virDomainConsoleFlags
typedef struct _virDomainControlInfo virDomainControlInfo
typedef virDomainControlInfo * virDomainControlInfoPtr
typedef enum virDomainControlState
typedef enum virDomainCoreDumpFlags
typedef enum virDomainCoreDumpFormat
typedef enum virDomainCrashedReason
typedef enum virDomainCreateFlags
typedef enum virDomainDestroyFlagsValues
typedef enum virDomainDeviceModifyFlags
typedef struct _virDomainDiskError virDomainDiskError
typedef enum virDomainDiskErrorCode
typedef virDomainDiskError * virDomainDiskErrorPtr
typedef enum virDomainEventCrashedDetailType
typedef enum virDomainEventDefinedDetailType
typedef struct _virDomainEventGraphicsAddress virDomainEventGraphicsAddress
typedef virDomainEventGraphicsAddress * virDomainEventGraphicsAddressPtr
typedef enum virDomainEventGraphicsAddressType
typedef enum virDomainEventGraphicsPhase
typedef struct _virDomainEventGraphicsSubject virDomainEventGraphicsSubject
typedef struct _virDomainEventGraphicsSubjectIdentity virDomainEventGraphicsSubjectIdentity
typedef virDomainEventGraphicsSubjectIdentity * virDomainEventGraphicsSubjectIdentityPtr
typedef virDomainEventGraphicsSubject * virDomainEventGraphicsSubjectPtr
typedef enum virDomainEventID
typedef enum virDomainEventIOErrorAction
typedef enum virDomainEventPMSuspendedDetailType
typedef enum virDomainEventResumedDetailType
typedef enum virDomainEventShutdownDetailType
typedef enum virDomainEventStartedDetailType
typedef enum virDomainEventStoppedDetailType
typedef enum virDomainEventSuspendedDetailType
typedef enum virDomainEventTrayChangeReason
typedef enum virDomainEventType
typedef enum virDomainEventUndefinedDetailType
typedef enum virDomainEventWatchdogAction
typedef enum virDomainGetJobStatsFlags
typedef struct _virDomainInfo virDomainInfo
typedef virDomainInfo * virDomainInfoPtr
typedef virDomainInterfaceStatsStruct * virDomainInterfaceStatsPtr
typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct
typedef struct _virDomainJobInfo virDomainJobInfo
typedef virDomainJobInfo * virDomainJobInfoPtr
typedef enum virDomainJobType
typedef enum virDomainMemoryFlags
typedef enum virDomainMemoryModFlags
typedef virDomainMemoryStatStruct * virDomainMemoryStatPtr
typedef struct _virDomainMemoryStat virDomainMemoryStatStruct
typedef enum virDomainMemoryStatTags
typedef enum virDomainMetadataType
typedef enum virDomainMigrateFlags
typedef enum virDomainModificationImpact
typedef enum virDomainNostateReason
typedef enum virDomainNumatuneMemMode
typedef enum virDomainOpenGraphicsFlags
typedef enum virDomainPMSuspendedDiskReason
typedef enum virDomainPMSuspendedReason
typedef enum virDomainPausedReason
typedef enum virDomainProcessSignal
typedef virDomain * virDomainPtr
typedef enum virDomainRebootFlagValues
typedef enum virDomainRunningReason
typedef enum virDomainSaveRestoreFlags
typedef enum virDomainSetTimeFlags
typedef enum virDomainShutdownFlagValues
typedef enum virDomainShutdownReason
typedef enum virDomainShutoffReason
typedef struct _virDomainSnapshot virDomainSnapshot
typedef enum virDomainSnapshotCreateFlags
typedef enum virDomainSnapshotDeleteFlags
typedef enum virDomainSnapshotListFlags
typedef virDomainSnapshot * virDomainSnapshotPtr
typedef enum virDomainSnapshotRevertFlags
typedef enum virDomainState
typedef struct _virDomainStatsRecord virDomainStatsRecord
typedef virDomainStatsRecord * virDomainStatsRecordPtr
typedef enum virDomainStatsTypes
typedef enum virDomainUndefineFlagsValues
typedef enum virDomainVcpuFlags
typedef enum virDomainXMLFlags
typedef enum virEventHandleType
typedef enum virIPAddrType
typedef struct _virInterface virInterface
typedef virInterface * virInterfacePtr
typedef enum virInterfaceXMLFlags
typedef enum virKeycodeSet
typedef struct _virTypedParameter virMemoryParameter
typedef virMemoryParameter * virMemoryParameterPtr
typedef enum virMemoryParameterType
typedef struct _virNWFilter virNWFilter
typedef virNWFilter * virNWFilterPtr
typedef struct _virNetwork virNetwork
typedef struct _virNetworkDHCPLease virNetworkDHCPLease
typedef virNetworkDHCPLease * virNetworkDHCPLeasePtr
typedef enum virNetworkEventID
typedef enum virNetworkEventLifecycleType
typedef virNetwork * virNetworkPtr
typedef enum virNetworkUpdateCommand
typedef enum virNetworkUpdateFlags
typedef enum virNetworkUpdateSection
typedef enum virNetworkXMLFlags
typedef enum virNodeAllocPagesFlags
typedef struct _virNodeCPUStats virNodeCPUStats
typedef virNodeCPUStats * virNodeCPUStatsPtr
typedef struct _virNodeDevice virNodeDevice
typedef virNodeDevice * virNodeDevicePtr
typedef enum virNodeGetCPUStatsAllCPUs
typedef enum virNodeGetMemoryStatsAllCells
typedef struct _virNodeInfo virNodeInfo
typedef virNodeInfo * virNodeInfoPtr
typedef struct _virNodeMemoryStats virNodeMemoryStats
typedef virNodeMemoryStats * virNodeMemoryStatsPtr
typedef enum virNodeSuspendTarget
typedef struct _virTypedParameter virSchedParameter
typedef virSchedParameter * virSchedParameterPtr
typedef enum virSchedParameterType
typedef struct _virSecret virSecret
typedef virSecret * virSecretPtr
typedef enum virSecretUsageType
typedef struct _virSecurityLabel virSecurityLabel
typedef virSecurityLabel * virSecurityLabelPtr
typedef struct _virSecurityModel virSecurityModel
typedef virSecurityModel * virSecurityModelPtr
typedef struct _virStoragePool virStoragePool
typedef enum virStoragePoolBuildFlags
typedef enum virStoragePoolDeleteFlags
typedef struct _virStoragePoolInfo virStoragePoolInfo
typedef virStoragePoolInfo * virStoragePoolInfoPtr
typedef virStoragePool * virStoragePoolPtr
typedef enum virStoragePoolState
typedef struct _virStorageVol virStorageVol
typedef enum virStorageVolCreateFlags
typedef enum virStorageVolDeleteFlags
typedef struct _virStorageVolInfo virStorageVolInfo
typedef virStorageVolInfo * virStorageVolInfoPtr
typedef virStorageVol * virStorageVolPtr
typedef enum virStorageVolResizeFlags
typedef enum virStorageVolType
typedef enum virStorageVolWipeAlgorithm
typedef enum virStorageXMLFlags
typedef struct _virStream virStream
typedef enum virStreamEventType
typedef enum virStreamFlags
typedef virStream * virStreamPtr
typedef struct _virTypedParameter virTypedParameter
typedef enum virTypedParameterFlags
typedef virTypedParameter * virTypedParameterPtr
typedef enum virTypedParameterType
typedef struct _virVcpuInfo virVcpuInfo
typedef virVcpuInfo * virVcpuInfoPtr
typedef enum virVcpuState

Functions

typedef virConnectAuthCallbackPtr
int	virConnectAuthCallbackPtr	(virConnectCredentialPtr cred, 
unsigned int ncred,
void * cbdata) char * virConnectBaselineCPU (virConnectPtr conn,
const char ** xmlCPUs,
unsigned int ncpus,
unsigned int flags) int virConnectClose (virConnectPtr conn) typedef virConnectCloseFunc void virConnectCloseFunc (virConnectPtr conn,
int reason,
void * opaque) int virConnectCompareCPU (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) typedef virConnectDomainEventBalloonChangeCallback void virConnectDomainEventBalloonChangeCallback (virConnectPtr conn,
virDomainPtr dom,
unsigned long long actual,
void * opaque) typedef virConnectDomainEventBlockJobCallback void virConnectDomainEventBlockJobCallback (virConnectPtr conn,
virDomainPtr dom,
const char * disk,
int type,
int status,
void * opaque) typedef virConnectDomainEventCallback int virConnectDomainEventCallback (virConnectPtr conn,
virDomainPtr dom,
int event,
int detail,
void * opaque) int virConnectDomainEventDeregister (virConnectPtr conn,
virConnectDomainEventCallback cb) int virConnectDomainEventDeregisterAny (virConnectPtr conn,
int callbackID) typedef virConnectDomainEventDeviceRemovedCallback void virConnectDomainEventDeviceRemovedCallback (virConnectPtr conn,
virDomainPtr dom,
const char * devAlias,
void * opaque) typedef virConnectDomainEventDiskChangeCallback void virConnectDomainEventDiskChangeCallback (virConnectPtr conn,
virDomainPtr dom,
const char * oldSrcPath,
const char * newSrcPath,
const char * devAlias,
int reason,
void * opaque) typedef virConnectDomainEventGenericCallback void virConnectDomainEventGenericCallback (virConnectPtr conn,
virDomainPtr dom,
void * opaque) typedef virConnectDomainEventGraphicsCallback void virConnectDomainEventGraphicsCallback (virConnectPtr conn,
virDomainPtr dom,
int phase,
const virDomainEventGraphicsAddress * local,
const virDomainEventGraphicsAddress * remote,
const char * authScheme,
const virDomainEventGraphicsSubject * subject,
void * opaque) typedef virConnectDomainEventIOErrorCallback void virConnectDomainEventIOErrorCallback (virConnectPtr conn,
virDomainPtr dom,
const char * srcPath,
const char * devAlias,
int action,
void * opaque) typedef virConnectDomainEventIOErrorReasonCallback void virConnectDomainEventIOErrorReasonCallback (virConnectPtr conn,
virDomainPtr dom,
const char * srcPath,
const char * devAlias,
int action,
const char * reason,
void * opaque) typedef virConnectDomainEventPMSuspendCallback void virConnectDomainEventPMSuspendCallback (virConnectPtr conn,
virDomainPtr dom,
int reason,
void * opaque) typedef virConnectDomainEventPMSuspendDiskCallback void virConnectDomainEventPMSuspendDiskCallback (virConnectPtr conn,
virDomainPtr dom,
int reason,
void * opaque) typedef virConnectDomainEventPMWakeupCallback void virConnectDomainEventPMWakeupCallback (virConnectPtr conn,
virDomainPtr dom,
int reason,
void * opaque) typedef virConnectDomainEventRTCChangeCallback void virConnectDomainEventRTCChangeCallback (virConnectPtr conn,
virDomainPtr dom,
long long utcoffset,
void * opaque) int virConnectDomainEventRegister (virConnectPtr conn,
virConnectDomainEventCallback cb,
void * opaque,
virFreeCallback freecb) int virConnectDomainEventRegisterAny (virConnectPtr conn,
virDomainPtr dom,
int eventID,
virConnectDomainEventGenericCallback cb,
void * opaque,
virFreeCallback freecb) typedef virConnectDomainEventTrayChangeCallback void virConnectDomainEventTrayChangeCallback (virConnectPtr conn,
virDomainPtr dom,
const char * devAlias,
int reason,
void * opaque) typedef virConnectDomainEventTunableCallback void virConnectDomainEventTunableCallback (virConnectPtr conn,
virDomainPtr dom,
virTypedParameterPtr params,
int nparams,
void * opaque) typedef virConnectDomainEventWatchdogCallback void virConnectDomainEventWatchdogCallback (virConnectPtr conn,
virDomainPtr dom,
int action,
void * opaque) char * virConnectDomainXMLFromNative (virConnectPtr conn,
const char * nativeFormat,
const char * nativeConfig,
unsigned int flags) char * virConnectDomainXMLToNative (virConnectPtr conn,
const char * nativeFormat,
const char * domainXml,
unsigned int flags) char * virConnectFindStoragePoolSources (virConnectPtr conn,
const char * type,
const char * srcSpec,
unsigned int flags) int virConnectGetAllDomainStats (virConnectPtr conn,
unsigned int stats,
virDomainStatsRecordPtr ** retStats,
unsigned int flags) int virConnectGetCPUModelNames (virConnectPtr conn,
const char * arch,
char ** * models,
unsigned int flags) char * virConnectGetCapabilities (virConnectPtr conn) char * virConnectGetDomainCapabilities (virConnectPtr conn,
const char * emulatorbin,
const char * arch,
const char * machine,
const char * virttype,
unsigned int flags) char * virConnectGetHostname (virConnectPtr conn) int virConnectGetLibVersion (virConnectPtr conn,
unsigned long * libVer) int virConnectGetMaxVcpus (virConnectPtr conn,
const char * type) char * virConnectGetSysinfo (virConnectPtr conn,
unsigned int flags) const char * virConnectGetType (virConnectPtr conn) char * virConnectGetURI (virConnectPtr conn) int virConnectGetVersion (virConnectPtr conn,
unsigned long * hvVer) int virConnectIsAlive (virConnectPtr conn) int virConnectIsEncrypted (virConnectPtr conn) int virConnectIsSecure (virConnectPtr conn) int virConnectListAllDomains (virConnectPtr conn,
virDomainPtr ** domains,
unsigned int flags) int virConnectListAllInterfaces (virConnectPtr conn,
virInterfacePtr ** ifaces,
unsigned int flags) int virConnectListAllNWFilters (virConnectPtr conn,
virNWFilterPtr ** filters,
unsigned int flags) int virConnectListAllNetworks (virConnectPtr conn,
virNetworkPtr ** nets,
unsigned int flags) int virConnectListAllNodeDevices (virConnectPtr conn,
virNodeDevicePtr ** devices,
unsigned int flags) int virConnectListAllSecrets (virConnectPtr conn,
virSecretPtr ** secrets,
unsigned int flags) int virConnectListAllStoragePools (virConnectPtr conn,
virStoragePoolPtr ** pools,
unsigned int flags) int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListDefinedInterfaces (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListDefinedNetworks (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListDefinedStoragePools (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListDomains (virConnectPtr conn,
int * ids,
int maxids) int virConnectListInterfaces (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListNWFilters (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListNetworks (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListSecrets (virConnectPtr conn,
char ** uuids,
int maxuuids) int virConnectListStoragePools (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectNetworkEventDeregisterAny (virConnectPtr conn,
int callbackID) typedef virConnectNetworkEventGenericCallback void virConnectNetworkEventGenericCallback (virConnectPtr conn,
virNetworkPtr net,
void * opaque) typedef virConnectNetworkEventLifecycleCallback void virConnectNetworkEventLifecycleCallback (virConnectPtr conn,
virNetworkPtr net,
int event,
int detail,
void * opaque) int virConnectNetworkEventRegisterAny (virConnectPtr conn,
virNetworkPtr net,
int eventID,
virConnectNetworkEventGenericCallback cb,
void * opaque,
virFreeCallback freecb) int virConnectNumOfDefinedDomains (virConnectPtr conn) int virConnectNumOfDefinedInterfaces (virConnectPtr conn) int virConnectNumOfDefinedNetworks (virConnectPtr conn) int virConnectNumOfDefinedStoragePools (virConnectPtr conn) int virConnectNumOfDomains (virConnectPtr conn) int virConnectNumOfInterfaces (virConnectPtr conn) int virConnectNumOfNWFilters (virConnectPtr conn) int virConnectNumOfNetworks (virConnectPtr conn) int virConnectNumOfSecrets (virConnectPtr conn) int virConnectNumOfStoragePools (virConnectPtr conn) virConnectPtr virConnectOpen (const char * name) virConnectPtr virConnectOpenAuth (const char * name,
virConnectAuthPtr auth,
unsigned int flags) virConnectPtr virConnectOpenReadOnly (const char * name) int virConnectRef (virConnectPtr conn) int virConnectRegisterCloseCallback (virConnectPtr conn,
virConnectCloseFunc cb,
void * opaque,
virFreeCallback freecb) int virConnectSetKeepAlive (virConnectPtr conn,
int interval,
unsigned int count) int virConnectUnregisterCloseCallback (virConnectPtr conn,
virConnectCloseFunc cb) int virDomainAbortJob (virDomainPtr domain) int virDomainAttachDevice (virDomainPtr domain,
const char * xml) int virDomainAttachDeviceFlags (virDomainPtr domain,
const char * xml,
unsigned int flags) int virDomainBlockCommit (virDomainPtr dom,
const char * disk,
const char * base,
const char * top,
unsigned long bandwidth,
unsigned int flags) int virDomainBlockCopy (virDomainPtr dom,
const char * disk,
const char * destxml,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainBlockJobAbort (virDomainPtr dom,
const char * disk,
unsigned int flags) int virDomainBlockJobSetSpeed (virDomainPtr dom,
const char * disk,
unsigned long bandwidth,
unsigned int flags) int virDomainBlockPeek (virDomainPtr dom,
const char * disk,
unsigned long long offset,
size_t size,
void * buffer,
unsigned int flags) int virDomainBlockPull (virDomainPtr dom,
const char * disk,
unsigned long bandwidth,
unsigned int flags) int virDomainBlockRebase (virDomainPtr dom,
const char * disk,
const char * base,
unsigned long bandwidth,
unsigned int flags) int virDomainBlockResize (virDomainPtr dom,
const char * disk,
unsigned long long size,
unsigned int flags) int virDomainBlockStats (virDomainPtr dom,
const char * disk,
virDomainBlockStatsPtr stats,
size_t size) int virDomainBlockStatsFlags (virDomainPtr dom,
const char * disk,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) int virDomainCoreDump (virDomainPtr domain,
const char * to,
unsigned int flags) int virDomainCoreDumpWithFormat (virDomainPtr domain,
const char * to,
unsigned int dumpformat,
unsigned int flags) int virDomainCreate (virDomainPtr domain) virDomainPtr virDomainCreateLinux (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) int virDomainCreateWithFiles (virDomainPtr domain,
unsigned int nfiles,
int * files,
unsigned int flags) int virDomainCreateWithFlags (virDomainPtr domain,
unsigned int flags) virDomainPtr virDomainCreateXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) virDomainPtr virDomainCreateXMLWithFiles (virConnectPtr conn,
const char * xmlDesc,
unsigned int nfiles,
int * files,
unsigned int flags) virDomainPtr virDomainDefineXML (virConnectPtr conn,
const char * xml) int virDomainDestroy (virDomainPtr domain) int virDomainDestroyFlags (virDomainPtr domain,
unsigned int flags) int virDomainDetachDevice (virDomainPtr domain,
const char * xml) int virDomainDetachDeviceFlags (virDomainPtr domain,
const char * xml,
unsigned int flags) int virDomainFSFreeze (virDomainPtr dom,
const char ** mountpoints,
unsigned int nmountpoints,
unsigned int flags) int virDomainFSThaw (virDomainPtr dom,
const char ** mountpoints,
unsigned int nmountpoints,
unsigned int flags) int virDomainFSTrim (virDomainPtr dom,
const char * mountPoint,
unsigned long long minimum,
unsigned int flags) int virDomainFree (virDomainPtr domain) int virDomainGetAutostart (virDomainPtr domain,
int * autostart) int virDomainGetBlkioParameters (virDomainPtr domain,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) int virDomainGetBlockInfo (virDomainPtr domain,
const char * disk,
virDomainBlockInfoPtr info,
unsigned int flags) int virDomainGetBlockIoTune (virDomainPtr dom,
const char * disk,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) int virDomainGetBlockJobInfo (virDomainPtr dom,
const char * disk,
virDomainBlockJobInfoPtr info,
unsigned int flags) int virDomainGetCPUStats (virDomainPtr domain,
virTypedParameterPtr params,
unsigned int nparams,
int start_cpu,
unsigned int ncpus,
unsigned int flags) virConnectPtr virDomainGetConnect (virDomainPtr dom) int virDomainGetControlInfo (virDomainPtr domain,
virDomainControlInfoPtr info,
unsigned int flags) int virDomainGetDiskErrors (virDomainPtr dom,
virDomainDiskErrorPtr errors,
unsigned int maxerrors,
unsigned int flags) int virDomainGetEmulatorPinInfo (virDomainPtr domain,
unsigned char * cpumap,
int maplen,
unsigned int flags) char * virDomainGetHostname (virDomainPtr domain,
unsigned int flags) unsigned int virDomainGetID (virDomainPtr domain) int virDomainGetInfo (virDomainPtr domain,
virDomainInfoPtr info) int virDomainGetInterfaceParameters (virDomainPtr domain,
const char * device,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) int virDomainGetJobInfo (virDomainPtr domain,
virDomainJobInfoPtr info) int virDomainGetJobStats (virDomainPtr domain,
int * type,
virTypedParameterPtr * params,
int * nparams,
unsigned int flags) unsigned long virDomainGetMaxMemory (virDomainPtr domain) int virDomainGetMaxVcpus (virDomainPtr domain) int virDomainGetMemoryParameters (virDomainPtr domain,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) char * virDomainGetMetadata (virDomainPtr domain,
int type,
const char * uri,
unsigned int flags) const char * virDomainGetName (virDomainPtr domain) int virDomainGetNumaParameters (virDomainPtr domain,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) char * virDomainGetOSType (virDomainPtr domain) int virDomainGetSchedulerParameters (virDomainPtr domain,
virTypedParameterPtr params,
int * nparams) int virDomainGetSchedulerParametersFlags (virDomainPtr domain,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) char * virDomainGetSchedulerType (virDomainPtr domain,
int * nparams) int virDomainGetSecurityLabel (virDomainPtr domain,
virSecurityLabelPtr seclabel) int virDomainGetSecurityLabelList (virDomainPtr domain,
virSecurityLabelPtr * seclabels) int virDomainGetState (virDomainPtr domain,
int * state,
int * reason,
unsigned int flags) int virDomainGetTime (virDomainPtr dom,
long long * seconds,
unsigned int * nseconds,
unsigned int flags) int virDomainGetUUID (virDomainPtr domain,
unsigned char * uuid) int virDomainGetUUIDString (virDomainPtr domain,
char * buf) int virDomainGetVcpuPinInfo (virDomainPtr domain,
int ncpumaps,
unsigned char * cpumaps,
int maplen,
unsigned int flags) int virDomainGetVcpus (virDomainPtr domain,
virVcpuInfoPtr info,
int maxinfo,
unsigned char * cpumaps,
int maplen) int virDomainGetVcpusFlags (virDomainPtr domain,
unsigned int flags) char * virDomainGetXMLDesc (virDomainPtr domain,
unsigned int flags) int virDomainHasCurrentSnapshot (virDomainPtr domain,
unsigned int flags) int virDomainHasManagedSaveImage (virDomainPtr dom,
unsigned int flags) int virDomainInjectNMI (virDomainPtr domain,
unsigned int flags) int virDomainInterfaceStats (virDomainPtr dom,
const char * path,
virDomainInterfaceStatsPtr stats,
size_t size) int virDomainIsActive (virDomainPtr dom) int virDomainIsPersistent (virDomainPtr dom) int virDomainIsUpdated (virDomainPtr dom) int virDomainListAllSnapshots (virDomainPtr domain,
virDomainSnapshotPtr ** snaps,
unsigned int flags) int virDomainListGetStats (virDomainPtr * doms,
unsigned int stats,
virDomainStatsRecordPtr ** retStats,
unsigned int flags) virDomainPtr virDomainLookupByID (virConnectPtr conn,
int id) virDomainPtr virDomainLookupByName (virConnectPtr conn,
const char * name) virDomainPtr virDomainLookupByUUID (virConnectPtr conn,
const unsigned char * uuid) virDomainPtr virDomainLookupByUUIDString (virConnectPtr conn,
const char * uuidstr) int virDomainManagedSave (virDomainPtr dom,
unsigned int flags) int virDomainManagedSaveRemove (virDomainPtr dom,
unsigned int flags) int virDomainMemoryPeek (virDomainPtr dom,
unsigned long long start,
size_t size,
void * buffer,
unsigned int flags) int virDomainMemoryStats (virDomainPtr dom,
virDomainMemoryStatPtr stats,
unsigned int nr_stats,
unsigned int flags) virDomainPtr virDomainMigrate (virDomainPtr domain,
virConnectPtr dconn,
unsigned long flags,
const char * dname,
const char * uri,
unsigned long bandwidth) virDomainPtr virDomainMigrate2 (virDomainPtr domain,
virConnectPtr dconn,
const char * dxml,
unsigned long flags,
const char * dname,
const char * uri,
unsigned long bandwidth) virDomainPtr virDomainMigrate3 (virDomainPtr domain,
virConnectPtr dconn,
virTypedParameterPtr params,
unsigned int nparams,
unsigned int flags) int virDomainMigrateGetCompressionCache (virDomainPtr domain,
unsigned long long * cacheSize,
unsigned int flags) int virDomainMigrateGetMaxSpeed (virDomainPtr domain,
unsigned long * bandwidth,
unsigned int flags) int virDomainMigrateSetCompressionCache (virDomainPtr domain,
unsigned long long cacheSize,
unsigned int flags) int virDomainMigrateSetMaxDowntime (virDomainPtr domain,
unsigned long long downtime,
unsigned int flags) int virDomainMigrateSetMaxSpeed (virDomainPtr domain,
unsigned long bandwidth,
unsigned int flags) int virDomainMigrateToURI (virDomainPtr domain,
const char * duri,
unsigned long flags,
const char * dname,
unsigned long bandwidth) int virDomainMigrateToURI2 (virDomainPtr domain,
const char * dconnuri,
const char * miguri,
const char * dxml,
unsigned long flags,
const char * dname,
unsigned long bandwidth) int virDomainMigrateToURI3 (virDomainPtr domain,
const char * dconnuri,
virTypedParameterPtr params,
unsigned int nparams,
unsigned int flags) int virDomainOpenChannel (virDomainPtr dom,
const char * name,
virStreamPtr st,
unsigned int flags) int virDomainOpenConsole (virDomainPtr dom,
const char * dev_name,
virStreamPtr st,
unsigned int flags) int virDomainOpenGraphics (virDomainPtr dom,
unsigned int idx,
int fd,
unsigned int flags) int virDomainOpenGraphicsFD (virDomainPtr dom,
unsigned int idx,
unsigned int flags) int virDomainPMSuspendForDuration (virDomainPtr dom,
unsigned int target,
unsigned long long duration,
unsigned int flags) int virDomainPMWakeup (virDomainPtr dom,
unsigned int flags) int virDomainPinEmulator (virDomainPtr domain,
unsigned char * cpumap,
int maplen,
unsigned int flags) int virDomainPinVcpu (virDomainPtr domain,
unsigned int vcpu,
unsigned char * cpumap,
int maplen) int virDomainPinVcpuFlags (virDomainPtr domain,
unsigned int vcpu,
unsigned char * cpumap,
int maplen,
unsigned int flags) int virDomainReboot (virDomainPtr domain,
unsigned int flags) int virDomainRef (virDomainPtr domain) int virDomainReset (virDomainPtr domain,
unsigned int flags) int virDomainRestore (virConnectPtr conn,
const char * from) int virDomainRestoreFlags (virConnectPtr conn,
const char * from,
const char * dxml,
unsigned int flags) int virDomainResume (virDomainPtr domain) int virDomainRevertToSnapshot (virDomainSnapshotPtr snapshot,
unsigned int flags) int virDomainSave (virDomainPtr domain,
const char * to) int virDomainSaveFlags (virDomainPtr domain,
const char * to,
const char * dxml,
unsigned int flags) int virDomainSaveImageDefineXML (virConnectPtr conn,
const char * file,
const char * dxml,
unsigned int flags) char * virDomainSaveImageGetXMLDesc (virConnectPtr conn,
const char * file,
unsigned int flags) char * virDomainScreenshot (virDomainPtr domain,
virStreamPtr stream,
unsigned int screen,
unsigned int flags) int virDomainSendKey (virDomainPtr domain,
unsigned int codeset,
unsigned int holdtime,
unsigned int * keycodes,
int nkeycodes,
unsigned int flags) int virDomainSendProcessSignal (virDomainPtr domain,
long long pid_value,
unsigned int signum,
unsigned int flags) int virDomainSetAutostart (virDomainPtr domain,
int autostart) int virDomainSetBlkioParameters (virDomainPtr domain,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainSetBlockIoTune (virDomainPtr dom,
const char * disk,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainSetInterfaceParameters (virDomainPtr domain,
const char * device,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainSetMaxMemory (virDomainPtr domain,
unsigned long memory) int virDomainSetMemory (virDomainPtr domain,
unsigned long memory) int virDomainSetMemoryFlags (virDomainPtr domain,
unsigned long memory,
unsigned int flags) int virDomainSetMemoryParameters (virDomainPtr domain,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainSetMemoryStatsPeriod (virDomainPtr domain,
int period,
unsigned int flags) int virDomainSetMetadata (virDomainPtr domain,
int type,
const char * metadata,
const char * key,
const char * uri,
unsigned int flags) int virDomainSetNumaParameters (virDomainPtr domain,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainSetSchedulerParameters (virDomainPtr domain,
virTypedParameterPtr params,
int nparams) int virDomainSetSchedulerParametersFlags (virDomainPtr domain,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virDomainSetTime (virDomainPtr dom,
long long seconds,
unsigned int nseconds,
unsigned int flags) int virDomainSetVcpus (virDomainPtr domain,
unsigned int nvcpus) int virDomainSetVcpusFlags (virDomainPtr domain,
unsigned int nvcpus,
unsigned int flags) int virDomainShutdown (virDomainPtr domain) int virDomainShutdownFlags (virDomainPtr domain,
unsigned int flags) virDomainSnapshotPtr virDomainSnapshotCreateXML (virDomainPtr domain,
const char * xmlDesc,
unsigned int flags) virDomainSnapshotPtr virDomainSnapshotCurrent (virDomainPtr domain,
unsigned int flags) int virDomainSnapshotDelete (virDomainSnapshotPtr snapshot,
unsigned int flags) int virDomainSnapshotFree (virDomainSnapshotPtr snapshot) virConnectPtr virDomainSnapshotGetConnect (virDomainSnapshotPtr snapshot) virDomainPtr virDomainSnapshotGetDomain (virDomainSnapshotPtr snapshot) const char * virDomainSnapshotGetName (virDomainSnapshotPtr snapshot) virDomainSnapshotPtr virDomainSnapshotGetParent (virDomainSnapshotPtr snapshot,
unsigned int flags) char * virDomainSnapshotGetXMLDesc (virDomainSnapshotPtr snapshot,
unsigned int flags) int virDomainSnapshotHasMetadata (virDomainSnapshotPtr snapshot,
unsigned int flags) int virDomainSnapshotIsCurrent (virDomainSnapshotPtr snapshot,
unsigned int flags) int virDomainSnapshotListAllChildren (virDomainSnapshotPtr snapshot,
virDomainSnapshotPtr ** snaps,
unsigned int flags) int virDomainSnapshotListChildrenNames (virDomainSnapshotPtr snapshot,
char ** names,
int nameslen,
unsigned int flags) int virDomainSnapshotListNames (virDomainPtr domain,
char ** names,
int nameslen,
unsigned int flags) virDomainSnapshotPtr virDomainSnapshotLookupByName (virDomainPtr domain,
const char * name,
unsigned int flags) int virDomainSnapshotNum (virDomainPtr domain,
unsigned int flags) int virDomainSnapshotNumChildren (virDomainSnapshotPtr snapshot,
unsigned int flags) int virDomainSnapshotRef (virDomainSnapshotPtr snapshot) void virDomainStatsRecordListFree (virDomainStatsRecordPtr * stats) int virDomainSuspend (virDomainPtr domain) int virDomainUndefine (virDomainPtr domain) int virDomainUndefineFlags (virDomainPtr domain,
unsigned int flags) int virDomainUpdateDeviceFlags (virDomainPtr domain,
const char * xml,
unsigned int flags) int virEventAddHandle (int fd,
int events,
virEventHandleCallback cb,
void * opaque,
virFreeCallback ff) typedef virEventAddHandleFunc int virEventAddHandleFunc (int fd,
int event,
virEventHandleCallback cb,
void * opaque,
virFreeCallback ff) int virEventAddTimeout (int timeout,
virEventTimeoutCallback cb,
void * opaque,
virFreeCallback ff) typedef virEventAddTimeoutFunc int virEventAddTimeoutFunc (int timeout,
virEventTimeoutCallback cb,
void * opaque,
virFreeCallback ff) typedef virEventHandleCallback void virEventHandleCallback (int watch,
int fd,
int events,
void * opaque) int virEventRegisterDefaultImpl (void) void virEventRegisterImpl (virEventAddHandleFunc addHandle,
virEventUpdateHandleFunc updateHandle,
virEventRemoveHandleFunc removeHandle,
virEventAddTimeoutFunc addTimeout,
virEventUpdateTimeoutFunc updateTimeout,
virEventRemoveTimeoutFunc removeTimeout) int virEventRemoveHandle (int watch) typedef virEventRemoveHandleFunc int virEventRemoveHandleFunc (int watch) int virEventRemoveTimeout (int timer) typedef virEventRemoveTimeoutFunc int virEventRemoveTimeoutFunc (int timer) int virEventRunDefaultImpl (void) typedef virEventTimeoutCallback void virEventTimeoutCallback (int timer,
void * opaque) void virEventUpdateHandle (int watch,
int events) typedef virEventUpdateHandleFunc void virEventUpdateHandleFunc (int watch,
int event) void virEventUpdateTimeout (int timer,
int timeout) typedef virEventUpdateTimeoutFunc void virEventUpdateTimeoutFunc (int timer,
int timeout) typedef virFreeCallback void virFreeCallback (void * opaque) int virGetVersion (unsigned long * libVer,
const char * type,
unsigned long * typeVer) int virInitialize (void) int virInterfaceChangeBegin (virConnectPtr conn,
unsigned int flags) int virInterfaceChangeCommit (virConnectPtr conn,
unsigned int flags) int virInterfaceChangeRollback (virConnectPtr conn,
unsigned int flags) int virInterfaceCreate (virInterfacePtr iface,
unsigned int flags) virInterfacePtr virInterfaceDefineXML (virConnectPtr conn,
const char * xml,
unsigned int flags) int virInterfaceDestroy (virInterfacePtr iface,
unsigned int flags) int virInterfaceFree (virInterfacePtr iface) virConnectPtr virInterfaceGetConnect (virInterfacePtr iface) const char * virInterfaceGetMACString (virInterfacePtr iface) const char * virInterfaceGetName (virInterfacePtr iface) char * virInterfaceGetXMLDesc (virInterfacePtr iface,
unsigned int flags) int virInterfaceIsActive (virInterfacePtr iface) virInterfacePtr virInterfaceLookupByMACString (virConnectPtr conn,
const char * macstr) virInterfacePtr virInterfaceLookupByName (virConnectPtr conn,
const char * name) int virInterfaceRef (virInterfacePtr iface) int virInterfaceUndefine (virInterfacePtr iface) virNWFilterPtr virNWFilterDefineXML (virConnectPtr conn,
const char * xmlDesc) int virNWFilterFree (virNWFilterPtr nwfilter) const char * virNWFilterGetName (virNWFilterPtr nwfilter) int virNWFilterGetUUID (virNWFilterPtr nwfilter,
unsigned char * uuid) int virNWFilterGetUUIDString (virNWFilterPtr nwfilter,
char * buf) char * virNWFilterGetXMLDesc (virNWFilterPtr nwfilter,
unsigned int flags) virNWFilterPtr virNWFilterLookupByName (virConnectPtr conn,
const char * name) virNWFilterPtr virNWFilterLookupByUUID (virConnectPtr conn,
const unsigned char * uuid) virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn,
const char * uuidstr) int virNWFilterRef (virNWFilterPtr nwfilter) int virNWFilterUndefine (virNWFilterPtr nwfilter) int virNetworkCreate (virNetworkPtr network) virNetworkPtr virNetworkCreateXML (virConnectPtr conn,
const char * xmlDesc) void virNetworkDHCPLeaseFree (virNetworkDHCPLeasePtr lease) virNetworkPtr virNetworkDefineXML (virConnectPtr conn,
const char * xml) int virNetworkDestroy (virNetworkPtr network) int virNetworkFree (virNetworkPtr network) int virNetworkGetAutostart (virNetworkPtr network,
int * autostart) char * virNetworkGetBridgeName (virNetworkPtr network) virConnectPtr virNetworkGetConnect (virNetworkPtr net) int virNetworkGetDHCPLeases (virNetworkPtr network,
const char * mac,
virNetworkDHCPLeasePtr ** leases,
unsigned int flags) const char * virNetworkGetName (virNetworkPtr network) int virNetworkGetUUID (virNetworkPtr network,
unsigned char * uuid) int virNetworkGetUUIDString (virNetworkPtr network,
char * buf) char * virNetworkGetXMLDesc (virNetworkPtr network,
unsigned int flags) int virNetworkIsActive (virNetworkPtr net) int virNetworkIsPersistent (virNetworkPtr net) virNetworkPtr virNetworkLookupByName (virConnectPtr conn,
const char * name) virNetworkPtr virNetworkLookupByUUID (virConnectPtr conn,
const unsigned char * uuid) virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn,
const char * uuidstr) int virNetworkRef (virNetworkPtr network) int virNetworkSetAutostart (virNetworkPtr network,
int autostart) int virNetworkUndefine (virNetworkPtr network) int virNetworkUpdate (virNetworkPtr network,
unsigned int command,
unsigned int section,
int parentIndex,
const char * xml,
unsigned int flags) int virNodeAllocPages (virConnectPtr conn,
unsigned int npages,
unsigned int * pageSizes,
unsigned long long * pageCounts,
int startCell,
unsigned int cellCount,
unsigned int flags) virNodeDevicePtr virNodeDeviceCreateXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) int virNodeDeviceDestroy (virNodeDevicePtr dev) int virNodeDeviceDetachFlags (virNodeDevicePtr dev,
const char * driverName,
unsigned int flags) int virNodeDeviceDettach (virNodeDevicePtr dev) int virNodeDeviceFree (virNodeDevicePtr dev) const char * virNodeDeviceGetName (virNodeDevicePtr dev) const char * virNodeDeviceGetParent (virNodeDevicePtr dev) char * virNodeDeviceGetXMLDesc (virNodeDevicePtr dev,
unsigned int flags) int virNodeDeviceListCaps (virNodeDevicePtr dev,
char ** const names,
int maxnames) virNodeDevicePtr virNodeDeviceLookupByName (virConnectPtr conn,
const char * name) virNodeDevicePtr virNodeDeviceLookupSCSIHostByWWN (virConnectPtr conn,
const char * wwnn,
const char * wwpn,
unsigned int flags) int virNodeDeviceNumOfCaps (virNodeDevicePtr dev) int virNodeDeviceReAttach (virNodeDevicePtr dev) int virNodeDeviceRef (virNodeDevicePtr dev) int virNodeDeviceReset (virNodeDevicePtr dev) int virNodeGetCPUMap (virConnectPtr conn,
unsigned char ** cpumap,
unsigned int * online,
unsigned int flags) int virNodeGetCPUStats (virConnectPtr conn,
int cpuNum,
virNodeCPUStatsPtr params,
int * nparams,
unsigned int flags) int virNodeGetCellsFreeMemory (virConnectPtr conn,
unsigned long long * freeMems,
int startCell,
int maxCells) unsigned long long virNodeGetFreeMemory (virConnectPtr conn) int virNodeGetFreePages (virConnectPtr conn,
unsigned int npages,
unsigned int * pages,
int startCell,
unsigned int cellCount,
unsigned long long * counts,
unsigned int flags) int virNodeGetInfo (virConnectPtr conn,
virNodeInfoPtr info) int virNodeGetMemoryParameters (virConnectPtr conn,
virTypedParameterPtr params,
int * nparams,
unsigned int flags) int virNodeGetMemoryStats (virConnectPtr conn,
int cellNum,
virNodeMemoryStatsPtr params,
int * nparams,
unsigned int flags) int virNodeGetSecurityModel (virConnectPtr conn,
virSecurityModelPtr secmodel) int virNodeListDevices (virConnectPtr conn,
const char * cap,
char ** const names,
int maxnames,
unsigned int flags) int virNodeNumOfDevices (virConnectPtr conn,
const char * cap,
unsigned int flags) int virNodeSetMemoryParameters (virConnectPtr conn,
virTypedParameterPtr params,
int nparams,
unsigned int flags) int virNodeSuspendForDuration (virConnectPtr conn,
unsigned int target,
unsigned long long duration,
unsigned int flags) virSecretPtr virSecretDefineXML (virConnectPtr conn,
const char * xml,
unsigned int flags) int virSecretFree (virSecretPtr secret) virConnectPtr virSecretGetConnect (virSecretPtr secret) int virSecretGetUUID (virSecretPtr secret,
unsigned char * uuid) int virSecretGetUUIDString (virSecretPtr secret,
char * buf) const char * virSecretGetUsageID (virSecretPtr secret) int virSecretGetUsageType (virSecretPtr secret) unsigned char * virSecretGetValue (virSecretPtr secret,
size_t * value_size,
unsigned int flags) char * virSecretGetXMLDesc (virSecretPtr secret,
unsigned int flags) virSecretPtr virSecretLookupByUUID (virConnectPtr conn,
const unsigned char * uuid) virSecretPtr virSecretLookupByUUIDString (virConnectPtr conn,
const char * uuidstr) virSecretPtr virSecretLookupByUsage (virConnectPtr conn,
int usageType,
const char * usageID) int virSecretRef (virSecretPtr secret) int virSecretSetValue (virSecretPtr secret,
const unsigned char * value,
size_t value_size,
unsigned int flags) int virSecretUndefine (virSecretPtr secret) int virStoragePoolBuild (virStoragePoolPtr pool,
unsigned int flags) int virStoragePoolCreate (virStoragePoolPtr pool,
unsigned int flags) virStoragePoolPtr virStoragePoolCreateXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) virStoragePoolPtr virStoragePoolDefineXML (virConnectPtr conn,
const char * xml,
unsigned int flags) int virStoragePoolDelete (virStoragePoolPtr pool,
unsigned int flags) int virStoragePoolDestroy (virStoragePoolPtr pool) int virStoragePoolFree (virStoragePoolPtr pool) int virStoragePoolGetAutostart (virStoragePoolPtr pool,
int * autostart) virConnectPtr virStoragePoolGetConnect (virStoragePoolPtr pool) int virStoragePoolGetInfo (virStoragePoolPtr pool,
virStoragePoolInfoPtr info) const char * virStoragePoolGetName (virStoragePoolPtr pool) int virStoragePoolGetUUID (virStoragePoolPtr pool,
unsigned char * uuid) int virStoragePoolGetUUIDString (virStoragePoolPtr pool,
char * buf) char * virStoragePoolGetXMLDesc (virStoragePoolPtr pool,
unsigned int flags) int virStoragePoolIsActive (virStoragePoolPtr pool) int virStoragePoolIsPersistent (virStoragePoolPtr pool) int virStoragePoolListAllVolumes (virStoragePoolPtr pool,
virStorageVolPtr ** vols,
unsigned int flags) int virStoragePoolListVolumes (virStoragePoolPtr pool,
char ** const names,
int maxnames) virStoragePoolPtr virStoragePoolLookupByName (virConnectPtr conn,
const char * name) virStoragePoolPtr virStoragePoolLookupByUUID (virConnectPtr conn,
const unsigned char * uuid) virStoragePoolPtr virStoragePoolLookupByUUIDString (virConnectPtr conn,
const char * uuidstr) virStoragePoolPtr virStoragePoolLookupByVolume (virStorageVolPtr vol) int virStoragePoolNumOfVolumes (virStoragePoolPtr pool) int virStoragePoolRef (virStoragePoolPtr pool) int virStoragePoolRefresh (virStoragePoolPtr pool,
unsigned int flags) int virStoragePoolSetAutostart (virStoragePoolPtr pool,
int autostart) int virStoragePoolUndefine (virStoragePoolPtr pool) virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr pool,
const char * xmlDesc,
unsigned int flags) virStorageVolPtr virStorageVolCreateXMLFrom (virStoragePoolPtr pool,
const char * xmlDesc,
virStorageVolPtr clonevol,
unsigned int flags) int virStorageVolDelete (virStorageVolPtr vol,
unsigned int flags) int virStorageVolDownload (virStorageVolPtr vol,
virStreamPtr stream,
unsigned long long offset,
unsigned long long length,
unsigned int flags) int virStorageVolFree (virStorageVolPtr vol) virConnectPtr virStorageVolGetConnect (virStorageVolPtr vol) int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info) const char * virStorageVolGetKey (virStorageVolPtr vol) const char * virStorageVolGetName (virStorageVolPtr vol) char * virStorageVolGetPath (virStorageVolPtr vol) char * virStorageVolGetXMLDesc (virStorageVolPtr vol,
unsigned int flags) virStorageVolPtr virStorageVolLookupByKey (virConnectPtr conn,
const char * key) virStorageVolPtr virStorageVolLookupByName (virStoragePoolPtr pool,
const char * name) virStorageVolPtr virStorageVolLookupByPath (virConnectPtr conn,
const char * path) int virStorageVolRef (virStorageVolPtr vol) int virStorageVolResize (virStorageVolPtr vol,
unsigned long long capacity,
unsigned int flags) int virStorageVolUpload (virStorageVolPtr vol,
virStreamPtr stream,
unsigned long long offset,
unsigned long long length,
unsigned int flags) int virStorageVolWipe (virStorageVolPtr vol,
unsigned int flags) int virStorageVolWipePattern (virStorageVolPtr vol,
unsigned int algorithm,
unsigned int flags) int virStreamAbort (virStreamPtr stream) int virStreamEventAddCallback (virStreamPtr stream,
int events,
virStreamEventCallback cb,
void * opaque,
virFreeCallback ff) typedef virStreamEventCallback void virStreamEventCallback (virStreamPtr stream,
int events,
void * opaque) int virStreamEventRemoveCallback (virStreamPtr stream) int virStreamEventUpdateCallback (virStreamPtr stream,
int events) int virStreamFinish (virStreamPtr stream) int virStreamFree (virStreamPtr stream) virStreamPtr virStreamNew (virConnectPtr conn,
unsigned int flags) int virStreamRecv (virStreamPtr stream,
char * data,
size_t nbytes) int virStreamRecvAll (virStreamPtr stream,
virStreamSinkFunc handler,
void * opaque) int virStreamRef (virStreamPtr stream) int virStreamSend (virStreamPtr stream,
const char * data,
size_t nbytes) int virStreamSendAll (virStreamPtr stream,
virStreamSourceFunc handler,
void * opaque) typedef virStreamSinkFunc int virStreamSinkFunc (virStreamPtr st,
const char * data,
size_t nbytes,
void * opaque) typedef virStreamSourceFunc int virStreamSourceFunc (virStreamPtr st,
char * data,
size_t nbytes,
void * opaque) int virTypedParamsAddBoolean (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
int value) int virTypedParamsAddDouble (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
double value) int virTypedParamsAddFromString (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
int type,
const char * value) int virTypedParamsAddInt (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
int value) int virTypedParamsAddLLong (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
long long value) int virTypedParamsAddString (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
const char * value) int virTypedParamsAddUInt (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
unsigned int value) int virTypedParamsAddULLong (virTypedParameterPtr * params,
int * nparams,
int * maxparams,
const char * name,
unsigned long long value) void virTypedParamsClear (virTypedParameterPtr params,
int nparams) void virTypedParamsFree (virTypedParameterPtr params,
int nparams) virTypedParameterPtr virTypedParamsGet (virTypedParameterPtr params,
int nparams,
const char * name) int virTypedParamsGetBoolean (virTypedParameterPtr params,
int nparams,
const char * name,
int * value) int virTypedParamsGetDouble (virTypedParameterPtr params,
int nparams,
const char * name,
double * value) int virTypedParamsGetInt (virTypedParameterPtr params,
int nparams,
const char * name,
int * value) int virTypedParamsGetLLong (virTypedParameterPtr params,
int nparams,
const char * name,
long long * value) int virTypedParamsGetString (virTypedParameterPtr params,
int nparams,
const char * name,
const char ** value) int virTypedParamsGetUInt (virTypedParameterPtr params,
int nparams,
const char * name,
unsigned int * value) int virTypedParamsGetULLong (virTypedParameterPtr params,
int nparams,
const char * name,
unsigned long long * value)

Description

Macros¶

LIBVIR_CHECK_VERSION¶

#define LIBVIR_CHECK_VERSION

Macro for developers to easily check what version of the library their code is compiling against. e.g. #if LIBVIR_CHECK_VERSION(1,1,3) // some code that only works in 1.1.3 and newer #endif

LIBVIR_VERSION_NUMBER¶

#define LIBVIR_VERSION_NUMBER

Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro

VIR_COPY_CPUMAP¶

#define VIR_COPY_CPUMAP

This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extracts the cpumap of the specified vcpu from cpumaps array and copies it into cpumap to be used later by virDomainPinVcpu() API.

VIR_CPU_MAPLEN¶

#define VIR_CPU_MAPLEN

This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual & all physical CPUs of a domain.

VIR_CPU_USABLE¶

#define VIR_CPU_USABLE

This macro is to be used in conjunction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non-zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.

VIR_CPU_USED¶

#define VIR_CPU_USED

This macro can be used in conjunction with virNodeGetCPUMap() API. It returns non-zero if the bit of the related CPU is set.

VIR_DOMAIN_BANDWIDTH_IN_AVERAGE¶

#define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE

Macro represents the inbound average of NIC bandwidth, as a uint.

VIR_DOMAIN_BANDWIDTH_IN_BURST¶

#define VIR_DOMAIN_BANDWIDTH_IN_BURST

Macro represents the inbound burst of NIC bandwidth, as a uint.

VIR_DOMAIN_BANDWIDTH_IN_PEAK¶

#define VIR_DOMAIN_BANDWIDTH_IN_PEAK

Macro represents the inbound peak of NIC bandwidth, as a uint.

VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE¶

#define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE

Macro represents the outbound average of NIC bandwidth, as a uint.

VIR_DOMAIN_BANDWIDTH_OUT_BURST¶

#define VIR_DOMAIN_BANDWIDTH_OUT_BURST

Macro represents the outbound burst of NIC bandwidth, as a uint.

VIR_DOMAIN_BANDWIDTH_OUT_PEAK¶

#define VIR_DOMAIN_BANDWIDTH_OUT_PEAK

Macro represents the outbound peak of NIC bandwidth, as a uint.

VIR_DOMAIN_BLKIO_DEVICE_READ_BPS¶

#define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS

Macro for the blkio tunable throttle.read_iops_device: it represents the bytes of reading the block device per second, as a string. The string is parsed as a series of /path/to/device, read_bps elements, separated by ','.

VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS¶

#define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS

Macro for the blkio tunable throttle.read_iops_device: it represents the number of reading the block device per second, as a string. The string is parsed as a series of /path/to/device, read_iops elements, separated by ','.

VIR_DOMAIN_BLKIO_DEVICE_WEIGHT¶

#define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT

Macro for the blkio tunable weight_device: it represents the per-device weight, as a string. The string is parsed as a series of /path/to/device,weight elements, separated by ','.

VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS¶

#define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS

Macro for the blkio tunable throttle.read_iops_device: it represents the number of reading the block device per second, as a string. The string is parsed as a series of /path/to/device, write_bps elements, separated by ','.

VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS¶

#define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS

Macro for the blkio tunable throttle.write_iops_device: it represents the number of writing the block device per second, as a string. The string is parsed as a series of /path/to/device, write_iops elements, separated by ','.

VIR_DOMAIN_BLKIO_FIELD_LENGTH¶

#define VIR_DOMAIN_BLKIO_FIELD_LENGTH

Macro providing the field length of virBlkioParameter. Provided for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the preferred value since 0.9.2.

VIR_DOMAIN_BLKIO_WEIGHT¶

#define VIR_DOMAIN_BLKIO_WEIGHT

Macro for the Blkio tunable weight: it represents the io weight the guest can use, as a uint.

VIR_DOMAIN_BLOCK_COPY_BANDWIDTH¶

#define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH

Macro for the virDomainBlockCopy bandwidth tunable: it represents the maximum bandwidth in bytes/s, and is used while getting the copy operation into the mirrored phase, with a type of ullong. For compatibility with virDomainBlockJobSetSpeed(), values larger than 2^52 bytes/sec (a 32-bit MiB/s value) may be rejected on input due to overflow considerations (but do you really have an interface with that much bandwidth?), and values larger than 2^31 bytes/sec may cause overflow problems if queried in bytes/sec. Hypervisors may further restrict the set of valid values. Specifying 0 is the same as omitting this parameter, to request no bandwidth limiting. Some hypervisors may lack support for this parameter, while still allowing a subsequent change of bandwidth via virDomainBlockJobSetSpeed(). The actual speed can be determined with virDomainGetBlockJobInfo().

VIR_DOMAIN_BLOCK_COPY_BUF_SIZE¶

#define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE

Macro for the virDomainBlockCopy buffer size tunable: it represents how much data in bytes can be in flight between source and destination, as an unsigned long long. Specifying 0 is the same as omitting this parameter, to request the hypervisor default.

VIR_DOMAIN_BLOCK_COPY_GRANULARITY¶

#define VIR_DOMAIN_BLOCK_COPY_GRANULARITY

Macro for the virDomainBlockCopy granularity tunable: it represents the granularity in bytes at which the copy operation recognizes dirty blocks that need copying, as an unsigned int. Hypervisors may restrict this to be a power of two or fall within a certain range. Specifying 0 is the same as omitting this parameter, to request the hypervisor default.

VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC¶

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC

Macro for the BlockIoTune tunable weight: it represents the read bytes per second permitted through a block device, as a ullong.

VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC¶

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC

Macro for the BlockIoTune tunable weight: it represents the read I/O operations per second permitted through a block device, as a ullong.

VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC¶

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC

Macro for the BlockIoTune tunable weight: it represents the total bytes per second permitted through a block device, as a ullong.

VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC¶

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC

Macro for the BlockIoTune tunable weight: it represents the total I/O operations per second permitted through a block device, as a ullong.

VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC¶

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC

Macro for the BlockIoTune tunable weight: it represents the write bytes per second permitted through a block device, as a ullong.

VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC¶

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC

Macro for the BlockIoTune tunable weight: it represents the write I/O operations per second permitted through a block device, as a ullong.

VIR_DOMAIN_BLOCK_STATS_ERRS¶

#define VIR_DOMAIN_BLOCK_STATS_ERRS

In Xen this returns the mysterious 'oo_req', as an llong.

VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH¶

#define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH

Macro providing the field length of parameter names when using virDomainBlockStatsFlags().

VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ¶

#define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ

Macro represents the total flush requests of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES¶

#define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES

Macro represents the total time spend on cache flushing in nano-seconds of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_READ_BYTES¶

#define VIR_DOMAIN_BLOCK_STATS_READ_BYTES

Macro represents the total number of read bytes of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_READ_REQ¶

#define VIR_DOMAIN_BLOCK_STATS_READ_REQ

Macro represents the total read requests of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES¶

#define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES

Macro represents the total time spend on cache reads in nano-seconds of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES¶

#define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES

Macro represents the total number of write bytes of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_WRITE_REQ¶

#define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ

Macro represents the total write requests of the block device, as an llong.

VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES¶

#define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES

Macro represents the total time spend on cache writes in nano-seconds of the block device, as an llong.

VIR_DOMAIN_CPU_STATS_CPUTIME¶

#define VIR_DOMAIN_CPU_STATS_CPUTIME

cpu usage (sum of both vcpu and hypervisor usage) in nanoseconds, as a ullong

VIR_DOMAIN_CPU_STATS_SYSTEMTIME¶

#define VIR_DOMAIN_CPU_STATS_SYSTEMTIME

cpu time charged to system instructions in nanoseconds, as a ullong

VIR_DOMAIN_CPU_STATS_USERTIME¶

#define VIR_DOMAIN_CPU_STATS_USERTIME

cpu time charged to user instructions in nanoseconds, as a ullong

VIR_DOMAIN_CPU_STATS_VCPUTIME¶

#define VIR_DOMAIN_CPU_STATS_VCPUTIME

vcpu usage in nanoseconds (cpu_time excluding hypervisor time), as a ullong

VIR_DOMAIN_EVENT_CALLBACK¶

#define VIR_DOMAIN_EVENT_CALLBACK

Used to cast the event specific callback into the generic one for use for virConnectDomainEventRegisterAny()

VIR_DOMAIN_JOB_COMPRESSION_BYTES¶

#define VIR_DOMAIN_JOB_COMPRESSION_BYTES

virDomainGetJobStats field: number of compressed bytes transferred since the beginning of migration, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_COMPRESSION_CACHE¶

#define VIR_DOMAIN_JOB_COMPRESSION_CACHE

virDomainGetJobStats field: size of the cache (in bytes) used for compressing repeatedly transferred memory pages during live migration, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES¶

#define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES

virDomainGetJobStats field: number of repeatedly changing pages that were not found in compression cache and thus could not be compressed, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW¶

#define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW

virDomainGetJobStats field: number of repeatedly changing pages that were found in compression cache but were sent uncompressed because the result of compression was larger than the original page as a whole, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_COMPRESSION_PAGES¶

#define VIR_DOMAIN_JOB_COMPRESSION_PAGES

virDomainGetJobStats field: number of compressed pages transferred since the beginning of migration, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_DATA_PROCESSED¶

#define VIR_DOMAIN_JOB_DATA_PROCESSED

virDomainGetJobStats field: number of bytes transferred from the beginning of the job, as VIR_TYPED_PARAM_ULLONG. This field corresponds to dataProcessed field in virDomainJobInfo.

VIR_DOMAIN_JOB_DATA_REMAINING¶

#define VIR_DOMAIN_JOB_DATA_REMAINING

virDomainGetJobStats field: number of bytes that still need to be transferred, as VIR_TYPED_PARAM_ULLONG. This field corresponds to dataRemaining field in virDomainJobInfo.

VIR_DOMAIN_JOB_DATA_TOTAL¶

#define VIR_DOMAIN_JOB_DATA_TOTAL

virDomainGetJobStats field: total number of bytes supposed to be transferred, as VIR_TYPED_PARAM_ULLONG. For VIR_DOMAIN_JOB_UNBOUNDED jobs, this may be less than the sum of VIR_DOMAIN_JOB_DATA_PROCESSED and VIR_DOMAIN_JOB_DATA_REMAINING in the event that the hypervisor has to repeat some data, e.g., due to dirtied pages during migration. For VIR_DOMAIN_JOB_BOUNDED jobs, VIR_DOMAIN_JOB_DATA_TOTAL shall always equal VIR_DOMAIN_JOB_DATA_PROCESSED + VIR_DOMAIN_JOB_DATA_REMAINING. This field corresponds to dataTotal field in virDomainJobInfo.

VIR_DOMAIN_JOB_DISK_BPS¶

#define VIR_DOMAIN_JOB_DISK_BPS

virDomainGetJobStats field: network throughput used while migrating disks in Bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_DISK_PROCESSED¶

#define VIR_DOMAIN_JOB_DISK_PROCESSED

virDomainGetJobStats field: as VIR_DOMAIN_JOB_DATA_PROCESSED but only tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG. This field corresponds to fileProcessed field in virDomainJobInfo.

VIR_DOMAIN_JOB_DISK_REMAINING¶

#define VIR_DOMAIN_JOB_DISK_REMAINING

virDomainGetJobStats field: as VIR_DOMAIN_JOB_DATA_REMAINING but only tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG. This field corresponds to fileRemaining field in virDomainJobInfo.

VIR_DOMAIN_JOB_DISK_TOTAL¶

#define VIR_DOMAIN_JOB_DISK_TOTAL

virDomainGetJobStats field: as VIR_DOMAIN_JOB_DATA_TOTAL but only tracking guest disk progress, as VIR_TYPED_PARAM_ULLONG. This field corresponds to fileTotal field in virDomainJobInfo.

VIR_DOMAIN_JOB_DOWNTIME¶

#define VIR_DOMAIN_JOB_DOWNTIME

virDomainGetJobStats field: downtime (ms) that is expected to happen during migration, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_MEMORY_BPS¶

#define VIR_DOMAIN_JOB_MEMORY_BPS

virDomainGetJobStats field: network throughput used while migrating memory in Bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_MEMORY_CONSTANT¶

#define VIR_DOMAIN_JOB_MEMORY_CONSTANT

virDomainGetJobStats field: number of pages filled with a constant byte (all bytes in a single page are identical) transferred since the beginning of the migration job, as VIR_TYPED_PARAM_ULLONG. The most common example of such pages are zero pages, i.e., pages filled with zero bytes.

VIR_DOMAIN_JOB_MEMORY_NORMAL¶

#define VIR_DOMAIN_JOB_MEMORY_NORMAL

virDomainGetJobStats field: number of pages that were transferred without any kind of compression (i.e., pages which were not filled with a constant byte and which could not be compressed) transferred since the beginning of the migration job, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES¶

#define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES

virDomainGetJobStats field: number of bytes transferred as normal pages, as VIR_TYPED_PARAM_ULLONG. See VIR_DOMAIN_JOB_MEMORY_NORMAL for more details.

VIR_DOMAIN_JOB_MEMORY_PROCESSED¶

#define VIR_DOMAIN_JOB_MEMORY_PROCESSED

virDomainGetJobStats field: as VIR_DOMAIN_JOB_DATA_PROCESSED but only tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG. This field corresponds to memProcessed field in virDomainJobInfo.

VIR_DOMAIN_JOB_MEMORY_REMAINING¶

#define VIR_DOMAIN_JOB_MEMORY_REMAINING

virDomainGetJobStats field: as VIR_DOMAIN_JOB_DATA_REMAINING but only tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG. This field corresponds to memRemaining field in virDomainJobInfo.

VIR_DOMAIN_JOB_MEMORY_TOTAL¶

#define VIR_DOMAIN_JOB_MEMORY_TOTAL

virDomainGetJobStats field: as VIR_DOMAIN_JOB_DATA_TOTAL but only tracking guest memory progress, as VIR_TYPED_PARAM_ULLONG. This field corresponds to memTotal field in virDomainJobInfo.

VIR_DOMAIN_JOB_SETUP_TIME¶

#define VIR_DOMAIN_JOB_SETUP_TIME

virDomainGetJobStats field: total time in milliseconds spent preparing the migration in the 'setup' phase before the iterations begin, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_JOB_TIME_ELAPSED¶

#define VIR_DOMAIN_JOB_TIME_ELAPSED

virDomainGetJobStats field: time (ms) since the beginning of the job, as VIR_TYPED_PARAM_ULLONG. This field corresponds to timeElapsed field in virDomainJobInfo.

VIR_DOMAIN_JOB_TIME_REMAINING¶

#define VIR_DOMAIN_JOB_TIME_REMAINING

virDomainGetJobStats field: remaining time (ms) for VIR_DOMAIN_JOB_BOUNDED jobs, as VIR_TYPED_PARAM_ULLONG. This field corresponds to timeRemaining field in virDomainJobInfo.

VIR_DOMAIN_MEMORY_FIELD_LENGTH¶

#define VIR_DOMAIN_MEMORY_FIELD_LENGTH

Macro providing the field length of virMemoryParameter. Provided for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the preferred value since 0.9.2.

VIR_DOMAIN_MEMORY_HARD_LIMIT¶

#define VIR_DOMAIN_MEMORY_HARD_LIMIT

Macro for the memory tunable hard_limit: it represents the maximum memory the guest can use, as a ullong.

VIR_DOMAIN_MEMORY_MIN_GUARANTEE¶

#define VIR_DOMAIN_MEMORY_MIN_GUARANTEE

Macro for the memory tunable min_guarantee: it represents the minimum memory guaranteed to be reserved for the guest, as a ullong.

VIR_DOMAIN_MEMORY_PARAM_UNLIMITED¶

#define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED

Macro providing the virMemoryParameter value that indicates "unlimited"

VIR_DOMAIN_MEMORY_SOFT_LIMIT¶

#define VIR_DOMAIN_MEMORY_SOFT_LIMIT

Macro for the memory tunable soft_limit: it represents the memory upper limit enforced during memory contention, as a ullong.

VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT¶

#define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT

Macro for the swap tunable swap_hard_limit: it represents the maximum swap plus memory the guest can use, as a ullong. This limit has to be more than VIR_DOMAIN_MEMORY_HARD_LIMIT.

VIR_DOMAIN_NUMA_MODE¶

#define VIR_DOMAIN_NUMA_MODE

Macro for typed parameter name that lists the numa mode of a domain, as an int containing a virDomainNumatuneMemMode value.

VIR_DOMAIN_NUMA_NODESET¶

#define VIR_DOMAIN_NUMA_NODESET

Macro for typed parameter name that lists the numa nodeset of a domain, as a string.

VIR_DOMAIN_SCHEDULER_CAP¶

#define VIR_DOMAIN_SCHEDULER_CAP

Macro represents the maximum scheduler cap, when using the credit scheduler, as a uint.

VIR_DOMAIN_SCHEDULER_CPU_SHARES¶

#define VIR_DOMAIN_SCHEDULER_CPU_SHARES

Macro represents proportional weight of the scheduler used on the host cpu, when using the posix scheduler, as a ullong.

VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD¶

#define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD

Macro represents the enforcement period for a quota in microseconds, when using the posix scheduler, for all emulator activity not tied to vcpus, as a ullong.

VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA¶

#define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA

Macro represents the maximum bandwidth to be used within a period for all emulator activity not tied to vcpus, when using the posix scheduler, as an llong.

VIR_DOMAIN_SCHEDULER_LIMIT¶

#define VIR_DOMAIN_SCHEDULER_LIMIT

Macro represents the scheduler limit value, when using the allocation scheduler, as an llong.

VIR_DOMAIN_SCHEDULER_RESERVATION¶

#define VIR_DOMAIN_SCHEDULER_RESERVATION

Macro represents the scheduler reservation value, when using the allocation scheduler, as an llong.

VIR_DOMAIN_SCHEDULER_SHARES¶

#define VIR_DOMAIN_SCHEDULER_SHARES

Macro represents the scheduler shares value, when using the allocation scheduler, as an int.

VIR_DOMAIN_SCHEDULER_VCPU_PERIOD¶

#define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD

Macro represents the enforcement period for a quota, in microseconds, for vcpus only, when using the posix scheduler, as a ullong.

VIR_DOMAIN_SCHEDULER_VCPU_QUOTA¶

#define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA

Macro represents the maximum bandwidth to be used within a period for vcpus only, when using the posix scheduler, as an llong.

VIR_DOMAIN_SCHEDULER_WEIGHT¶

#define VIR_DOMAIN_SCHEDULER_WEIGHT

Macro represents the relative weight, when using the credit scheduler, as a uint.

VIR_DOMAIN_SCHED_FIELD_LENGTH¶

#define VIR_DOMAIN_SCHED_FIELD_LENGTH

Macro providing the field length of virSchedParameter. Provided for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the preferred value since 0.9.2.

VIR_DOMAIN_SEND_KEY_MAX_KEYS¶

#define VIR_DOMAIN_SEND_KEY_MAX_KEYS

Maximum number of keycodes that can be sent in one virDomainSendKey() call.

VIR_DOMAIN_TUNABLE_BLKDEV_DISK¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_DISK

Macro represents the name of guest disk for which the values are updated, as VIR_TYPED_PARAM_STRING.

VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC

Marco represents the read throughput limit in bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC

Macro represents the read I/O operations per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC

Marco represents the total throughput limit in bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC

Macro represents the total I/O operations per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC

Macro represents the write throughput limit in bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC¶

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC

Macro represents the write I/O operations per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES¶

#define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES

Macro represents proportional weight of the scheduler used on the host cpu, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN¶

#define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN

Macro represents formatted pinning for emulator process, as VIR_TYPED_PARAM_STRING.

VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD¶

#define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD

Macro represents the enforcement period for a quota in microseconds, when using the posix scheduler, for all emulator activity not tied to vcpus, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA¶

#define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA

Macro represents the maximum bandwidth to be used within a period for all emulator activity not tied to vcpus, when using the posix scheduler, as an VIR_TYPED_PARAM_LLONG.

VIR_DOMAIN_TUNABLE_CPU_VCPUPIN¶

#define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN

Macro represents formatted pinning for one vcpu specified by id which is appended to the parameter name, for example "cputune.vcpupin1", as VIR_TYPED_PARAM_STRING.

VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD¶

#define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD

Macro represents the enforcement period for a quota, in microseconds, for vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA¶

#define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA

Macro represents the maximum bandwidth to be used within a period for vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.

VIR_GET_CPUMAP¶

#define VIR_GET_CPUMAP

This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.

VIR_MIGRATE_PARAM_BANDWIDTH¶

#define VIR_MIGRATE_PARAM_BANDWIDTH

virDomainMigrate* params field: the maximum bandwidth (in MiB/s) that will be used for migration as VIR_TYPED_PARAM_ULLONG. If set to 0 or omitted, libvirt will choose a suitable default. Some hypervisors do not support this feature and will return an error if this field is used and is not 0.

VIR_MIGRATE_PARAM_DEST_NAME¶

#define VIR_MIGRATE_PARAM_DEST_NAME

virDomainMigrate* params field: the name to be used for the domain on the destination host as VIR_TYPED_PARAM_STRING. Omitting this parameter keeps the domain name the same. This field is only allowed to be used with hypervisors that support domain renaming during migration.

VIR_MIGRATE_PARAM_DEST_XML¶

#define VIR_MIGRATE_PARAM_DEST_XML

virDomainMigrate* params field: the new configuration to be used for the domain on the destination host as VIR_TYPED_PARAM_STRING. The configuration must include an identical set of virtual devices, to ensure a stable guest ABI across migration. Only parameters related to host side configuration can be changed in the XML. Hypervisors which support this field will forbid migration if the provided XML would cause a change in the guest ABI. This field cannot be used to rename the domain during migration (use VIR_MIGRATE_PARAM_DEST_NAME field for that purpose). Domain name in the destination XML must match the original domain name. Omitting this parameter keeps the original domain configuration. Using this field with hypervisors that do not support changing domain configuration during migration will result in a failure.

VIR_MIGRATE_PARAM_GRAPHICS_URI¶

#define VIR_MIGRATE_PARAM_GRAPHICS_URI

virDomainMigrate* params field: URI to use for migrating client's connection to domain's graphical console as VIR_TYPED_PARAM_STRING. If specified, the client will be asked to automatically reconnect using these parameters instead of the automatically computed ones. This can be useful if, e.g., the client does not have a direct access to the network virtualization hosts are connected to and needs to connect through a proxy. The URI is formed as follows: protocol://hostname[:port]/[?parameters] where protocol is either "spice" or "vnc" and parameters is a list of protocol specific parameters separated by '&'. Currently recognized parameters are "tlsPort" and "tlsSubject". For example, spice://target.host.com:1234/?tlsPort=4567

VIR_MIGRATE_PARAM_LISTEN_ADDRESS¶

#define VIR_MIGRATE_PARAM_LISTEN_ADDRESS

virDomainMigrate* params field: The listen address that hypervisor on the destination side should bind to for incoming migration. Both IPv4 and IPv6 addresses are accepted as well as hostnames (the resolving is done on destination). Some hypervisors do not support this feature and will return an error if this field is used.

VIR_MIGRATE_PARAM_URI¶

#define VIR_MIGRATE_PARAM_URI

virDomainMigrate* params field: URI to use for initiating domain migration as VIR_TYPED_PARAM_STRING. It takes a hypervisor specific format. The uri_transports element of the hypervisor capabilities XML includes details of the supported URI schemes. When omitted libvirt will auto-generate suitable default URI. It is typically only necessary to specify this URI if the destination host has multiple interfaces and a specific interface is required to transmit migration data. This filed may not be used when VIR_MIGRATE_TUNNELLED flag is set.

VIR_NETWORK_EVENT_CALLBACK¶

#define VIR_NETWORK_EVENT_CALLBACK

Used to cast the event specific callback into the generic one for use for virConnectNetworkEventRegisterAny()

VIR_NODEINFO_MAXCPUS¶

#define VIR_NODEINFO_MAXCPUS

This macro is to calculate the total number of CPUs supported but not necessary active in the host.

VIR_NODE_CPU_STATS_FIELD_LENGTH¶

#define VIR_NODE_CPU_STATS_FIELD_LENGTH

Macro providing the field length of virNodeCPUStats

VIR_NODE_CPU_STATS_IDLE¶

#define VIR_NODE_CPU_STATS_IDLE

The cumulative idle CPU time, since the node booting up (in nanoseconds).

VIR_NODE_CPU_STATS_INTR¶

#define VIR_NODE_CPU_STATS_INTR

The cumulative interrupt CPU time, since the node booting up (in nanoseconds).

VIR_NODE_CPU_STATS_IOWAIT¶

#define VIR_NODE_CPU_STATS_IOWAIT

The cumulative I/O wait CPU time, since the node booting up (in nanoseconds).

VIR_NODE_CPU_STATS_KERNEL¶

#define VIR_NODE_CPU_STATS_KERNEL

Macro for the cumulative CPU time which was spent by the kernel, since the node booting up (in nanoseconds).

VIR_NODE_CPU_STATS_USER¶

#define VIR_NODE_CPU_STATS_USER

The cumulative CPU time which was spent by user processes, since the node booting up (in nanoseconds).

VIR_NODE_CPU_STATS_UTILIZATION¶

#define VIR_NODE_CPU_STATS_UTILIZATION

The CPU utilization of a node. The usage value is in percent and 100% represents all CPUs of the node.

VIR_NODE_MEMORY_STATS_BUFFERS¶

#define VIR_NODE_MEMORY_STATS_BUFFERS

Macro for the buffer memory: On Linux, it is only returned in case of VIR_NODE_MEMORY_STATS_ALL_CELLS.

VIR_NODE_MEMORY_STATS_CACHED¶

#define VIR_NODE_MEMORY_STATS_CACHED

Macro for the cached memory: On Linux, it is only returned in case of VIR_NODE_MEMORY_STATS_ALL_CELLS.

VIR_NODE_MEMORY_STATS_FIELD_LENGTH¶

#define VIR_NODE_MEMORY_STATS_FIELD_LENGTH

Macro providing the field length of virNodeMemoryStats

VIR_NODE_MEMORY_STATS_FREE¶

#define VIR_NODE_MEMORY_STATS_FREE

Macro for the free memory of specified cell: On Linux, it includes buffer and cached memory, in case of VIR_NODE_MEMORY_STATS_ALL_CELLS.

VIR_NODE_MEMORY_STATS_TOTAL¶

#define VIR_NODE_MEMORY_STATS_TOTAL

Macro for the total memory of specified cell: it represents the maximum memory.

VIR_SECURITY_DOI_BUFLEN¶

#define VIR_SECURITY_DOI_BUFLEN

Macro providing the maximum length of the virSecurityModel doi string.

VIR_SECURITY_LABEL_BUFLEN¶

#define VIR_SECURITY_LABEL_BUFLEN

Macro providing the maximum length of the virSecurityLabel label string. Note that this value is based on that used by Labeled NFS.

VIR_SECURITY_MODEL_BUFLEN¶

#define VIR_SECURITY_MODEL_BUFLEN

Macro providing the maximum length of the virSecurityModel model string.

VIR_TYPED_PARAM_FIELD_LENGTH¶

#define VIR_TYPED_PARAM_FIELD_LENGTH

Macro providing the field length of virTypedParameter name

VIR_UNUSE_CPU¶

#define VIR_UNUSE_CPU

This macro is to be used in conjunction with virDomainPinVcpu() API. It resets the bit (CPU not usable) of the related cpu in cpumap.

VIR_USE_CPU¶

#define VIR_USE_CPU

This macro is to be used in conjunction with virDomainPinVcpu() API. It sets the bit (CPU usable) of the related cpu in cpumap.

VIR_UUID_BUFLEN¶

#define VIR_UUID_BUFLEN

This macro provides the length of the buffer required for virDomainGetUUID()

VIR_UUID_STRING_BUFLEN¶

#define VIR_UUID_STRING_BUFLEN

This macro provides the length of the buffer required for virDomainGetUUIDString()

_virBlkioParameter¶

#define _virBlkioParameter

_virMemoryParameter¶

#define _virMemoryParameter

_virSchedParameter¶

#define _virSchedParameter

Types¶

virBlkioParameter¶

struct virBlkioParameter {
char field[VIR_TYPED_PARAM_FIELD_LENGTH]field
parameter name
inttype
parameter type, virTypedParameterType
union {
inti
type is INT
unsigned intui
type is UINT
long long intl
type is LLONG
unsigned long long intul
type is ULLONG
doubled
type is DOUBLE
charb
type is BOOLEAN
char *s
type is STRING, may not be NULL
}value
parameter value
}

virBlkioParameterType¶

enum virBlkioParameterType {
VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN
VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE
VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT
VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG
VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT
VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG
}

virCPUCompareResult¶

virConnect¶

struct virConnect {
The content of this structure is not made public by the API
}

virConnectAuth¶

struct virConnectAuth {
int *credtype
List of supported virConnectCredentialType values
unsigned intncredtype
virConnectAuthCallbackPtrcb
Callback used to collect credentials
void *cbdata
}

virConnectBaselineCPUFlags¶

enum virConnectBaselineCPUFlags {
VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = 1
show all features
}

virConnectCloseReason¶

enum virConnectCloseReason {
VIR_CONNECT_CLOSE_REASON_ERROR = 0
Misc I/O error
VIR_CONNECT_CLOSE_REASON_EOF = 1
End-of-file from server
VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2
Keepalive timer triggered
VIR_CONNECT_CLOSE_REASON_CLIENT = 3
Client requested it
VIR_CONNECT_CLOSE_REASON_LAST = 4
}

virConnectCompareCPUFlags¶

enum virConnectCompareCPUFlags {
VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE = 1
treat incompatible CPUs as failure
}

virConnectCredential¶

struct virConnectCredential {
inttype
One of virConnectCredentialType constants
const char *prompt
Prompt to show to user
const char *challenge
Additional challenge to show
const char *defresult
Optional default result
char *result
Result to be filled with user response (or defresult)
unsigned intresultlen
Length of the result
}

virConnectCredentialType¶

enum virConnectCredentialType {
VIR_CRED_USERNAME = 1
Identity to act as
VIR_CRED_AUTHNAME = 2
Identify to authorize as
VIR_CRED_LANGUAGE = 3
RFC 1766 languages, comma separated
VIR_CRED_CNONCE = 4
client supplies a nonce
VIR_CRED_PASSPHRASE = 5
Passphrase secret
VIR_CRED_ECHOPROMPT = 6
Challenge response
VIR_CRED_NOECHOPROMPT = 7
Challenge response
VIR_CRED_REALM = 8
Authentication realm
VIR_CRED_EXTERNAL = 9
Externally managed credential
VIR_CRED_LAST = 10
More may be added - expect the unexpected
}

virConnectDomainEventBlockJobStatus¶

virConnectDomainEventDiskChangeReason¶

virConnectFlags¶

enum virConnectFlags {
VIR_CONNECT_RO = 1
A readonly connection
VIR_CONNECT_NO_ALIASES = 2
Don't try to resolve URI aliases
}

virConnectGetAllDomainStatsFlags¶

enum virConnectGetAllDomainStatsFlags {
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE
VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE
VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER
VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED
VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT
VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING
VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF
VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 2147483648
enforce requested stats
}

virConnectListAllDomainsFlags¶

virConnectListAllInterfacesFlags¶

enum virConnectListAllInterfacesFlags {
VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1
VIR_CONNECT_LIST_INTERFACES_ACTIVE = 2
}

virConnectListAllNetworksFlags¶

virConnectListAllNodeDeviceFlags¶

virConnectListAllSecretsFlags¶

enum virConnectListAllSecretsFlags {
VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1
kept in memory, never stored persistently
VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 2
VIR_CONNECT_LIST_SECRETS_PRIVATE = 4
not revealed to any caller of libvirt, nor to any other node
VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 8
}

virConnectListAllStoragePoolsFlags¶

virDomain¶

struct virDomain {
The content of this structure is not made public by the API
}

virDomainBlockCommitFlags¶

enum virDomainBlockCommitFlags {
VIR_DOMAIN_BLOCK_COMMIT_SHALLOW = 1
NULL base means next backing file, not whole chain
VIR_DOMAIN_BLOCK_COMMIT_DELETE = 2
Delete any files that are now invalid after their contents have been committed
VIR_DOMAIN_BLOCK_COMMIT_ACTIVE = 4
Allow a two-phase commit when top is the active layer
VIR_DOMAIN_BLOCK_COMMIT_RELATIVE = 8
keep the backing chain referenced using relative names
VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES = 16
bandwidth in bytes/s instead of MiB/s
}

virDomainBlockCopyFlags¶

enum virDomainBlockCopyFlags {
VIR_DOMAIN_BLOCK_COPY_SHALLOW = 1
Limit copy to top of source backing chain
VIR_DOMAIN_BLOCK_COPY_REUSE_EXT = 2
Reuse existing external file for a copy
}

virDomainBlockInfo¶

struct virDomainBlockInfo {
unsigned long longcapacity
logical size in bytes of the block device backing image
unsigned long longallocation
highest allocated extent in bytes of the block device backing image
unsigned long longphysical
physical size in bytes of the container of the backing image
}

virDomainBlockJobAbortFlags¶

enum virDomainBlockJobAbortFlags {
VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1
VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 2
}

virDomainBlockJobInfo¶

struct virDomainBlockJobInfo {
inttype
unsigned longbandwidth
The following fields provide an indication of block job progress. @cur indicates the current position and will be between 0 and @end. @end is the final cursor position for this operation and represents completion. To approximate progress, divide @cur by @end.
virDomainBlockJobCursorcur
virDomainBlockJobCursorend
}

virDomainBlockJobInfoFlags¶

enum virDomainBlockJobInfoFlags {
VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES = 1
bandwidth in bytes/s instead of MiB/s
}

virDomainBlockJobSetSpeedFlags¶

enum virDomainBlockJobSetSpeedFlags {
VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES = 1
bandwidth in bytes/s instead of MiB/s
}

virDomainBlockJobType¶

enum virDomainBlockJobType {
VIR_DOMAIN_BLOCK_JOB_TYPE_UNKNOWN = 0
Placeholder
VIR_DOMAIN_BLOCK_JOB_TYPE_PULL = 1
Block Pull (virDomainBlockPull, or virDomainBlockRebase without flags), job ends on completion
VIR_DOMAIN_BLOCK_JOB_TYPE_COPY = 2
Block Copy (virDomainBlockCopy, or virDomainBlockRebase with flags), job exists as long as mirroring is active
VIR_DOMAIN_BLOCK_JOB_TYPE_COMMIT = 3
Block Commit (virDomainBlockCommit without flags), job ends on completion
VIR_DOMAIN_BLOCK_JOB_TYPE_ACTIVE_COMMIT = 4
Active Block Commit (virDomainBlockCommit with flags), job exists as long as sync is active
VIR_DOMAIN_BLOCK_JOB_TYPE_LAST = 5
}

virDomainBlockPullFlags¶

enum virDomainBlockPullFlags {
VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES = 64
bandwidth in bytes/s instead of MiB/s
}

virDomainBlockRebaseFlags¶

enum virDomainBlockRebaseFlags {
VIR_DOMAIN_BLOCK_REBASE_SHALLOW = 1
Limit copy to top of source backing chain
VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT = 2
Reuse existing external file for a copy
VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 4
Make destination file raw
VIR_DOMAIN_BLOCK_REBASE_COPY = 8
Start a copy job
VIR_DOMAIN_BLOCK_REBASE_RELATIVE = 16
Keep backing chain referenced using relative names
VIR_DOMAIN_BLOCK_REBASE_COPY_DEV = 32
Treat destination as block device instead of file
VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES = 64
bandwidth in bytes/s instead of MiB/s
}

virDomainBlockResizeFlags¶

enum virDomainBlockResizeFlags {
VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1
size in bytes instead of KiB
}

virDomainBlockStatsStruct¶

struct virDomainBlockStatsStruct {
long longrd_req
number of read requests
long longrd_bytes
number of read bytes
long longwr_req
number of write requests
long longwr_bytes
number of written bytes
long longerrs
In Xen this returns the mysterious 'oo_req'.
}

virDomainBlockedReason¶

enum virDomainBlockedReason {
VIR_DOMAIN_BLOCKED_UNKNOWN = 0
the reason is unknown
VIR_DOMAIN_BLOCKED_LAST = 1
}

virDomainChannelFlags¶

enum virDomainChannelFlags {
VIR_DOMAIN_CHANNEL_FORCE = 1
abort a (possibly) active channel connection to force a new connection
}

virDomainConsoleFlags¶

enum virDomainConsoleFlags {
VIR_DOMAIN_CONSOLE_FORCE = 1
abort a (possibly) active console connection to force a new connection
VIR_DOMAIN_CONSOLE_SAFE = 2
check if the console driver supports safe console operations
}

virDomainControlInfo¶

struct virDomainControlInfo {
unsigned intstate
control state, one of virDomainControlState
unsigned intdetails
state details, currently 0
unsigned long longstateTime
for how long (in msec) control interface has been in current state (except for OK and ERROR states)
}

virDomainControlState¶

enum virDomainControlState {
VIR_DOMAIN_CONTROL_OK = 0
operational, ready to accept commands
VIR_DOMAIN_CONTROL_JOB = 1
background job is running (can be monitored by virDomainGetJobInfo); only limited set of commands may be allowed
VIR_DOMAIN_CONTROL_OCCUPIED = 2
occupied by a running command
VIR_DOMAIN_CONTROL_ERROR = 3
unusable, domain cannot be fully operated
VIR_DOMAIN_CONTROL_LAST = 4
}

virDomainCoreDumpFlags¶

enum virDomainCoreDumpFlags {
VIR_DUMP_CRASH = 1
crash after dump
VIR_DUMP_LIVE = 2
live dump
VIR_DUMP_BYPASS_CACHE = 4
avoid file system cache pollution
VIR_DUMP_RESET = 8
reset domain after dump finishes
VIR_DUMP_MEMORY_ONLY = 16
use dump-guest-memory
}

virDomainCoreDumpFormat¶

enum virDomainCoreDumpFormat {
VIR_DOMAIN_CORE_DUMP_FORMAT_RAW = 0
dump guest memory in raw format
VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_ZLIB = 1
kdump-compressed format, with zlib compression
VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_LZO = 2
kdump-compressed format, with lzo compression
VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_SNAPPY = 3
kdump-compressed format, with snappy compression
VIR_DOMAIN_CORE_DUMP_FORMAT_LAST = 4
NB: this enum value will increase over time as new events are added to the libvirt API. It reflects the last state supported by this version of the libvirt API.
}

virDomainCrashedReason¶

enum virDomainCrashedReason {
VIR_DOMAIN_CRASHED_UNKNOWN = 0
crashed for unknown reason
VIR_DOMAIN_CRASHED_PANICKED = 1
domain panicked
VIR_DOMAIN_CRASHED_LAST = 2
}

virDomainCreateFlags¶

enum virDomainCreateFlags {
VIR_DOMAIN_NONE = 0
Default behavior
VIR_DOMAIN_START_PAUSED = 1
Launch guest in paused state
VIR_DOMAIN_START_AUTODESTROY = 2
Automatically kill guest when virConnectPtr is closed
VIR_DOMAIN_START_BYPASS_CACHE = 4
Avoid file system cache pollution
VIR_DOMAIN_START_FORCE_BOOT = 8
Boot, discarding any managed save
}

virDomainDestroyFlagsValues¶

enum virDomainDestroyFlagsValues {
VIR_DOMAIN_DESTROY_DEFAULT = 0
Default behavior - could lead to data loss!!
VIR_DOMAIN_DESTROY_GRACEFUL = 1
only SIGTERM, no SIGKILL
}

virDomainDeviceModifyFlags¶

enum virDomainDeviceModifyFlags {
VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG
Additionally, these flags may be bitwise-OR'd in.
VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT
VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE
VIR_DOMAIN_DEVICE_MODIFY_FORCE = 4
Forcibly modify device (ex. force eject a cdrom)
}

virDomainDiskError¶

struct virDomainDiskError {
char *disk
disk target
interror
}

virDomainDiskErrorCode¶

enum virDomainDiskErrorCode {
VIR_DOMAIN_DISK_ERROR_NONE = 0
no error
VIR_DOMAIN_DISK_ERROR_UNSPEC = 1
unspecified I/O error
VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2
no space left on the device
VIR_DOMAIN_DISK_ERROR_LAST = 3
}

virDomainEventCrashedDetailType¶

enum virDomainEventCrashedDetailType {
VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0
Guest was panicked
VIR_DOMAIN_EVENT_CRASHED_LAST = 1
}

virDomainEventDefinedDetailType¶

enum virDomainEventDefinedDetailType {
VIR_DOMAIN_EVENT_DEFINED_ADDED = 0
Newly created config file
VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1
Changed config file
VIR_DOMAIN_EVENT_DEFINED_LAST = 2
}

virDomainEventGraphicsAddress¶

struct virDomainEventGraphicsAddress {
intfamily
char *node
Address of node (eg IP address, or UNIX path)
char *service
Service name/number (eg TCP port, or NULL)
}

virDomainEventGraphicsAddressType¶

virDomainEventGraphicsPhase¶

enum virDomainEventGraphicsPhase {
VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0
Initial socket connection established
VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE = 1
Authentication & setup completed
VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT = 2
Final socket disconnection
VIR_DOMAIN_EVENT_GRAPHICS_LAST = 3
}

virDomainEventGraphicsSubject¶

struct virDomainEventGraphicsSubject {
intnidentity
Number of identities in arra
virDomainEventGraphicsSubjectIdentityPtridentities
Array of identities for subject
}

virDomainEventGraphicsSubjectIdentity¶

struct virDomainEventGraphicsSubjectIdentity {
char *type
Type of identity
char *name
Identity value
}

virDomainEventID¶

enum virDomainEventID {
VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0
VIR_DOMAIN_EVENT_ID_REBOOT = 1
VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2
VIR_DOMAIN_EVENT_ID_WATCHDOG = 3
VIR_DOMAIN_EVENT_ID_IO_ERROR = 4
VIR_DOMAIN_EVENT_ID_GRAPHICS = 5
VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6
VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7
VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8
VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9
VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10
VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11
VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12
VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13
VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14
VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15
VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16
VIR_DOMAIN_EVENT_ID_TUNABLE = 17
VIR_DOMAIN_EVENT_ID_LAST = 18
NB: this enum value will increase over time as new events are added to the libvirt API. It reflects the last event ID supported by this version of the libvirt API.
}

virDomainEventIOErrorAction¶

enum virDomainEventIOErrorAction {
VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0
No action, IO error ignored
VIR_DOMAIN_EVENT_IO_ERROR_PAUSE = 1
Guest CPUs are paused
VIR_DOMAIN_EVENT_IO_ERROR_REPORT = 2
IO error reported to guest OS
VIR_DOMAIN_EVENT_IO_ERROR_LAST = 3
}

virDomainEventPMSuspendedDetailType¶

enum virDomainEventPMSuspendedDetailType {
VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0
Guest was PM suspended to memory
VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1
Guest was PM suspended to disk
VIR_DOMAIN_EVENT_PMSUSPENDED_LAST = 2
}

virDomainEventResumedDetailType¶

enum virDomainEventResumedDetailType {
VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0
Normal resume due to admin unpause
VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1
Resumed for completion of migration