Module libvirt-domain from libvirt

Provides APIs for the management of domains

Table of Contents

Macros

#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_FLOOR
#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_GROUP_NAME
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX
#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH
#define VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX
#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX
#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH
#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_AUTO_CONVERGE_THROTTLE
#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_DOWNTIME_NET
#define VIR_DOMAIN_JOB_MEMORY_BPS
#define VIR_DOMAIN_JOB_MEMORY_CONSTANT
#define VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE
#define VIR_DOMAIN_JOB_MEMORY_ITERATION
#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_ELAPSED_NET
#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_GLOBAL_PERIOD
#define VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA
#define VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD
#define VIR_DOMAIN_SCHEDULER_IOTHREAD_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_GROUP_NAME
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX
#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH
#define VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX
#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX
#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH
#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_GLOBAL_PERIOD
#define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA
#define VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN
#define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD
#define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_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_AUTO_CONVERGE_INCREMENT
#define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL
#define VIR_MIGRATE_PARAM_BANDWIDTH
#define VIR_MIGRATE_PARAM_COMPRESSION
#define VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS
#define VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL
#define VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS
#define VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE
#define VIR_MIGRATE_PARAM_DEST_NAME
#define VIR_MIGRATE_PARAM_DEST_XML
#define VIR_MIGRATE_PARAM_DISKS_PORT
#define VIR_MIGRATE_PARAM_GRAPHICS_URI
#define VIR_MIGRATE_PARAM_LISTEN_ADDRESS
#define VIR_MIGRATE_PARAM_MIGRATE_DISKS
#define VIR_MIGRATE_PARAM_PERSIST_XML
#define VIR_MIGRATE_PARAM_URI
#define VIR_PERF_PARAM_ALIGNMENT_FAULTS
#define VIR_PERF_PARAM_BRANCH_INSTRUCTIONS
#define VIR_PERF_PARAM_BRANCH_MISSES
#define VIR_PERF_PARAM_BUS_CYCLES
#define VIR_PERF_PARAM_CACHE_MISSES
#define VIR_PERF_PARAM_CACHE_REFERENCES
#define VIR_PERF_PARAM_CMT
#define VIR_PERF_PARAM_CONTEXT_SWITCHES
#define VIR_PERF_PARAM_CPU_CLOCK
#define VIR_PERF_PARAM_CPU_CYCLES
#define VIR_PERF_PARAM_CPU_MIGRATIONS
#define VIR_PERF_PARAM_EMULATION_FAULTS
#define VIR_PERF_PARAM_INSTRUCTIONS
#define VIR_PERF_PARAM_MBML
#define VIR_PERF_PARAM_MBMT
#define VIR_PERF_PARAM_PAGE_FAULTS
#define VIR_PERF_PARAM_PAGE_FAULTS_MAJ
#define VIR_PERF_PARAM_PAGE_FAULTS_MIN
#define VIR_PERF_PARAM_REF_CPU_CYCLES
#define VIR_PERF_PARAM_STALLED_CYCLES_BACKEND
#define VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND
#define VIR_PERF_PARAM_TASK_CLOCK
#define VIR_UNUSE_CPU
#define VIR_USE_CPU
#define _virBlkioParameter
#define _virMemoryParameter
#define _virSchedParameter

Types

typedef struct _virTypedParameter virBlkioParameter
typedef virBlkioParameter * virBlkioParameterPtr
typedef enum virBlkioParameterType
typedef enum virConnectDomainEventAgentLifecycleReason
typedef enum virConnectDomainEventAgentLifecycleState
typedef enum virConnectDomainEventBlockJobStatus
typedef enum virConnectDomainEventDiskChangeReason
typedef enum virConnectGetAllDomainStatsFlags
typedef enum virConnectListAllDomainsFlags
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 enum virDomainControlErrorReason
typedef struct _virDomainControlInfo virDomainControlInfo
typedef virDomainControlInfo * virDomainControlInfoPtr
typedef enum virDomainControlState
typedef enum virDomainCoreDumpFlags
typedef enum virDomainCoreDumpFormat
typedef enum virDomainCrashedReason
typedef enum virDomainCreateFlags
typedef enum virDomainDefineFlags
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 struct _virDomainFSInfo virDomainFSInfo
typedef virDomainFSInfo * virDomainFSInfoPtr
typedef enum virDomainGetJobStatsFlags
typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo
typedef virDomainIOThreadInfo * virDomainIOThreadInfoPtr
typedef struct _virDomainInterfaceIPAddress virDomainIPAddress
typedef virDomainIPAddress * virDomainIPAddressPtr
typedef struct _virDomainInfo virDomainInfo
typedef virDomainInfo * virDomainInfoPtr
typedef struct _virDomainInterface virDomainInterface
typedef enum virDomainInterfaceAddressesSource
typedef virDomainInterface * virDomainInterfacePtr
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 virDomainSetUserPasswordFlags
typedef enum virDomainShutdownFlagValues
typedef enum virDomainShutdownReason
typedef enum virDomainShutoffReason
typedef enum virDomainState
typedef struct _virDomainStatsRecord virDomainStatsRecord
typedef virDomainStatsRecord * virDomainStatsRecordPtr
typedef enum virDomainStatsTypes
typedef enum virDomainUndefineFlagsValues
typedef enum virDomainVcpuFlags
typedef enum virDomainXMLFlags
typedef enum virKeycodeSet
typedef struct _virTypedParameter virMemoryParameter
typedef virMemoryParameter * virMemoryParameterPtr
typedef enum virMemoryParameterType
typedef struct _virTypedParameter virSchedParameter
typedef virSchedParameter * virSchedParameterPtr
typedef enum virSchedParameterType
typedef struct _virVcpuInfo virVcpuInfo
typedef virVcpuInfo * virVcpuInfoPtr
typedef enum virVcpuState

Functions

typedef virConnectDomainEventAgentLifecycleCallback
void	virConnectDomainEventAgentLifecycleCallback	(virConnectPtr conn, 
virDomainPtr dom,
int state,
int reason,
void * opaque) 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 virConnectDomainEventDeviceAddedCallback void virConnectDomainEventDeviceAddedCallback (virConnectPtr conn,
virDomainPtr dom,
const char * devAlias,
void * opaque) typedef virConnectDomainEventDeviceRemovalFailedCallback void virConnectDomainEventDeviceRemovalFailedCallback (virConnectPtr conn,
virDomainPtr dom,
const char * devAlias,
void * opaque) 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 virConnectDomainEventJobCompletedCallback void virConnectDomainEventJobCompletedCallback (virConnectPtr conn,
virDomainPtr dom,
virTypedParameterPtr params,
int nparams,
void * opaque) typedef virConnectDomainEventMetadataChangeCallback void virConnectDomainEventMetadataChangeCallback (virConnectPtr conn,
virDomainPtr dom,
int type,
const char * nsuri,
void * opaque) typedef virConnectDomainEventMigrationIterationCallback void virConnectDomainEventMigrationIterationCallback (virConnectPtr conn,
virDomainPtr dom,
int iteration,
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) int virConnectGetAllDomainStats (virConnectPtr conn,
unsigned int stats,
virDomainStatsRecordPtr ** retStats,
unsigned int flags) char * virConnectGetDomainCapabilities (virConnectPtr conn,
const char * emulatorbin,
const char * arch,
const char * machine,
const char * virttype,
unsigned int flags) int virConnectListAllDomains (virConnectPtr conn,
virDomainPtr ** domains,
unsigned int flags) int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames) int virConnectListDomains (virConnectPtr conn,
int * ids,
int maxids) int virConnectNumOfDefinedDomains (virConnectPtr conn) int virConnectNumOfDomains (virConnectPtr conn) int virDomainAbortJob (virDomainPtr domain) int virDomainAddIOThread (virDomainPtr domain,
unsigned int iothread_id,
unsigned int flags) 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) virDomainPtr virDomainDefineXMLFlags (virConnectPtr conn,
const char * xml,
unsigned int flags) int virDomainDelIOThread (virDomainPtr domain,
unsigned int iothread_id,
unsigned int flags) 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) void virDomainFSInfoFree (virDomainFSInfoPtr info) 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) int virDomainGetFSInfo (virDomainPtr dom,
virDomainFSInfoPtr ** info,
unsigned int flags) int virDomainGetGuestVcpus (virDomainPtr domain,
virTypedParameterPtr * params,
unsigned int * nparams,
unsigned int flags) char * virDomainGetHostname (virDomainPtr domain,
unsigned int flags) unsigned int virDomainGetID (virDomainPtr domain) int virDomainGetIOThreadInfo (virDomainPtr dom,
virDomainIOThreadInfoPtr ** info,
unsigned int flags) 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 virDomainGetPerfEvents (virDomainPtr domain,
virTypedParameterPtr * params,
int * nparams,
unsigned int flags) 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 virDomainHasManagedSaveImage (virDomainPtr dom,
unsigned int flags) void virDomainIOThreadInfoFree (virDomainIOThreadInfoPtr info) int virDomainInjectNMI (virDomainPtr domain,
unsigned int flags) int virDomainInterfaceAddresses (virDomainPtr dom,
virDomainInterfacePtr ** ifaces,
unsigned int source,
unsigned int flags) void virDomainInterfaceFree (virDomainInterfacePtr iface) 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 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 virDomainMigrateStartPostCopy (virDomainPtr domain,
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 virDomainPinIOThread (virDomainPtr domain,
unsigned int iothread_id,
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 virDomainRename (virDomainPtr dom,
const char * new_name,
unsigned int flags) 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 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 virDomainSetGuestVcpus (virDomainPtr domain,
const char * cpumap,
int state,
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 virDomainSetPerfEvents (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 virDomainSetUserPassword (virDomainPtr dom,
const char * user,
const char * password,
unsigned int flags) int virDomainSetVcpu (virDomainPtr domain,
const char * vcpumap,
int state,
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) 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)

Description

Macros

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_FLOOR

#define VIR_DOMAIN_BANDWIDTH_IN_FLOOR

Macro represents the inbound floor 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_GROUP_NAME

#define VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME

Macro for the BlockIoTune tunable weight: it represents a group name to allow sharing of I/O throttling quota between multiple drives, as a string.

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_BYTES_SEC_MAX

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX

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

VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH

Macro for the BlockIoTune tunable weight: it represents the duration in seconds for the burst allowed by read_bytes_sec_max, 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_READ_IOPS_SEC_MAX

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX

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

VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH

Macro for the BlockIoTune tunable weight: it represents the duration in seconds for the burst allowed by read_iops_sec_max, as a ullong.

VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC

Macro for the BlockIoTune tunable weight: it represents the size 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_BYTES_SEC_MAX

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX

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

VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH

Macro for the BlockIoTune tunable weight: it represents the duration in seconds for the burst allowed by total_bytes_sec_max, 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_TOTAL_IOPS_SEC_MAX

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX

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

VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH

Macro for the BlockIoTune tunable weight: it represents the duration in seconds for the burst allowed by total_iops_sec_max, 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_BYTES_SEC_MAX

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX

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

VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH

Macro for the BlockIoTune tunable weight: it represents the duration in seconds for the burst allowed by write_bytes_sec_max, 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_IOTUNE_WRITE_IOPS_SEC_MAX

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX

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

VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH

Macro for the BlockIoTune tunable weight: it represents the duration in seconds for the burst allowed by write_iops_sec_max, 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_AUTO_CONVERGE_THROTTLE

#define VIR_DOMAIN_JOB_AUTO_CONVERGE_THROTTLE

virDomainGetJobStats field: current percentage guest CPUs are throttled to when auto-convergence decided migration was not converging, as VIR_TYPED_PARAM_INT.

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. The real computed downtime between the time guest CPUs were paused and the time they were resumed is reported for completed migration.

VIR_DOMAIN_JOB_DOWNTIME_NET

#define VIR_DOMAIN_JOB_DOWNTIME_NET

virDomainGetJobStats field: real measured downtime (ms) NOT including the time required to transfer control flow from the source host to the destination host, 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_DIRTY_RATE

#define VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE

virDomainGetJobStats field: number of memory pages dirtied by the guest per second, as VIR_TYPED_PARAM_ULLONG. This statistics makes sense only when live migration is running.

VIR_DOMAIN_JOB_MEMORY_ITERATION

#define VIR_DOMAIN_JOB_MEMORY_ITERATION

virDomainGetJobStats field: current iteration over domain's memory during live migration, as VIR_TYPED_PARAM_ULLONG. This is set to zero when memory starts to be transferred and the value is increased by one every time a new iteration is started to transfer memory pages dirtied since the last iteration.

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_ELAPSED_NET

#define VIR_DOMAIN_JOB_TIME_ELAPSED_NET

virDomainGetJobStats field: time (ms) since the beginning of the migration job NOT including the time required to transfer control flow from the source host to the destination host, as VIR_TYPED_PARAM_ULLONG.

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_GLOBAL_PERIOD

#define VIR_DOMAIN_SCHEDULER_GLOBAL_PERIOD

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

VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA

#define VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA

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

VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD

#define VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD

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

VIR_DOMAIN_SCHEDULER_IOTHREAD_QUOTA

#define VIR_DOMAIN_SCHEDULER_IOTHREAD_QUOTA

Macro represents the maximum bandwidth to be used within a period for IOThreads only, 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_GROUP_NAME

#define VIR_DOMAIN_TUNABLE_BLKDEV_GROUP_NAME

Macro represents the group name to be used, as VIR_TYPED_PARAM_STRING.

VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC

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

VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX

Macro represents the read throughput limit during bursts in maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH

Macro represents the length in seconds allowed for a burst period for the blkdeviotune.read_bytes_sec_max 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_READ_IOPS_SEC_MAX

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX

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

VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH

Macro represents the length in seconds allowed for a burst period for the blkdeviotune.read_iops_sec_max as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC

Macro represents the size maximum 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

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

VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX

Macro represents the total throughput limit during bursts in maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.

VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH

Macro represents the length in seconds allowed for a burst period for the blkdeviotune.total_bytes_sec_max, 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_TOTAL_IOPS_SEC_MAX

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX

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

VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH

Macro represents the length in seconds allowed for a burst period for the blkdeviotune.total_iops_sec_max 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_BYTES_SEC_MAX

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX

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

VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH

Macro represents the length in seconds allowed for a burst period for the blkdeviotune.write_bytes_sec_max 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_BLKDEV_WRITE_IOPS_SEC_MAX

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX

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

VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH

Macro represents the length in seconds allowed for a burst period for the blkdeviotune.write_iops_sec_max 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_GLOBAL_PERIOD

#define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_PERIOD

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

VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA

#define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA

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

VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN

#define VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN

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

VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD

#define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD

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

VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_QUOTA

#define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_QUOTA

Macro represents the maximum bandwidth to be used within a period for iothreads only, when using the posix scheduler, as 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_AUTO_CONVERGE_INCREMENT

#define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT

virDomainMigrate* params field: the increment added to VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL whenever the hypervisor decides the current rate is not enough to ensure convergence of the migration. As VIR_TYPED_PARAM_INT.

VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL

#define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL

virDomainMigrate* params field: the initial percentage guest CPUs are throttled to when auto-convergence decides migration is not converging. As VIR_TYPED_PARAM_INT.

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_COMPRESSION

#define VIR_MIGRATE_PARAM_COMPRESSION

virDomainMigrate* params multiple field: name of the method used to compress migration traffic. Supported compression methods: xbzrle, mt. The parameter may be specified multiple times if more than one method should be used.

VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS

#define VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS

virDomainMigrate* params field: the number of decompression threads for multithread compression as VIR_TYPED_PARAM_INT.

VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL

#define VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL

virDomainMigrate* params field: the level of compression for multithread compression as VIR_TYPED_PARAM_INT. Accepted values are in range 0-9. 0 is no compression, 1 is maximum speed and 9 is maximum compression.

VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS

#define VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS

virDomainMigrate* params field: the number of compression threads for multithread compression as VIR_TYPED_PARAM_INT.

VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE

#define VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE

virDomainMigrate* params field: the size of page cache for xbzrle compression as VIR_TYPED_PARAM_ULLONG.

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_DISKS_PORT

#define VIR_MIGRATE_PARAM_DISKS_PORT

virDomainMigrate* params field: port that destination server should use for incoming disks migration. Type is VIR_TYPED_PARAM_INT. If set to 0 or omitted, libvirt will choose a suitable default. At the moment this is only supported by the QEMU driver.

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_MIGRATE_DISKS

#define VIR_MIGRATE_PARAM_MIGRATE_DISKS

virDomainMigrate* params multiple field: The multiple values that list the block devices to be migrated. At the moment this is only supported by the QEMU driver but not for the tunnelled migration.

VIR_MIGRATE_PARAM_PERSIST_XML

#define VIR_MIGRATE_PARAM_PERSIST_XML

virDomainMigrate* params field: the new persistent configuration to be used for the domain on the destination host as VIR_TYPED_PARAM_STRING. 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 persistent configuration. Using this field with hypervisors that do not support changing domain configuration during migration will result in a failure.

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_PERF_PARAM_ALIGNMENT_FAULTS

#define VIR_PERF_PARAM_ALIGNMENT_FAULTS

Macro for typed parameter name that represents alignment_faults perf event which can be used to measure the count of alignment faults by applications running on the platform. It corresponds to the "perf.alignment_faults" field in the *Stats APIs.

VIR_PERF_PARAM_BRANCH_INSTRUCTIONS

#define VIR_PERF_PARAM_BRANCH_INSTRUCTIONS

Macro for typed parameter name that represents branch_instructions perf event which can be used to measure the count of branch instructions by applications running on the platform. It corresponds to the "perf.branch_instructions" field in the *Stats APIs.

VIR_PERF_PARAM_BRANCH_MISSES

#define VIR_PERF_PARAM_BRANCH_MISSES

Macro for typed parameter name that represents branch_misses perf event which can be used to measure the count of branch misses by applications running on the platform. It corresponds to the "perf.branch_misses" field in the *Stats APIs.

VIR_PERF_PARAM_BUS_CYCLES

#define VIR_PERF_PARAM_BUS_CYCLES

Macro for typed parameter name that represents bus_cycles perf event which can be used to measure the count of bus cycles by applications running on the platform. It corresponds to the "perf.bus_cycles" field in the *Stats APIs.

VIR_PERF_PARAM_CACHE_MISSES

#define VIR_PERF_PARAM_CACHE_MISSES

Macro for typed parameter name that represents cache_misses perf event which can be used to measure the count of cache misses by applications running on the platform. It corresponds to the "perf.cache_misses" field in the *Stats APIs.

VIR_PERF_PARAM_CACHE_REFERENCES

#define VIR_PERF_PARAM_CACHE_REFERENCES

Macro for typed parameter name that represents cache_references perf event which can be used to measure the count of cache hits by applications running on the platform. It corresponds to the "perf.cache_references" field in the *Stats APIs.

VIR_PERF_PARAM_CMT

#define VIR_PERF_PARAM_CMT

Macro for typed parameter name that represents CMT perf event which can be used to measure the usage of cache (bytes) by applications running on the platform. It corresponds to the "perf.cmt" field in the *Stats APIs.

VIR_PERF_PARAM_CONTEXT_SWITCHES

#define VIR_PERF_PARAM_CONTEXT_SWITCHES

Macro for typed parameter name that represents context_switches perf event which can be used to measure the count of context switches by applications running on the platform. It corresponds to the "perf.context_switches" field in the *Stats APIs.

VIR_PERF_PARAM_CPU_CLOCK

#define VIR_PERF_PARAM_CPU_CLOCK

Macro for typed parameter name that represents cpu_clock perf event which can be used to measure the count of cpu clock time by applications running on the platform. It corresponds to the "perf.cpu_clock" field in the *Stats APIs.

VIR_PERF_PARAM_CPU_CYCLES

#define VIR_PERF_PARAM_CPU_CYCLES

Macro for typed parameter name that represents cpu_cycles perf event describing the total/elapsed cpu cycles. This can be used to measure how many cpu cycles one instruction needs. It corresponds to the "perf.cpu_cycles" field in the *Stats APIs.

VIR_PERF_PARAM_CPU_MIGRATIONS

#define VIR_PERF_PARAM_CPU_MIGRATIONS

Macro for typed parameter name that represents cpu_migrations perf event which can be used to measure the count of cpu migrations by applications running on the platform. It corresponds to the "perf.cpu_migrations" field in the *Stats APIs.

VIR_PERF_PARAM_EMULATION_FAULTS

#define VIR_PERF_PARAM_EMULATION_FAULTS

Macro for typed parameter name that represents emulation_faults perf event which can be used to measure the count of emulation faults by applications running on the platform. It corresponds to the "perf.emulation_faults" field in the *Stats APIs.

VIR_PERF_PARAM_INSTRUCTIONS

#define VIR_PERF_PARAM_INSTRUCTIONS

Macro for typed parameter name that represents instructions perf event which can be used to measure the count of instructions by applications running on the platform. It corresponds to the "perf.instructions" field in the *Stats APIs.

VIR_PERF_PARAM_MBML

#define VIR_PERF_PARAM_MBML

Macro for typed parameter name that represents MBML perf event which can be used to monitor the amount of data (bytes/s) sent through the memory controller on the socket. It corresponds to the "perf.mbml" field in the *Stats APIs.

VIR_PERF_PARAM_MBMT

#define VIR_PERF_PARAM_MBMT

Macro for typed parameter name that represents MBMT perf event which can be used to monitor total system bandwidth (bytes/s) from one level of cache to another. It corresponds to the "perf.mbmt" field in the *Stats APIs.

VIR_PERF_PARAM_PAGE_FAULTS

#define VIR_PERF_PARAM_PAGE_FAULTS

Macro for typed parameter name that represents page_faults perf event which can be used to measure the count of page faults by applications running on the platform. It corresponds to the "perf.page_faults" field in the *Stats APIs.

VIR_PERF_PARAM_PAGE_FAULTS_MAJ

#define VIR_PERF_PARAM_PAGE_FAULTS_MAJ

Macro for typed parameter name that represents page_faults_maj perf event which can be used to measure the count of major page faults by applications running on the platform. It corresponds to the "perf.page_faults_maj" field in the *Stats APIs.

VIR_PERF_PARAM_PAGE_FAULTS_MIN

#define VIR_PERF_PARAM_PAGE_FAULTS_MIN

Macro for typed parameter name that represents page_faults_min perf event which can be used to measure the count of minor page faults by applications running on the platform. It corresponds to the "perf.page_faults_min" field in the *Stats APIs.

VIR_PERF_PARAM_REF_CPU_CYCLES

#define VIR_PERF_PARAM_REF_CPU_CYCLES

Macro for typed parameter name that represents ref_cpu_cycles perf event which can be used to measure the count of total cpu cycles not affected by CPU frequency scaling by applications running on the platform. It corresponds to the "perf.ref_cpu_cycles" field in the *Stats APIs.

VIR_PERF_PARAM_STALLED_CYCLES_BACKEND

#define VIR_PERF_PARAM_STALLED_CYCLES_BACKEND

Macro for typed parameter name that represents stalled_cycles_backend perf event which can be used to measure the count of stalled cpu cycles in the backend of the instruction processor pipeline by application running on the platform. It corresponds to the "perf.stalled_cycles_backend" field in the *Stats APIs.

VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND

#define VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND

Macro for typed parameter name that represents stalled_cycles_frontend perf event which can be used to measure the count of stalled cpu cycles in the frontend of the instruction processor pipeline by applications running on the platform. It corresponds to the "perf.stalled_cycles_frontend" field in the *Stats APIs.

VIR_PERF_PARAM_TASK_CLOCK

#define VIR_PERF_PARAM_TASK_CLOCK

Macro for typed parameter name that represents task_clock perf event which can be used to measure the count of task clock time by applications running on the platform. It corresponds to the "perf.task_clock" field in the *Stats APIs.

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.

_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
}

virConnectDomainEventAgentLifecycleReason

virConnectDomainEventAgentLifecycleState

virConnectDomainEventBlockJobStatus

virConnectDomainEventDiskChangeReason

enum virConnectDomainEventDiskChangeReason {
VIR_DOMAIN_EVENT_DISK_CHANGE_MISSING_ON_START = 0
removable media changed to empty according to startup policy as source was missing. oldSrcPath is set, newSrcPath is NULL
VIR_DOMAIN_EVENT_DISK_DROP_MISSING_ON_START = 1
disk was dropped from domain as source file was missing. oldSrcPath is set, newSrcPath is NULL
VIR_DOMAIN_EVENT_DISK_CHANGE_LAST = 2
}

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_BACKING = 1073741824
include backing chain for block stats
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 2147483648
enforce requested stats
}

virConnectListAllDomainsFlags

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 image (how much storage the guest will see)
unsigned long longallocation
host storage in bytes occupied by the image (such as highest allocated extent if there are no holes, similar to 'du')
unsigned long longphysical
host physical size in bytes of the image container (last offset, similar to 'ls'
}

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
}

virDomainControlErrorReason

enum virDomainControlErrorReason {
VIR_DOMAIN_CONTROL_ERROR_REASON_NONE = 0
server didn't provide a reason
VIR_DOMAIN_CONTROL_ERROR_REASON_UNKNOWN = 1
unknown reason for the error
VIR_DOMAIN_CONTROL_ERROR_REASON_MONITOR = 2
monitor connection is broken
VIR_DOMAIN_CONTROL_ERROR_REASON_INTERNAL = 3
error caused due to internal failure in libvirt
VIR_DOMAIN_CONTROL_ERROR_REASON_LAST = 4
}

virDomainControlInfo

struct virDomainControlInfo {
unsigned intstate
control state, one of virDomainControlState
unsigned intdetails
state details, currently 0 except for ERROR state (one of virDomainControlErrorReason)
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, possible reason is provided in the details field
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
VIR_DOMAIN_START_VALIDATE = 16
Validate the XML document against schema
}

virDomainDefineFlags

enum virDomainDefineFlags {
VIR_DOMAIN_DEFINE_VALIDATE = 1
Validate the XML document against schema
}

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_RENAMED = 2
Domain was renamed
VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3
Config was restored from a snapshot
VIR_DOMAIN_EVENT_DEFINED_LAST = 4
}

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_AGENT_LIFECYCLE = 18
VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19
VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20
VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21
VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22
VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23
VIR_DOMAIN_EVENT_ID_LAST = 24
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
VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2
Resumed from snapshot
VIR_DOMAIN_EVENT_RESUMED_POSTCOPY = 3
Resumed, but migration is still running in post-copy mode
VIR_DOMAIN_EVENT_RESUMED_LAST = 4
}

virDomainEventShutdownDetailType

enum virDomainEventShutdownDetailType {
VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED = 0
Guest finished shutdown sequence
VIR_DOMAIN_EVENT_SHUTDOWN_LAST = 1
}

virDomainEventStartedDetailType

enum virDomainEventStartedDetailType {
VIR_DOMAIN_EVENT_STARTED_BOOTED = 0
Normal startup from boot
VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1
Incoming migration from another host
VIR_DOMAIN_EVENT_STARTED_RESTORED = 2
Restored from a state file
VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3
Restored from snapshot
VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4
Started due to wakeup event
VIR_DOMAIN_EVENT_STARTED_LAST = 5
}

virDomainEventStoppedDetailType

enum virDomainEventStoppedDetailType {
VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0
Normal shutdown
VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1
Forced poweroff from host
VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2
Guest crashed
VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3
Migrated off to another host
VIR_DOMAIN_EVENT_STOPPED_SAVED = 4
Saved to a state file
VIR_DOMAIN_EVENT_STOPPED_FAILED = 5
Host emulator/mgmt failed
VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6
offline snapshot loaded
VIR_DOMAIN_EVENT_STOPPED_LAST = 7
}

virDomainEventSuspendedDetailType

enum virDomainEventSuspendedDetailType {
VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0
Normal suspend due to admin pause
VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1
Suspended for offline migration
VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2
Suspended due to a disk I/O error
VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3
Suspended due to a watchdog firing
VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4
Restored from paused state file
VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5
Restored from paused snapshot
VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6
suspended after failure during libvirt API call
VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7
suspended for post-copy migration
VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8
suspended after failed post-copy
VIR_DOMAIN_EVENT_SUSPENDED_LAST = 9
}

virDomainEventTrayChangeReason

virDomainEventType

virDomainEventUndefinedDetailType

enum virDomainEventUndefinedDetailType {
VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0
Deleted the config file
VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1
Domain was renamed
VIR_DOMAIN_EVENT_UNDEFINED_LAST = 2
}

virDomainEventWatchdogAction

enum virDomainEventWatchdogAction {
VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0
No action, watchdog ignored
VIR_DOMAIN_EVENT_WATCHDOG_PAUSE = 1
Guest CPUs are paused
VIR_DOMAIN_EVENT_WATCHDOG_RESET = 2
Guest CPUs are reset
VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF = 3
Guest is forcibly powered off
VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN = 4
Guest is requested to gracefully shutdown
VIR_DOMAIN_EVENT_WATCHDOG_DEBUG = 5
No action, a debug message logged
VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI = 6
Inject a non-maskable interrupt into guest
VIR_DOMAIN_EVENT_WATCHDOG_LAST = 7
}

virDomainFSInfo

struct virDomainFSInfo {
char *mountpoint
path to mount point
char *name
device name in the guest (e.g. "sda1")
char *fstype
filesystem type
size_tndevAlias
number of elements in devAlias
char **devAlias
array of disk device aliases
}

virDomainGetJobStatsFlags

enum virDomainGetJobStatsFlags {
VIR_DOMAIN_JOB_STATS_COMPLETED = 1
return stats of a recently completed job
}

virDomainIOThreadInfo

struct virDomainIOThreadInfo {
unsigned intiothread_id
IOThread ID
unsigned char *cpumap
CPU map for thread. A pointer to an array of real CPUs (in 8-bit bytes)
intcpumaplen
cpumap size
}

virDomainIPAddress

struct virDomainIPAddress {
inttype
char *addr
IP address
unsigned intprefix
IP address prefix
}

virDomainInfo

struct virDomainInfo {
unsigned charstate
the running state, one of virDomainState
unsigned longmaxMem
the maximum memory in KBytes allowed
unsigned longmemory
the memory in KBytes used by the domain
unsigned shortnrVirtCpu
the number of virtual CPUs for the domain
unsigned long longcpuTime
the CPU time used in nanoseconds
}

virDomainInterface

struct virDomainInterface {
char *name
interface name
char *hwaddr
hardware address, may be NULL
unsigned intnaddrs
number of items in @addrs
virDomainIPAddressPtraddrs
array of IP addresses
}

virDomainInterfaceAddressesSource

enum virDomainInterfaceAddressesSource {
VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0
Parse DHCP lease file
VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1
Query qemu guest agent
VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST = 2
}

virDomainInterfaceStatsStruct

struct virDomainInterfaceStatsStruct {
long longrx_bytes
long longrx_packets
long longrx_errs
long longrx_drop
long longtx_bytes
long longtx_packets
long longtx_errs
long longtx_drop
}

virDomainJobInfo

struct virDomainJobInfo {
inttype
Time is measured in milliseconds
unsigned long longtimeElapsed
Always set
unsigned long longtimeRemaining
Only for VIR_DOMAIN_JOB_BOUNDED Data is measured in bytes unless otherwise specified and is measuring the job as a whole. For VIR_DOMAIN_JOB_UNBOUNDED, dataTotal may be less than the final sum of dataProcessed + dataRemaining in the event that the hypervisor has to repeat some data, such as due to dirtied pages during migration. For VIR_DOMAIN_JOB_BOUNDED, dataTotal shall always equal the sum of dataProcessed + dataRemaining.
unsigned long longdataTotal
unsigned long longdataProcessed
unsigned long longdataRemaining
As above, but only tracking guest memory progress
unsigned long longmemTotal
unsigned long longmemProcessed
unsigned long longmemRemaining
As above, but only tracking guest disk file progress
unsigned long longfileTotal
unsigned long longfileProcessed
unsigned long longfileRemaining
}

virDomainJobType

enum virDomainJobType {
VIR_DOMAIN_JOB_NONE = 0
No job is active
VIR_DOMAIN_JOB_BOUNDED = 1
Job with a finite completion time
VIR_DOMAIN_JOB_UNBOUNDED = 2
Job without a finite completion time
VIR_DOMAIN_JOB_COMPLETED = 3
Job has finished, but isn't cleaned up
VIR_DOMAIN_JOB_FAILED = 4
Job hit error, but isn't cleaned up
VIR_DOMAIN_JOB_CANCELLED = 5
Job was aborted, but isn't cleaned up
VIR_DOMAIN_JOB_LAST = 6
}

virDomainMemoryFlags

enum virDomainMemoryFlags {
VIR_MEMORY_VIRTUAL = 1
addresses are virtual addresses
VIR_MEMORY_PHYSICAL = 2
addresses are physical addresses
}

virDomainMemoryModFlags

enum virDomainMemoryModFlags {
VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG
Additionally, these flags may be bitwise-OR'd in.
VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT
VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE
VIR_DOMAIN_MEM_MAXIMUM = 4
affect Max rather than current
}

virDomainMemoryStatStruct

struct virDomainMemoryStatStruct {
inttag
unsigned long longval
}

virDomainMemoryStatTags

enum virDomainMemoryStatTags {
VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR
VIR_DOMAIN_MEMORY_STAT_SWAP_IN = 0
The total amount of memory written out to swap space (in kB).
VIR_DOMAIN_MEMORY_STAT_SWAP_OUT = 1
Page faults occur when a process makes a valid access to virtual memory that is not available. When servicing the page fault, if disk IO is required, it is considered a major fault. If not, it is a minor fault. These are expressed as the number of faults that have occurred.
VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT = 2
VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT = 3
The amount of memory left completely unused by the system. Memory that is available but used for reclaimable caches should NOT be reported as free. This value is expressed in kB.
VIR_DOMAIN_MEMORY_STAT_UNUSED = 4
The total amount of usable memory as seen by the domain. This value may be less than the amount of memory assigned to the domain if a balloon driver is in use or if the guest OS does not initialize all assigned pages. This value is expressed in kB.
VIR_DOMAIN_MEMORY_STAT_AVAILABLE = 5
Current balloon value (in KB).
VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON = 6
Resident Set Size of the process running the domain. This value is in kB
VIR_DOMAIN_MEMORY_STAT_RSS = 7
How much the balloon can be inflated without pushing the guest system to swap, corresponds to 'Available' in /proc/meminfo
VIR_DOMAIN_MEMORY_STAT_USABLE = 8
Timestamp of the last update of statistics, in seconds.
VIR_DOMAIN_MEMORY_STAT_LAST_UPDATE = 9
The number of statistics supported by this version of the interface. To add new statistics, add them to the enum and increase this value.
VIR_DOMAIN_MEMORY_STAT_NR = 10
}

virDomainMetadataType

enum virDomainMetadataType {
VIR_DOMAIN_METADATA_DESCRIPTION = 0
Operate on <description>
VIR_DOMAIN_METADATA_TITLE = 1
Operate on <title>
VIR_DOMAIN_METADATA_ELEMENT = 2
Operate on <metadata>
VIR_DOMAIN_METADATA_LAST = 3
}

virDomainMigrateFlags

enum virDomainMigrateFlags {
VIR_MIGRATE_LIVE = 1
Tell the source libvirtd to connect directly to the destination host. Without this flag the client (e.g., virsh) connects to both hosts and controls the migration process. In peer-to-peer mode, the source libvirtd controls the migration by calling the destination daemon directly.
VIR_MIGRATE_PEER2PEER = 2
Tunnel migration data over libvirtd connection. Without this flag the source hypervisor sends migration data directly to the destination hypervisor. This flag can only be used when VIR_MIGRATE_PEER2PEER is set as well. Note the less-common spelling that we're stuck with: VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED.
VIR_MIGRATE_TUNNELLED = 4
Define the domain as persistent on the destination host after successful migration. If the domain was persistent on the source host and VIR_MIGRATE_UNDEFINE_SOURCE is not used, it will end up persistent on both hosts.
VIR_MIGRATE_PERSIST_DEST = 8
Undefine the domain on the source host once migration successfully finishes.
VIR_MIGRATE_UNDEFINE_SOURCE = 16
Leave the domain suspended on the destination host. virDomainResume (on the virDomainPtr returned by the migration API) has to be called explicitly to resume domain's virtual CPUs.
VIR_MIGRATE_PAUSED = 32
Migrate full disk images in addition to domain's memory. By default only non-shared non-readonly disk images are transferred. The VIR_MIGRATE_PARAM_MIGRATE_DISKS parameter can be used to specify which disks should be migrated. This flag and VIR_MIGRATE_NON_SHARED_INC are mutually exclusive.
VIR_MIGRATE_NON_SHARED_DISK = 64
Migrate disk images in addition to domain's memory. This is similar to VIR_MIGRATE_NON_SHARED_DISK, but only the top level of each disk's backing chain is copied. That is, the rest of the backing chain is expected to be present on the destination and to be exactly the same as on the source host. This flag and VIR_MIGRATE_NON_SHARED_DISK are mutually exclusive.
VIR_MIGRATE_NON_SHARED_INC = 128
Protect against domain configuration changes during the migration process. This flag is used automatically when both sides support it. Explicitly setting this flag will cause migration to fail if either the source or the destination does not support it.
VIR_MIGRATE_CHANGE_PROTECTION = 256
Force migration even if it is considered unsafe. In some cases libvirt may refuse to migrate the domain because doing so may lead to potential problems such as data corruption, and thus the migration is considered unsafe. For a QEMU domain this may happen if the domain uses disks without explicitly setting cache mode to "none". Migrating such domains is unsafe unless the disk images are stored on coherent clustered filesystem, such as GFS2 or GPFS.
VIR_MIGRATE_UNSAFE = 512
Migrate a domain definition without starting the domain on the destination and without stopping it on the source host. Offline migration requires VIR_MIGRATE_PERSIST_DEST to be set. Offline migration may not copy disk storage or any other file based storage (such as UEFI variables).
VIR_MIGRATE_OFFLINE = 1024
Compress migration data. The compression methods can be specified using VIR_MIGRATE_PARAM_COMPRESSION. A hypervisor default method will be used if this parameter is omitted. Individual compression methods can be tuned via their specific VIR_MIGRATE_PARAM_COMPRESSION_* parameters.
VIR_MIGRATE_COMPRESSED = 2048
Cancel migration if a soft error (such as I/O error) happens during migration.
VIR_MIGRATE_ABORT_ON_ERROR = 4096
Enable algorithms that ensure a live migration will eventually converge. This usually means the domain will be slowed down to make sure it does not change its memory faster than a hypervisor can transfer the changed memory to the destination host. VIR_MIGRATE_PARAM_AUTO_CONVERGE_* parameters can be used to tune the algorithm.
VIR_MIGRATE_AUTO_CONVERGE = 8192
This flag can be used with RDMA migration (i.e., when VIR_MIGRATE_PARAM_URI starts with "rdma://") to tell the hypervisor to pin all domain's memory at once before migration starts rather then letting it pin memory pages as needed. This means that all memory pages belonging to the domain will be locked in host's memory and the host will not be allowed to swap them out. For QEMU/KVM this requires hard_limit memory tuning element (in the domain XML) to be used and set to the maximum memory configured for the domain plus any memory consumed by the QEMU process itself. Beware of setting the memory limit too high (and thus allowing the domain to lock most of the host's memory). Doing so may be dangerous to both the domain and the host itself since the host's kernel may run out of memory.
VIR_MIGRATE_RDMA_PIN_ALL = 16384
Setting the VIR_MIGRATE_POSTCOPY flag tells libvirt to enable post-copy migration. However, the migration will start normally and virDomainMigrateStartPostCopy needs to be called to switch it into the post-copy mode. See virDomainMigrateStartPostCopy for more details.
VIR_MIGRATE_POSTCOPY = 32768
}

virDomainModificationImpact

enum virDomainModificationImpact {
VIR_DOMAIN_AFFECT_CURRENT = 0
Affect current domain state.
VIR_DOMAIN_AFFECT_LIVE = 1
Affect running domain state.
VIR_DOMAIN_AFFECT_CONFIG = 2
Affect persistent domain state. 1 << 2 is reserved for virTypedParameterFlags
}

virDomainNostateReason

enum virDomainNostateReason {
VIR_DOMAIN_NOSTATE_UNKNOWN = 0
VIR_DOMAIN_NOSTATE_LAST = 1
}

virDomainNumatuneMemMode

enum virDomainNumatuneMemMode {
VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0
VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1
VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2
VIR_DOMAIN_NUMATUNE_MEM_LAST = 3
This constant is subject to change
}

virDomainOpenGraphicsFlags

enum virDomainOpenGraphicsFlags {
VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = 1
}

virDomainPMSuspendedDiskReason

enum virDomainPMSuspendedDiskReason {
VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0
VIR_DOMAIN_PMSUSPENDED_DISK_LAST = 1
}

virDomainPMSuspendedReason

enum virDomainPMSuspendedReason {
VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0
VIR_DOMAIN_PMSUSPENDED_LAST = 1
}

virDomainPausedReason

enum virDomainPausedReason {
VIR_DOMAIN_PAUSED_UNKNOWN = 0
the reason is unknown
VIR_DOMAIN_PAUSED_USER = 1
paused on user request
VIR_DOMAIN_PAUSED_MIGRATION = 2
paused for offline migration
VIR_DOMAIN_PAUSED_SAVE = 3
paused for save
VIR_DOMAIN_PAUSED_DUMP = 4
paused for offline core dump
VIR_DOMAIN_PAUSED_IOERROR = 5
paused due to a disk I/O error
VIR_DOMAIN_PAUSED_WATCHDOG = 6
paused due to a watchdog event
VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7
paused after restoring from snapshot
VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8
paused during shutdown process
VIR_DOMAIN_PAUSED_SNAPSHOT = 9
paused while creating a snapshot
VIR_DOMAIN_PAUSED_CRASHED = 10
paused due to a guest crash
VIR_DOMAIN_PAUSED_STARTING_UP = 11
the domain is being started
VIR_DOMAIN_PAUSED_POSTCOPY = 12
paused for post-copy migration
VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13
paused after failed post-copy
VIR_DOMAIN_PAUSED_LAST = 14
}

virDomainProcessSignal

enum virDomainProcessSignal {
VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0
No constant in POSIX/Linux
VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1
SIGHUP
VIR_DOMAIN_PROCESS_SIGNAL_INT = 2
SIGINT
VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3
SIGQUIT
VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4
SIGILL
VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5
SIGTRAP
VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6
SIGABRT
VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7
SIGBUS
VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8
SIGFPE
VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9
SIGKILL
VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10
SIGUSR1
VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11
SIGSEGV
VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12
SIGUSR2
VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13
SIGPIPE
VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14
SIGALRM
VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15
SIGTERM
VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16
Not in POSIX (SIGSTKFLT on Linux
VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17
SIGCHLD
VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18
SIGCONT
VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19
SIGSTOP
VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20
SIGTSTP
VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21
SIGTTIN
VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22
SIGTTOU
VIR_DOMAIN_PROCESS_SIGNAL_URG = 23
SIGURG
VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24
SIGXCPU
VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25
SIGXFSZ
VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26
SIGVTALRM
VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27
SIGPROF
VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28
Not in POSIX (SIGWINCH on Linux)
VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29
SIGPOLL (also known as SIGIO on Linux)
VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30
Not in POSIX (SIGPWR on Linux)
VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31
SIGSYS (also known as SIGUNUSED on Linux)
VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32
SIGRTMIN
VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33
SIGRTMIN + 1
VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34
SIGRTMIN + 2
VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35
SIGRTMIN + 3
VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36
SIGRTMIN + 4
VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37
SIGRTMIN + 5
VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38
SIGRTMIN + 6
VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39
SIGRTMIN + 7
VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40
SIGRTMIN + 8
VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41
SIGRTMIN + 9
VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42
SIGRTMIN + 10
VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43
SIGRTMIN + 11
VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44
SIGRTMIN + 12
VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45
SIGRTMIN + 13
VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46
SIGRTMIN + 14
VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47
SIGRTMIN + 15
VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48
SIGRTMIN + 16
VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49
SIGRTMIN + 17
VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50
SIGRTMIN + 18
VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51
SIGRTMIN + 19
VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52
SIGRTMIN + 20
VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53
SIGRTMIN + 21
VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54
SIGRTMIN + 22
VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55
SIGRTMIN + 23
VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56
SIGRTMIN + 24
VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57
SIGRTMIN + 25
VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58
SIGRTMIN + 26
VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59
SIGRTMIN + 27
VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60
SIGRTMIN + 28
VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61
SIGRTMIN + 29
VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62
SIGRTMIN + 30
VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63
SIGRTMIN + 31
VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64
SIGRTMIN + 32 / SIGRTMAX
VIR_DOMAIN_PROCESS_SIGNAL_LAST = 65
}

virDomainRebootFlagValues

enum virDomainRebootFlagValues {
VIR_DOMAIN_REBOOT_DEFAULT = 0
hypervisor choice
VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = 1
Send ACPI event
VIR_DOMAIN_REBOOT_GUEST_AGENT = 2
Use guest agent
VIR_DOMAIN_REBOOT_INITCTL = 4
Use initctl
VIR_DOMAIN_REBOOT_SIGNAL = 8
Send a signal
VIR_DOMAIN_REBOOT_PARAVIRT = 16
Use paravirt guest control
}

virDomainRunningReason

enum virDomainRunningReason {
VIR_DOMAIN_RUNNING_UNKNOWN = 0
VIR_DOMAIN_RUNNING_BOOTED = 1
normal startup from boot
VIR_DOMAIN_RUNNING_MIGRATED = 2
migrated from another host
VIR_DOMAIN_RUNNING_RESTORED = 3
restored from a state file
VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4
restored from snapshot
VIR_DOMAIN_RUNNING_UNPAUSED = 5
returned from paused state
VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6
returned from migration
VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7
returned from failed save process
VIR_DOMAIN_RUNNING_WAKEUP = 8
returned from pmsuspended due to wakeup event
VIR_DOMAIN_RUNNING_CRASHED = 9
resumed from crashed
VIR_DOMAIN_RUNNING_POSTCOPY = 10
running in post-copy migration mode
VIR_DOMAIN_RUNNING_LAST = 11
}

virDomainSaveRestoreFlags

enum virDomainSaveRestoreFlags {
VIR_DOMAIN_SAVE_BYPASS_CACHE = 1
Avoid file system cache pollution
VIR_DOMAIN_SAVE_RUNNING = 2
Favor running over paused
VIR_DOMAIN_SAVE_PAUSED = 4
Favor paused over running
}

virDomainSetTimeFlags

enum virDomainSetTimeFlags {
VIR_DOMAIN_TIME_SYNC = 1
Re-sync domain time from domain's RTC
}

virDomainSetUserPasswordFlags

enum virDomainSetUserPasswordFlags {
VIR_DOMAIN_PASSWORD_ENCRYPTED = 1
the password is already encrypted
}

virDomainShutdownFlagValues

enum virDomainShutdownFlagValues {
VIR_DOMAIN_SHUTDOWN_DEFAULT = 0
hypervisor choice
VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = 1
Send ACPI event
VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = 2
Use guest agent
VIR_DOMAIN_SHUTDOWN_INITCTL = 4
Use initctl
VIR_DOMAIN_SHUTDOWN_SIGNAL = 8
Send a signal
VIR_DOMAIN_SHUTDOWN_PARAVIRT = 16
Use paravirt guest control
}

virDomainShutdownReason

enum virDomainShutdownReason {
VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0
the reason is unknown
VIR_DOMAIN_SHUTDOWN_USER = 1
shutting down on user request
VIR_DOMAIN_SHUTDOWN_LAST = 2
}

virDomainShutoffReason

enum virDomainShutoffReason {
VIR_DOMAIN_SHUTOFF_UNKNOWN = 0
the reason is unknown
VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1
normal shutdown
VIR_DOMAIN_SHUTOFF_DESTROYED = 2
forced poweroff
VIR_DOMAIN_SHUTOFF_CRASHED = 3
domain crashed
VIR_DOMAIN_SHUTOFF_MIGRATED = 4
migrated to another host
VIR_DOMAIN_SHUTOFF_SAVED = 5
saved to a file
VIR_DOMAIN_SHUTOFF_FAILED = 6
domain failed to start
VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT = 7
restored from a snapshot which was taken while domain was shutoff
VIR_DOMAIN_SHUTOFF_LAST = 8
}

virDomainState

enum virDomainState {
VIR_DOMAIN_NOSTATE = 0
no state
VIR_DOMAIN_RUNNING = 1
the domain is running
VIR_DOMAIN_BLOCKED = 2
the domain is blocked on resource
VIR_DOMAIN_PAUSED = 3
the domain is paused by user
VIR_DOMAIN_SHUTDOWN = 4
the domain is being shut down
VIR_DOMAIN_SHUTOFF = 5
the domain is shut off
VIR_DOMAIN_CRASHED = 6
the domain is crashed
VIR_DOMAIN_PMSUSPENDED = 7
the domain is suspended by guest power management
VIR_DOMAIN_LAST = 8
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.
}

virDomainStatsRecord

struct virDomainStatsRecord {
virDomainPtrdom
virTypedParameterPtrparams
intnparams
}

virDomainStatsTypes

enum virDomainStatsTypes {
VIR_DOMAIN_STATS_STATE = 1
return domain state
VIR_DOMAIN_STATS_CPU_TOTAL = 2
return domain CPU info
VIR_DOMAIN_STATS_BALLOON = 4
return domain balloon info
VIR_DOMAIN_STATS_VCPU = 8
return domain virtual CPU info
VIR_DOMAIN_STATS_INTERFACE = 16
return domain interfaces info
VIR_DOMAIN_STATS_BLOCK = 32
return domain block info
VIR_DOMAIN_STATS_PERF = 64
return domain perf event info
}

virDomainUndefineFlagsValues

enum virDomainUndefineFlagsValues {
VIR_DOMAIN_UNDEFINE_MANAGED_SAVE = 1
Also remove any managed save
VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA = 2
If last use of domain, then also remove any snapshot metadata
VIR_DOMAIN_UNDEFINE_NVRAM = 4
Also remove any nvram file
VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = 8
Keep nvram file Future undefine control flags should come here.
}

virDomainVcpuFlags

enum virDomainVcpuFlags {
VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG
Additionally, these flags may be bitwise-OR'd in.
VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT
VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE
VIR_DOMAIN_VCPU_MAXIMUM = 4
Max rather than current count
VIR_DOMAIN_VCPU_GUEST = 8
Modify state of the cpu in the guest
VIR_DOMAIN_VCPU_HOTPLUGGABLE = 16
Make vcpus added hot(un)pluggable
}

virDomainXMLFlags

enum virDomainXMLFlags {
VIR_DOMAIN_XML_SECURE = 1
dump security sensitive information too
VIR_DOMAIN_XML_INACTIVE = 2
dump inactive domain information
VIR_DOMAIN_XML_UPDATE_CPU = 4
update guest CPU requirements according to host CPU
VIR_DOMAIN_XML_MIGRATABLE = 8
dump XML suitable for migration
}

virKeycodeSet

enum virKeycodeSet {
VIR_KEYCODE_SET_LINUX = 0
VIR_KEYCODE_SET_XT = 1
VIR_KEYCODE_SET_ATSET1 = 2
VIR_KEYCODE_SET_ATSET2 = 3
VIR_KEYCODE_SET_ATSET3 = 4
VIR_KEYCODE_SET_OSX = 5
VIR_KEYCODE_SET_XT_KBD = 6
VIR_KEYCODE_SET_USB = 7
VIR_KEYCODE_SET_WIN32 = 8
VIR_KEYCODE_SET_RFB = 9
VIR_KEYCODE_SET_LAST = 10
NB: this enum value will increase over time as new events are added to the libvirt API. It reflects the last keycode set supported by this version of the libvirt API.
}

virMemoryParameter

struct virMemoryParameter {
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
}

virMemoryParameterType

enum virMemoryParameterType {
VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN
VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE
VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT
VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG
VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT
VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG
}

virSchedParameter

struct virSchedParameter {
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
}

virSchedParameterType

enum virSchedParameterType {
VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN
VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE
VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT
VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG
VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT
VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG
}

virVcpuInfo

struct virVcpuInfo {
unsigned intnumber
virtual CPU number
intstate
value from virVcpuState
unsigned long longcpuTime
CPU time used, in nanoseconds
intcpu
real CPU number, or -1 if offline
}

virVcpuState

enum virVcpuState {
VIR_VCPU_OFFLINE = 0
the virtual CPU is offline
VIR_VCPU_RUNNING = 1
the virtual CPU is running
VIR_VCPU_BLOCKED = 2
the virtual CPU is blocked on resource
VIR_VCPU_LAST = 3
}

Functions

virConnectDomainEventAgentLifecycleCallback

typedef void	(*virConnectDomainEventAgentLifecycleCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 int state,
							 int reason,
							 void * opaque)

This callback occurs when libvirt detects a change in the state of a guest agent.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
state
new state of the guest agent, one of virConnectDomainEventAgentLifecycleState
reason
reason for state change; one of virConnectDomainEventAgentLifecycleReason
opaque
application specified data

virConnectDomainEventBalloonChangeCallback

typedef void	(*virConnectDomainEventBalloonChangeCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 unsigned long long actual,
							 void * opaque)

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
actual
the new balloon level measured in kibibytes(blocks of 1024 bytes)
opaque
application specified data

virConnectDomainEventBlockJobCallback

typedef void	(*virConnectDomainEventBlockJobCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 const char * disk,
						 int type,
						 int status,
						 void * opaque)

The string returned for @disk can be used in any of the libvirt API that operate on a particular disk of the domain, and depends on what event type was registered with virConnectDomainEventRegisterAny(). If the callback was registered using the older type of VIR_DOMAIN_EVENT_ID_BLOCK_JOB, then @disk contains the absolute file name of the host resource for the active layer of the disk; however, this name is unstable (pivoting via block copy or active block commit will change which file is active, giving a different name for the two events associated with the same job) and cannot be relied on if the active layer is associated with a network resource. If the callback was registered using the newer type of VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2, then @disk will contain the device target shorthand (the <target dev='...'/> sub-element, such as "vda").

conn
connection object
dom
domain on which the event occurred
disk
name associated with the affected disk (filename or target device, depending on how the callback was registered)
type
type of block job (virDomainBlockJobType)
status
status of the operation (virConnectDomainEventBlockJobStatus)
opaque
application specified data

virConnectDomainEventCallback

typedef int	(*virConnectDomainEventCallback)	(virConnectPtr conn,
					 virDomainPtr dom,
					 int event,
					 int detail,
					 void * opaque)

A callback function to be registered, and called when a domain event occurs

conn
virConnect connection
dom
The domain on which the event occurred
event
The specific virDomainEventType which occurred
detail
event specific detail information
opaque
opaque user data
Returns
0 (the return value is currently ignored)

virConnectDomainEventDeregister

int	virConnectDomainEventDeregister	(virConnectPtr conn,
					 virConnectDomainEventCallback cb)

Removes a callback previously registered with the virConnectDomainEventRegister() function.

Use of this method is no longer recommended. Instead applications should try virConnectDomainEventDeregisterAny() which has a more flexible API contract

conn
pointer to the connection
cb
callback to the function handling domain events
Returns
0 on success, -1 on failure. Older versions of some hypervisors sometimes returned a positive number on success, but without any reliable semantics on what that number represents.

virConnectDomainEventDeregisterAny

int	virConnectDomainEventDeregisterAny	(virConnectPtr conn,
						 int callbackID)

Removes an event callback. The callbackID parameter should be the value obtained from a previous virConnectDomainEventRegisterAny() method.

conn
pointer to the connection
callbackID
the callback identifier
Returns
0 on success, -1 on failure. Older versions of some hypervisors sometimes returned a positive number on success, but without any reliable semantics on what that number represents.

virConnectDomainEventDeviceAddedCallback

typedef void	(*virConnectDomainEventDeviceAddedCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 const char * devAlias,
							 void * opaque)

This callback occurs when a device is added to the domain.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_DEVICE_ADDED with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
devAlias
device alias
opaque
application specified data

virConnectDomainEventDeviceRemovalFailedCallback

typedef void	(*virConnectDomainEventDeviceRemovalFailedCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 const char * devAlias,
							 void * opaque)

This callback occurs when it's certain that removal of a device failed.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED with virConnectDomainEventRegisterAny().

conn
connection object
dom
domain on which the event occurred
devAlias
device alias
opaque
application specified data

virConnectDomainEventDeviceRemovedCallback

typedef void	(*virConnectDomainEventDeviceRemovedCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 const char * devAlias,
							 void * opaque)

This callback occurs when a device is removed from the domain.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
devAlias
device alias
opaque
application specified data

virConnectDomainEventDiskChangeCallback

typedef void	(*virConnectDomainEventDiskChangeCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 const char * oldSrcPath,
						 const char * newSrcPath,
						 const char * devAlias,
						 int reason,
						 void * opaque)

This callback occurs when disk gets changed. However, not all @reason will cause both @oldSrcPath and @newSrcPath to be non-NULL. Please see virConnectDomainEventDiskChangeReason for more details.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_DISK_CHANGE with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
oldSrcPath
old source path
newSrcPath
new source path
devAlias
device alias name
reason
reason why this callback was called; any of virConnectDomainEventDiskChangeReason
opaque
application specified data

virConnectDomainEventGenericCallback

typedef void	(*virConnectDomainEventGenericCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 void * opaque)

A generic domain event callback handler, for use with virConnectDomainEventRegisterAny(). Specific events usually have a customization with extra parameters, often with @opaque being passed in a different parameter position; use VIR_DOMAIN_EVENT_CALLBACK() when registering an appropriate handler.

conn
the connection pointer
dom
the domain pointer
opaque
application specified data

virConnectDomainEventGraphicsCallback

typedef void	(*virConnectDomainEventGraphicsCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 int phase,
						 const virDomainEventGraphicsAddress * local,
						 const virDomainEventGraphicsAddress * remote,
						 const char * authScheme,
						 const virDomainEventGraphicsSubject * subject,
						 void * opaque)

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_GRAPHICS with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
phase
the phase of the connection
local
the local server address
remote
the remote client address
authScheme
the authentication scheme activated
subject
the authenticated subject (user)
opaque
application specified data

virConnectDomainEventIOErrorCallback

typedef void	(*virConnectDomainEventIOErrorCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 const char * srcPath,
						 const char * devAlias,
						 int action,
						 void * opaque)

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_IO_ERROR with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
srcPath
The host file on which the IO error occurred
devAlias
The guest device alias associated with the path
action
action that is to be taken due to the IO error
opaque
application specified data

virConnectDomainEventIOErrorReasonCallback

typedef void	(*virConnectDomainEventIOErrorReasonCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 const char * srcPath,
							 const char * devAlias,
							 int action,
							 const char * reason,
							 void * opaque)

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON with virConnectDomainEventRegisterAny()

If the I/O error is known to be caused by an ENOSPC condition in the host (where resizing the disk to be larger will allow the guest to be resumed as if nothing happened), @reason will be "enospc". Otherwise, @reason will be "", although future strings may be added if determination of other error types becomes possible.

conn
connection object
dom
domain on which the event occurred
srcPath
The host file on which the IO error occurred
devAlias
The guest device alias associated with the path
action
action that is to be taken due to the IO error
reason
the cause of the IO error
opaque
application specified data

virConnectDomainEventJobCompletedCallback

typedef void	(*virConnectDomainEventJobCompletedCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 virTypedParameterPtr params,
							 int nparams,
							 void * opaque)

This callback occurs when a job (such as migration) running on the domain is completed. The params array will contain statistics of the just completed job as virDomainGetJobStats would return. The callback must not free @params (the array will be freed once the callback finishes).

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_JOB_COMPLETED with virConnectDomainEventRegisterAny().

conn
connection object
dom
domain on which the event occurred
params
job statistics stored as an array of virTypedParameter
nparams
size of the params array
opaque
application specific data

virConnectDomainEventMetadataChangeCallback

typedef void	(*virConnectDomainEventMetadataChangeCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 int type,
							 const char * nsuri,
							 void * opaque)

This callback is triggered when the domain XML metadata is changed

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_METADATA_CHANGE with virConnectDomainEventRegisterAny().

conn
connection object
dom
domain on which the event occurred
type
a value from virDomainMetadataTypea
nsuri
XML namespace URI
opaque
application specified data

virConnectDomainEventMigrationIterationCallback

typedef void	(*virConnectDomainEventMigrationIterationCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 int iteration,
							 void * opaque)

This callback occurs during live migration when a new iteration over domain's memory starts. The @iteration value is increased by one every time a new iteration is started to transfer memory pages dirtied since the last iteration.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION with virConnectDomainEventRegisterAny().

conn
connection object
dom
domain on which the event occurred
iteration
current iteration over domain's memory
opaque
application specific data

virConnectDomainEventPMSuspendCallback

typedef void	(*virConnectDomainEventPMSuspendCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 int reason,
						 void * opaque)

This callback occurs when the guest is suspended.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_PMSUSPEND with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
reason
reason why the callback was called, unused currently, always passes 0
opaque
application specified data

virConnectDomainEventPMSuspendDiskCallback

typedef void	(*virConnectDomainEventPMSuspendDiskCallback)	(virConnectPtr conn,
							 virDomainPtr dom,
							 int reason,
							 void * opaque)

This callback occurs when the guest is suspended to disk.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
reason
reason why the callback was called, unused currently, always passes 0
opaque
application specified data

virConnectDomainEventPMWakeupCallback

typedef void	(*virConnectDomainEventPMWakeupCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 int reason,
						 void * opaque)

This callback occurs when the guest is woken up.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_PMWAKEUP with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
reason
reason why the callback was called, unused currently, always passes 0
opaque
application specified data

virConnectDomainEventRTCChangeCallback

typedef void	(*virConnectDomainEventRTCChangeCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 long long utcoffset,
						 void * opaque)

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_RTC_CHANGE with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
utcoffset
the new RTC offset from UTC, measured in seconds
opaque
application specified data

virConnectDomainEventRegister

int	virConnectDomainEventRegister	(virConnectPtr conn,
					 virConnectDomainEventCallback cb,
					 void * opaque,
					 virFreeCallback freecb)

Adds a callback to receive notifications of domain lifecycle events occurring on a connection. This function requires that an event loop has been previously registered with virEventRegisterImpl() or virEventRegisterDefaultImpl().

Use of this method is no longer recommended. Instead applications should try virConnectDomainEventRegisterAny() which has a more flexible API contract.

The virDomainPtr object handle passed into the callback upon delivery of an event is only valid for the duration of execution of the callback. If the callback wishes to keep the domain object after the callback returns, it shall take a reference to it, by calling virDomainRef. The reference can be released once the object is no longer required by calling virDomainFree.

conn
pointer to the connection
cb
callback to the function handling domain events
opaque
opaque data to pass on to the callback
freecb
optional function to deallocate opaque when not used anymore
Returns
0 on success, -1 on failure. Older versions of some hypervisors sometimes returned a positive number on success, but without any reliable semantics on what that number represents.

virConnectDomainEventRegisterAny

int	virConnectDomainEventRegisterAny	(virConnectPtr conn,
						 virDomainPtr dom,
						 int eventID,
						 virConnectDomainEventGenericCallback cb,
						 void * opaque,
						 virFreeCallback freecb)

Adds a callback to receive notifications of arbitrary domain events occurring on a domain. This function requires that an event loop has been previously registered with virEventRegisterImpl() or virEventRegisterDefaultImpl().

If @dom is NULL, then events will be monitored for any domain. If @dom is non-NULL, then only the specific domain will be monitored.

Most types of event have a callback providing a custom set of parameters for the event. When registering an event, it is thus necessary to use the VIR_DOMAIN_EVENT_CALLBACK() macro to cast the supplied function pointer to match the signature of this method.

The virDomainPtr object handle passed into the callback upon delivery of an event is only valid for the duration of execution of the callback. If the callback wishes to keep the domain object after the callback returns, it shall take a reference to it, by calling virDomainRef(). The reference can be released once the object is no longer required by calling virDomainFree().

The return value from this method is a positive integer identifier for the callback. To unregister a callback, this callback ID should be passed to the virConnectDomainEventDeregisterAny() method.

conn
pointer to the connection
dom
pointer to the domain
eventID
the event type to receive
cb
callback to the function handling domain events
opaque
opaque data to pass on to the callback
freecb
optional function to deallocate opaque when not used anymore
Returns
a callback identifier on success, -1 on failure.

virConnectDomainEventTrayChangeCallback

typedef void	(*virConnectDomainEventTrayChangeCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 const char * devAlias,
						 int reason,
						 void * opaque)

This callback occurs when the tray of a removable device is moved.

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_TRAY_CHANGE with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
devAlias
device alias
reason
why the tray status was changed?
opaque
application specified data

virConnectDomainEventTunableCallback

typedef void	(*virConnectDomainEventTunableCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 virTypedParameterPtr params,
						 int nparams,
						 void * opaque)

This callback occurs when tunable values are updated. The params must not be freed in the callback handler as it's done internally after the callback handler is executed.

Currently supported name spaces: "cputune.*" "blkdeviotune.*"

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_TUNABLE with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
params
changed tunable values stored as array of virTypedParameter
nparams
size of the array
opaque
application specified data

virConnectDomainEventWatchdogCallback

typedef void	(*virConnectDomainEventWatchdogCallback)	(virConnectPtr conn,
						 virDomainPtr dom,
						 int action,
						 void * opaque)

The callback signature to use when registering for an event of type VIR_DOMAIN_EVENT_ID_WATCHDOG with virConnectDomainEventRegisterAny()

conn
connection object
dom
domain on which the event occurred
action
action that is to be taken due to watchdog firing
opaque
application specified data

virConnectDomainXMLFromNative

char *	virConnectDomainXMLFromNative	(virConnectPtr conn,
					 const char * nativeFormat,
					 const char * nativeConfig,
					 unsigned int flags)

Reads native configuration data describing a domain, and generates libvirt domain XML. The format of the native data is hypervisor dependent.

conn
a connection object
nativeFormat
configuration format importing from
nativeConfig
the configuration data to import
flags
extra flags; not used yet, so callers should always pass 0
Returns
a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.

virConnectDomainXMLToNative

char *	virConnectDomainXMLToNative	(virConnectPtr conn,
					 const char * nativeFormat,
					 const char * domainXml,
					 unsigned int flags)

Reads a domain XML configuration document, and generates a native configuration file describing the domain. The format of the native data is hypervisor dependent.

conn
a connection object
nativeFormat
configuration format exporting to
domainXml
the domain configuration to export
flags
extra flags; not used yet, so callers should always pass 0
Returns
a 0 terminated UTF-8 encoded native config datafile, or NULL in case of error. the caller must free() the returned value.

virConnectGetAllDomainStats

int	virConnectGetAllDomainStats	(virConnectPtr conn,
					 unsigned int stats,
					 virDomainStatsRecordPtr ** retStats,
					 unsigned int flags)

Query statistics for all domains on a given connection.

Report statistics of various parameters for a running VM according to @stats field. The statistics are returned as an array of structures for each queried domain. The structure contains an array of typed parameters containing the individual statistics. The typed parameter name for each statistic field consists of a dot-separated string containing name of the requested group followed by a group specific description of the statistic value.

The statistic groups are enabled using the @stats parameter which is a binary-OR of enum virDomainStatsTypes. The following groups are available (although not necessarily implemented for each hypervisor):

VIR_DOMAIN_STATS_STATE: Return domain state and reason for entering that state. The typed parameter keys are in this format:

  "state.state" - state of the VM, returned as int from virDomainState enum
  "state.reason" - reason for entering given state, returned as int from
                   virDomain*Reason enum corresponding to given state.

VIR_DOMAIN_STATS_CPU_TOTAL: Return CPU statistics and usage information. The typed parameter keys are in this format:

  "cpu.time" - total cpu time spent for this domain in nanoseconds
               as unsigned long long.
  "cpu.user" - user cpu time spent in nanoseconds as unsigned long long.
  "cpu.system" - system cpu time spent in nanoseconds as unsigned long
                 long.

VIR_DOMAIN_STATS_BALLOON: Return memory balloon device information. The typed parameter keys are in this format:

  "balloon.current" - the memory in kiB currently used
                      as unsigned long long.
  "balloon.maximum" - the maximum memory in kiB allowed
                      as unsigned long long.

VIR_DOMAIN_STATS_VCPU: Return virtual CPU statistics. Due to VCPU hotplug, the vcpu.<num>.* array could be sparse. The actual size of the array corresponds to "vcpu.current". The array size will never exceed "vcpu.maximum". The typed parameter keys are in this format:

  "vcpu.current" - current number of online virtual CPUs as unsigned int.
  "vcpu.maximum" - maximum number of online virtual CPUs as unsigned int.
  "vcpu.<num>.state" - state of the virtual CPU <num>, as int
                       from virVcpuState enum.
  "vcpu.<num>.time" - virtual cpu time spent by virtual CPU <num>
                      as unsigned long long.

VIR_DOMAIN_STATS_INTERFACE: Return network interface statistics. The typed parameter keys are in this format:

  "net.count" - number of network interfaces on this domain
                as unsigned int.
  "net.<num>.name" - name of the interface <num> as string.
  "net.<num>.rx.bytes" - bytes received as unsigned long long.
  "net.<num>.rx.pkts" - packets received as unsigned long long.
  "net.<num>.rx.errs" - receive errors as unsigned long long.
  "net.<num>.rx.drop" - receive packets dropped as unsigned long long.
  "net.<num>.tx.bytes" - bytes transmitted as unsigned long long.
  "net.<num>.tx.pkts" - packets transmitted as unsigned long long.
  "net.<num>.tx.errs" - transmission errors as unsigned long long.
  "net.<num>.tx.drop" - transmit packets dropped as unsigned long long.

VIR_DOMAIN_STATS_BLOCK: Return block devices statistics. By default, this information is limited to the active layer of each <disk> of the domain (where block.count is equal to the number of disks), but adding VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING to @flags will expand the array to cover backing chains (block.count corresponds to the number of host resources used together to provide the guest disks). The typed parameter keys are in this format:

  "block.count" - number of block devices in the subsequent list,
                  as unsigned int.
  "block.<num>.name" - name of the block device <num> as string.
                       matches the target name (vda/sda/hda) of the
                       block device.  If the backing chain is listed,
                       this name is the same for all host resources tied
                       to the same guest device.
  "block.<num>.backingIndex" - unsigned int giving the <backingStore>
                                index, only used when backing images
                                are listed.
  "block.<num>.path" - string describing the source of block device <num>,
                       if it is a file or block device (omitted for network
                       sources and drives with no media inserted).
  "block.<num>.rd.reqs" - number of read requests as unsigned long long.
  "block.<num>.rd.bytes" - number of read bytes as unsigned long long.
  "block.<num>.rd.times" - total time (ns) spent on reads as
                           unsigned long long.
  "block.<num>.wr.reqs" - number of write requests as unsigned long long.
  "block.<num>.wr.bytes" - number of written bytes as unsigned long long.
  "block.<num>.wr.times" - total time (ns) spent on writes as
                           unsigned long long.
  "block.<num>.fl.reqs" - total flush requests as unsigned long long.
  "block.<num>.fl.times" - total time (ns) spent on cache flushing as
                           unsigned long long.
  "block.<num>.errors" - Xen only: the 'oo_req' value as
                         unsigned long long.
  "block.<num>.allocation" - offset of the highest written sector
                             as unsigned long long.
  "block.<num>.capacity" - logical size in bytes of the block device
                           backing image as unsigned long long.
  "block.<num>.physical" - physical size in bytes of the container of the
                           backing image as unsigned long long.

VIR_DOMAIN_STATS_PERF: Return perf event statistics. The typed parameter keys are in this format:

  "perf.cmt" - the usage of l3 cache (bytes) by applications running on
               the platform as unsigned long long. It is produced by cmt
               perf event.
  "perf.mbmt" - the total system bandwidth (bytes/s) from one level of
                cache to another as unsigned long long. It is produced
                by mbmt perf event.
  "perf.mbml" - the amount of data (bytes/s) sent through the memory
                controller on the socket as unsigned long long. It is
                produced by mbml perf event.
  "perf.cache_misses" - the count of cache misses as unsigned long long.
                        It is produced by cache_misses perf event.
  "perf.cache_references" - the count of cache hits as unsigned long long.
                            It is produced by cache_references perf event.
  "perf.instructions" - The count of instructions as unsigned long long.
                        It is produced by instructions perf event.
  "perf.cpu_cycles" - The count of cpu cycles (total/elapsed) as an
                      unsigned long long. It is produced by cpu_cycles
                      perf event.
  "perf.branch_instructions" - The count of branch instructions as
                               unsigned long long. It is produced by
                               branch_instructions perf event.
  "perf.branch_misses" - The count of branch misses as unsigned long
                         long. It is produced by branch_misses perf event.
  "perf.bus_cycles" - The count of bus cycles as unsigned long
                      long. It is produced by bus_cycles perf event.
  "perf.stalled_cycles_frontend" - The count of stalled cpu cycles in the
                                   frontend of the instruction processor
                                   pipeline as unsigned long long. It is
                                   produced by stalled_cycles_frontend
                                   perf event.
  "perf.stalled_cycles_backend"  - The count of stalled cpu cycles in the
                                   backend of the instruction processor
                                   pipeline as unsigned long long. It is
                                   produced by stalled_cycles_backend
                                   perf event.
  "perf.ref_cpu_cycles" - The count of total cpu cycles not affected by
                          CPU frequency scaling by applications running
                          as unsigned long long. It is produced by the
                          ref_cpu_cycles perf event.
  "perf.cpu_clock" - The count of cpu clock time as unsigned long long.
                     It is produced by the cpu_clock perf event.
  "perf.task_clock" - The count of task clock time as unsigned long long.
                      It is produced by the task_clock perf event.
  "perf.page_faults" - The count of page faults as unsigned long long.
                       It is produced by the page_faults perf event
  "perf.context_switches" - The count of context switches as unsigned long
                            long. It is produced by the context_switches
                            perf event.
  "perf.cpu_migrations" - The count of cpu migrations, from one logical
                          processor to another, as unsigned long
                          long. It is produced by the cpu_migrations
                          perf event.
  "perf.page_faults_min" - The count of minor page faults as unsigned
                           long long. It is produced by the
                           page_faults_min perf event.
  "perf.page_faults_maj" - The count of major page faults as unsigned
                           long long. It is produced by the
                           page_faults_maj perf event.
  "perf.alignment_faults" - The count of alignment faults as unsigned
                            long long. It is produced by the
                            alignment_faults perf event
  "perf.emulation_faults" - The count of emulation faults as unsigned
                            long long. It is produced by the
                            emulation_faults perf event

Note that entire stats groups or individual stat fields may be missing from the output in case they are not supported by the given hypervisor, are not applicable for the current state of the guest domain, or their retrieval was not successful.

Using 0 for @stats returns all stats groups supported by the given hypervisor.

Specifying VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS as @flags makes the function return error in case some of the stat types in @stats were not recognized by the daemon. However, even with this flag, a hypervisor may omit individual fields within a known group if the information is not available; as an extreme example, a supported group may produce zero fields for offline domains if the statistics are meaningful only for a running domain.

Similarly to virConnectListAllDomains, @flags can contain various flags to filter the list of domains to provide stats for.

VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE selects online domains while VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE selects offline ones.

VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT and VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT allow to filter the list according to their persistence.

To filter the list of VMs by domain state @flags can contain VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING, VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED, VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF and/or VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER for all other states.

conn
pointer to the hypervisor connection
stats
stats to return, binary-OR of virDomainStatsTypes
retStats
Pointer that will be filled with the array of returned stats
flags
extra flags; binary-OR of virConnectGetAllDomainStatsFlags
Returns
the count of returned statistics structures on success, -1 on error. The requested data are returned in the @retStats parameter. The returned array should be freed by the caller. See virDomainStatsRecordListFree.

virConnectGetDomainCapabilities

char *	virConnectGetDomainCapabilities	(virConnectPtr conn,
					 const char * emulatorbin,
					 const char * arch,
					 const char * machine,
					 const char * virttype,
					 unsigned int flags)

Prior creating a domain (for instance via virDomainCreateXML or virDomainDefineXML) it may be suitable to know what the underlying emulator and/or libvirt is capable of. For instance, if host, libvirt and qemu is capable of VFIO passthrough and so on.

conn
pointer to the hypervisor connection
emulatorbin
path to emulator
arch
domain architecture
machine
machine type
virttype
virtualization type
flags
extra flags; not used yet, so callers should always pass 0
Returns
NULL in case of error or an XML string defining the capabilities.

virConnectListAllDomains

int	virConnectListAllDomains	(virConnectPtr conn,
					 virDomainPtr ** domains,
					 unsigned int flags)

Collect a possibly-filtered list of all domains, and return an allocated array of information for each. This API solves the race inherent in virConnectListDomains() and virConnectListDefinedDomains().

Normally, all domains are returned; however, @flags can be used to filter the results for a smaller list of targeted domains. The valid flags are divided into groups, where each group contains bits that describe mutually exclusive attributes of a domain, and where all bits within a group describe all possible domains. Some hypervisors might reject explicit bits from a group where the hypervisor cannot make a distinction (for example, not all hypervisors can tell whether domains have snapshots). For a group supported by a given hypervisor, the behavior when no bits of a group are set is identical to the behavior when all bits in that group are set. When setting bits from more than one group, it is possible to select an impossible combination (such as an inactive transient domain), in that case a hypervisor may return either 0 or an error.

The first group of @flags is VIR_CONNECT_LIST_DOMAINS_ACTIVE (online domains) and VIR_CONNECT_LIST_DOMAINS_INACTIVE (offline domains).

The next group of @flags is VIR_CONNECT_LIST_DOMAINS_PERSISTENT (defined domains) and VIR_CONNECT_LIST_DOMAINS_TRANSIENT (running but not defined).

The next group of @flags covers various domain states: VIR_CONNECT_LIST_DOMAINS_RUNNING, VIR_CONNECT_LIST_DOMAINS_PAUSED, VIR_CONNECT_LIST_DOMAINS_SHUTOFF, and a catch-all for all other states (such as crashed, this catch-all covers the possibility of adding new states).

The remaining groups cover boolean attributes commonly asked about domains; they include VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE and VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE, for filtering based on whether a managed save image exists; VIR_CONNECT_LIST_DOMAINS_AUTOSTART and VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART, for filtering based on autostart; VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT and VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT, for filtering based on whether a domain has snapshots.

Example of usage:

virDomainPtr *domains;
size_t i;
int ret;
unsigned int flags = VIR_CONNECT_LIST_DOMAINS_RUNNING |
                     VIR_CONNECT_LIST_DOMAINS_PERSISTENT;
ret = virConnectListAllDomains(conn, &domains, flags);
if (ret < 0)
    error();
for (i = 0; i < ret; i++) {
     do_something_with_domain(domains[i]);
     //here or in a separate loop if needed
     virDomainFree(domains[i]);
}
free(domains);
conn
Pointer to the hypervisor connection.
domains
Pointer to a variable to store the array containing domain objects or NULL if the list is not required (just returns number of guests).
flags
bitwise-OR of virConnectListAllDomainsFlags
Returns
the number of domains found or -1 and sets domains to NULL in case of error. On success, the array stored into @domains is guaranteed to have an extra allocated element set to NULL but not included in the return count, to make iteration easier. The caller is responsible for calling virDomainFree() on each array element, then calling free() on @domains.

virConnectListDefinedDomains

int	virConnectListDefinedDomains	(virConnectPtr conn,
					 char ** const names,
					 int maxnames)

list the defined but inactive domains, stores the pointers to the names in @names

For active domains, see virConnectListDomains(). For more control over the results, see virConnectListAllDomains().

conn
pointer to the hypervisor connection
names
pointer to an array to store the names
maxnames
size of the array
Returns
the number of names provided in the array or -1 in case of error. Note that this command is inherently racy; a domain can be defined between a call to virConnectNumOfDefinedDomains() and this call; you are only guaranteed that all currently defined domains were listed if the return is less than @maxids. The client must call free() on each returned name.

virConnectListDomains

int	virConnectListDomains		(virConnectPtr conn,
					 int * ids,
					 int maxids)

Collect the list of active domains, and store their IDs in array @ids

For inactive domains, see virConnectListDefinedDomains(). For more control over the results, see virConnectListAllDomains().

conn
pointer to the hypervisor connection
ids
array to collect the list of IDs of active domains
maxids
size of @ids
Returns
the number of domains found or -1 in case of error. Note that this command is inherently racy; a domain can be started between a call to virConnectNumOfDomains() and this call; you are only guaranteed that all currently active domains were listed if the return is less than @maxids.

virConnectNumOfDefinedDomains

int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

Provides the number of defined but inactive domains.

conn
pointer to the hypervisor connection
Returns
the number of domain found or -1 in case of error

virConnectNumOfDomains

int	virConnectNumOfDomains		(virConnectPtr conn)

Provides the number of active domains.

conn
pointer to the hypervisor connection
Returns
the number of domain found or -1 in case of error

virDomainAbortJob

int	virDomainAbortJob		(virDomainPtr domain)

Requests that the current background job be aborted at the soonest opportunity.

domain
a domain object
Returns
0 in case of success and -1 in case of failure.

virDomainAddIOThread

int	virDomainAddIOThread		(virDomainPtr domain,
					 unsigned int iothread_id,
					 unsigned int flags)

Dynamically add an IOThread to the domain. It is left up to the underlying virtual hypervisor to determine the valid range for an @iothread_id and determining whether the @iothread_id already exists.

Note that this call can fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrarily limited. This function requires privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and may fail if domain is not alive. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed.

domain
a domain object
iothread_id
the specific IOThread ID value to add
flags
bitwise-OR of virDomainModificationImpact
Returns
0 in case of success, -1 in case of failure.

virDomainAttachDevice

int	virDomainAttachDevice		(virDomainPtr domain,
					 const char * xml)

Create a virtual device attachment to backend. This function, having hotplug semantics, is only allowed on an active domain.

For compatibility, this method can also be used to change the media in an existing CDROM/Floppy device, however, applications are recommended to use the virDomainUpdateDeviceFlag method instead.

Be aware that hotplug changes might not persist across a domain going into S4 state (also known as hibernation) unless you also modify the persistent domain definition.

domain
pointer to domain object
xml
pointer to XML description of one device
Returns
0 in case of success, -1 in case of failure.

virDomainAttachDeviceFlags

int	virDomainAttachDeviceFlags	(virDomainPtr domain,
					 const char * xml,
					 unsigned int flags)

Attach a virtual device to a domain, using the flags parameter to control how the device is attached. VIR_DOMAIN_AFFECT_CURRENT specifies that the device allocation is made based on current domain state. VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be allocated to the active domain instance only and is not added to the persisted domain configuration. VIR_DOMAIN_AFFECT_CONFIG specifies that the device shall be allocated to the persisted domain configuration only. Note that the target hypervisor must return an error if unable to satisfy flags. E.g. the hypervisor driver will return failure if LIVE is specified but it only supports modifying the persisted device allocation.

For compatibility, this method can also be used to change the media in an existing CDROM/Floppy device, however, applications are recommended to use the virDomainUpdateDeviceFlag method instead.

Be aware that hotplug changes might not persist across a domain going into S4 state (also known as hibernation) unless you also modify the persistent domain definition.

domain
pointer to domain object
xml
pointer to XML description of one device
flags
bitwise-OR of virDomainDeviceModifyFlags
Returns
0 in case of success, -1 in case of failure.

virDomainBlockCommit

int	virDomainBlockCommit		(virDomainPtr dom,
					 const char * disk,
					 const char * base,
					 const char * top,
					 unsigned long bandwidth,
					 unsigned int flags)

Commit changes that were made to temporary top-level files within a disk image backing file chain into a lower-level base file. In other words, take all the difference between @base and @top, and update @base to contain that difference; after the commit, any portion of the chain that previously depended on @top will now depend on @base, and all files after @base up to and including @top will now be invalidated. A typical use of this command is to reduce the length of a backing file chain after taking an external disk snapshot. To move data in the opposite direction, see virDomainBlockPull().

This command starts a long-running commit block job, whose status may be tracked by virDomainBlockJobInfo() with a job type of VIR_DOMAIN_BLOCK_JOB_TYPE_COMMIT, and the operation can be aborted with virDomainBlockJobAbort(). When finished, an asynchronous event is raised to indicate the final status, and the job no longer exists. If the job is aborted, it is up to the hypervisor whether starting a new job will resume from the same point, or start over.

As a special case, if @top is the active image (or NULL), and @flags includes VIR_DOMAIN_BLOCK_COMMIT_ACTIVE, the block job will have a type of VIR_DOMAIN_BLOCK_JOB_TYPE_ACTIVE_COMMIT, and operates in two phases. In the first phase, the contents are being committed into @base, and the job can only be canceled. The job transitions to the second phase when the job info states cur == end, and remains alive to keep all further changes to @top synchronized into @base; an event with status VIR_DOMAIN_BLOCK_JOB_READY is also issued to mark the job transition. Once in the second phase, the user must choose whether to cancel the job (keeping @top as the active image, but now containing only the changes since the time the job ended) or to pivot the job (adjusting to @base as the active image, and invalidating @top).

Be aware that this command may invalidate files even if it is aborted; the user is cautioned against relying on the contents of invalidated intermediate files such as @top (when @top is not the active image) without manually rebasing those files to use a backing file of a read-only copy of @base prior to the point where the commit operation was started (and such a rebase cannot be safely done until the commit has successfully completed). However, the domain itself will not have any issues; the active layer remains valid throughout the entire commit operation.

Some hypervisors may support a shortcut where if @flags contains VIR_DOMAIN_BLOCK_COMMIT_DELETE, then this command will unlink all files that were invalidated, after the commit successfully completes.

If @flags contains VIR_DOMAIN_BLOCK_COMMIT_RELATIVE, the name recorded into the overlay of the @top image (if there is such image) as the path to the new backing file will be kept relative to other images. The operation will fail if libvirt can't infer the name.

By default, if @base is NULL, the commit target will be the bottom of the backing chain; if @flags contains VIR_DOMAIN_BLOCK_COMMIT_SHALLOW, then the immediate backing file of @top will be used instead. If @top is NULL, the active image at the top of the chain will be used. Some hypervisors place restrictions on how much can be committed, and might fail if @base is not the immediate backing file of @top, or if @top is the active layer in use by a running domain but @flags did not include VIR_DOMAIN_BLOCK_COMMIT_ACTIVE, or if @top is not the top-most file; restrictions may differ for online vs. offline domains.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

The @base and @top parameters can be either paths to files within the backing chain, or the device target shorthand (the <target dev='...'/> sub-element, such as "vda") followed by an index to the backing chain enclosed in square brackets. Backing chain indexes can be found by inspecting //disk//backingStore/@index in the domain XML. Thus, for example, "vda[3]" refers to the backing store with index equal to "3" in the chain of disk "vda".

The maximum bandwidth that will be used to do the commit can be specified with the @bandwidth parameter. If set to 0, there is no limit. If @flags includes VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES, @bandwidth is in bytes/second; otherwise, it is in MiB/second. Values larger than 2^52 bytes/sec may be rejected due to overflow considerations based on the word size of both client and server, and values larger than 2^31 bytes/sec may cause overflow problems if later queried by virDomainGetBlockJobInfo() without scaling. Hypervisors may further restrict the range of valid bandwidth values. Some hypervisors do not support this feature and will return an error if bandwidth is not 0; in this case, it might still be possible for a later call to virDomainBlockJobSetSpeed() to succeed. The actual speed can be determined with virDomainGetBlockJobInfo().

dom
pointer to domain object
disk
path to the block device, or device shorthand
base
path to backing file to merge into, or device shorthand, or NULL for default
top
path to file within backing chain that contains data to be merged, or device shorthand, or NULL to merge all possible data
bandwidth
(optional) specify bandwidth limit; flags determine the unit
flags
bitwise-OR of virDomainBlockCommitFlags
Returns
0 if the operation has started, -1 on failure.

virDomainBlockCopy

int	virDomainBlockCopy		(virDomainPtr dom,
					 const char * disk,
					 const char * destxml,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Copy the guest-visible contents of a disk image to a new file described by @destxml. The destination XML has a top-level element of <disk>, and resembles what is used when hot-plugging a disk via virDomainAttachDevice(), except that only sub-elements related to describing the new host resource are necessary (sub-elements related to the guest view, such as <target>, are ignored). It is strongly recommended to include a <driver type='...'/> format designation for the destination, to avoid the potential of any security problem that might be caused by probing a file for its format.

This command starts a long-running copy. By default, the copy will pull the entire source chain into the destination file, but if @flags also contains VIR_DOMAIN_BLOCK_COPY_SHALLOW, then only the top of the source chain will be copied (the source and destination have a common backing file). The format of the destination file is controlled by the <driver> sub-element of the XML. The destination will be created unless the VIR_DOMAIN_BLOCK_COPY_REUSE_EXT flag is present stating that the file was pre-created with the correct format and metadata and sufficient size to hold the copy. In case the VIR_DOMAIN_BLOCK_COPY_SHALLOW flag is used the pre-created file has to exhibit the same guest visible contents as the backing file of the original image. This allows a management app to pre-create files with relative backing file names, rather than the default of absolute backing file names.

A copy job has two parts; in the first phase, the source is copied into the destination, and the job can only be canceled by reverting to the source file; progress in this phase can be tracked via the virDomainBlockJobInfo() command, with a job type of VIR_DOMAIN_BLOCK_JOB_TYPE_COPY. The job transitions to the second phase when the job info states cur == end, and remains alive to mirror all further changes to both source and destination. The user must call virDomainBlockJobAbort() to end the mirroring while choosing whether to revert to source or pivot to the destination. An event is issued when the job ends, and depending on the hypervisor, an event may also be issued when the job transitions from pulling to mirroring. If the job is aborted, a new job will have to start over from the beginning of the first phase.

Some hypervisors will restrict certain actions, such as virDomainSave() or virDomainDetachDevice(), while a copy job is active; they may also restrict a copy job to transient domains.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

The @params and @nparams arguments can be used to set hypervisor-specific tuning parameters, such as maximum bandwidth or granularity. For a parameter that the hypervisor understands, explicitly specifying 0 behaves the same as omitting the parameter, to use the hypervisor default; however, omitting a parameter is less likely to fail.

This command is a superset of the older virDomainBlockRebase() when used with the VIR_DOMAIN_BLOCK_REBASE_COPY flag, and offers better control over the destination format, the ability to copy to a destination that is not a local file, and the possibility of additional tuning parameters.

dom
pointer to domain object
disk
path to the block device, or device shorthand
destxml
XML description of the copy destination
params
Pointer to block copy parameter objects, or NULL
nparams
Number of block copy parameters (this value can be the same or less than the number of parameters supported)
flags
bitwise-OR of virDomainBlockCopyFlags
Returns
0 if the operation has started, -1 on failure.

virDomainBlockJobAbort

int	virDomainBlockJobAbort		(virDomainPtr dom,
					 const char * disk,
					 unsigned int flags)

Cancel the active block job on the given disk.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

If the current block job for @disk is VIR_DOMAIN_BLOCK_JOB_TYPE_PULL, then by default, this function performs a synchronous operation and the caller may assume that the operation has completed when 0 is returned. However, BlockJob operations may take a long time to cancel, and during this time further domain interactions may be unresponsive. To avoid this problem, pass VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC in the @flags argument to enable asynchronous behavior, returning as soon as possible. When the job has been canceled, a BlockJob event will be emitted, with status VIR_DOMAIN_BLOCK_JOB_CANCELED (even if the ABORT_ASYNC flag was not used); it is also possible to poll virDomainBlockJobInfo() to see if the job cancellation is still pending. This type of job can be restarted to pick up from where it left off.

If the current block job for @disk is VIR_DOMAIN_BLOCK_JOB_TYPE_COPY, then the default is to abort the mirroring and revert to the source disk; likewise, if the current job is VIR_DOMAIN_BLOCK_JOB_TYPE_ACTIVE_COMMIT, the default is to abort without changing the active layer of @disk. Adding @flags of VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT causes this call to fail with VIR_ERR_BLOCK_COPY_ACTIVE if the copy or commit is not yet ready; otherwise it will swap the disk over to the new active image to end the mirroring or active commit. An event will be issued when the job is ended, and it is possible to use VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC to control whether this command waits for the completion of the job. Restarting a copy or active commit job requires starting over from the beginning of the first phase.

dom
pointer to domain object
disk
path to the block device, or device shorthand
flags
bitwise-OR of virDomainBlockJobAbortFlags
Returns
-1 in case of failure, 0 when successful.

virDomainBlockJobSetSpeed

int	virDomainBlockJobSetSpeed	(virDomainPtr dom,
					 const char * disk,
					 unsigned long bandwidth,
					 unsigned int flags)

Set the maximimum allowable bandwidth that a block job may consume. If bandwidth is 0, the limit will revert to the hypervisor default of unlimited.

If @flags contains VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES, @bandwidth is in bytes/second; otherwise, it is in MiB/second. Values larger than 2^52 bytes/sec may be rejected due to overflow considerations based on the word size of both client and server, and values larger than 2^31 bytes/sec may cause overflow problems if later queried by virDomainGetBlockJobInfo() without scaling. Hypervisors may further restrict the range of valid bandwidth values.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

dom
pointer to domain object
disk
path to the block device, or device shorthand
bandwidth
specify bandwidth limit; flags determine the unit
flags
bitwise-OR of virDomainBlockJobSetSpeedFlags
Returns
-1 in case of failure, 0 when successful.

virDomainBlockPeek

int	virDomainBlockPeek		(virDomainPtr dom,
					 const char * disk,
					 unsigned long long offset,
					 size_t size,
					 void * buffer,
					 unsigned int flags)

This function allows you to read the contents of a domain's disk device.

Typical uses for this are to determine if the domain has written a Master Boot Record (indicating that the domain has completed installation), or to try to work out the state of the domain's filesystems.

(Note that in the local case you might try to open the block device or file directly, but that won't work in the remote case, nor if you don't have sufficient permission. Hence the need for this call).

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

'offset' and 'size' represent an area which must lie entirely within the device or file. 'size' may be 0 to test if the call would succeed.

'buffer' is the return buffer and must be at least 'size' bytes.

NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to <= 65536 bytes. However, with 0.9.13 this RPC limit has been raised to 1M byte. Starting with version 1.0.6 the RPC limit has been raised again. Now large requests up to 16M byte are supported.

dom
pointer to the domain object
disk
path to the block device, or device shorthand
offset
offset within block device
size
size to read
buffer
return buffer (must be at least size bytes)
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success or -1 in case of failure. really 64 bits

virDomainBlockPull

int	virDomainBlockPull		(virDomainPtr dom,
					 const char * disk,
					 unsigned long bandwidth,
					 unsigned int flags)

Populate a disk image with data from its backing image. Once all data from its backing image has been pulled, the disk no longer depends on a backing image. This function pulls data for the entire device in the background. Progress of the operation can be checked with virDomainGetBlockJobInfo() and the operation can be aborted with virDomainBlockJobAbort(). When finished, an asynchronous event is raised to indicate the final status. To move data in the opposite direction, see virDomainBlockCommit().

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

The maximum bandwidth that will be used to do the copy can be specified with the @bandwidth parameter. If set to 0, there is no limit. If @flags includes VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES, @bandwidth is in bytes/second; otherwise, it is in MiB/second. Values larger than 2^52 bytes/sec may be rejected due to overflow considerations based on the word size of both client and server, and values larger than 2^31 bytes/sec may cause overflow problems if later queried by virDomainGetBlockJobInfo() without scaling. Hypervisors may further restrict the range of valid bandwidth values. Some hypervisors do not support this feature and will return an error if bandwidth is not 0; in this case, it might still be possible for a later call to virDomainBlockJobSetSpeed() to succeed. The actual speed can be determined with virDomainGetBlockJobInfo().

This is shorthand for virDomainBlockRebase() with a NULL base.

dom
pointer to domain object
disk
path to the block device, or device shorthand
bandwidth
(optional) specify bandwidth limit; flags determine the unit
flags
bitwise-OR of virDomainBlockPullFlags
Returns
0 if the operation has started, -1 on failure.

virDomainBlockRebase

int	virDomainBlockRebase		(virDomainPtr dom,
					 const char * disk,
					 const char * base,
					 unsigned long bandwidth,
					 unsigned int flags)

Populate a disk image with data from its backing image chain, and setting the backing image to @base, or alternatively copy an entire backing chain to a new file @base.

When @flags is 0, this starts a pull, where @base must be the absolute path of one of the backing images further up the chain, or NULL to convert the disk image so that it has no backing image. Once all data from its backing image chain has been pulled, the disk no longer depends on those intermediate backing images. This function pulls data for the entire device in the background. Progress of the operation can be checked with virDomainGetBlockJobInfo() with a job type of VIR_DOMAIN_BLOCK_JOB_TYPE_PULL, and the operation can be aborted with virDomainBlockJobAbort(). When finished, an asynchronous event is raised to indicate the final status, and the job no longer exists. If the job is aborted, a new one can be started later to resume from the same point.

If @flags contains VIR_DOMAIN_BLOCK_REBASE_RELATIVE, the name recorded into the active disk as the location for @base will be kept relative. The operation will fail if libvirt can't infer the name.

When @flags includes VIR_DOMAIN_BLOCK_REBASE_COPY, this starts a copy, where @base must be the name of a new file to copy the chain to. By default, the copy will pull the entire source chain into the destination file, but if @flags also contains VIR_DOMAIN_BLOCK_REBASE_SHALLOW, then only the top of the source chain will be copied (the source and destination have a common backing file). By default, @base will be created with the same file format as the source, but this can be altered by adding VIR_DOMAIN_BLOCK_REBASE_COPY_RAW to force the copy to be raw (does not make sense with the shallow flag unless the source is also raw), or by using VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT to reuse an existing file which was pre-created with the correct format and metadata and sufficient size to hold the copy. In case the VIR_DOMAIN_BLOCK_REBASE_SHALLOW flag is used the pre-created file has to exhibit the same guest visible contents as the backing file of the original image. This allows a management app to pre-create files with relative backing file names, rather than the default of absolute backing file names; as a security precaution, you should generally only use reuse_ext with the shallow flag and a non-raw destination file. By default, the copy destination will be treated as type='file', but using VIR_DOMAIN_BLOCK_REBASE_COPY_DEV treats the destination as type='block' (affecting how virDomainGetBlockInfo() will report allocation after pivoting).

A copy job has two parts; in the first phase, the @bandwidth parameter affects how fast the source is pulled into the destination, and the job can only be canceled by reverting to the source file; progress in this phase can be tracked via the virDomainBlockJobInfo() command, with a job type of VIR_DOMAIN_BLOCK_JOB_TYPE_COPY. The job transitions to the second phase when the job info states cur == end, and remains alive to mirror all further changes to both source and destination. The user must call virDomainBlockJobAbort() to end the mirroring while choosing whether to revert to source or pivot to the destination. An event is issued when the job ends, and depending on the hypervisor, an event may also be issued when the job transitions from pulling to mirroring. If the job is aborted, a new job will have to start over from the beginning of the first phase.

Some hypervisors will restrict certain actions, such as virDomainSave() or virDomainDetachDevice(), while a copy job is active; they may also restrict a copy job to transient domains.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

The @base parameter can be either a path to a file within the backing chain, or the device target shorthand (the <target dev='...'/> sub-element, such as "vda") followed by an index to the backing chain enclosed in square brackets. Backing chain indexes can be found by inspecting //disk//backingStore/@index in the domain XML. Thus, for example, "vda[3]" refers to the backing store with index equal to "3" in the chain of disk "vda".

The maximum bandwidth that will be used to do the copy can be specified with the @bandwidth parameter. If set to 0, there is no limit. If @flags includes VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES, @bandwidth is in bytes/second; otherwise, it is in MiB/second. Values larger than 2^52 bytes/sec may be rejected due to overflow considerations based on the word size of both client and server, and values larger than 2^31 bytes/sec may cause overflow problems if later queried by virDomainGetBlockJobInfo() without scaling. Hypervisors may further restrict the range of valid bandwidth values. Some hypervisors do not support this feature and will return an error if bandwidth is not 0; in this case, it might still be possible for a later call to virDomainBlockJobSetSpeed() to succeed. The actual speed can be determined with virDomainGetBlockJobInfo().

When @base is NULL and @flags is 0, this is identical to virDomainBlockPull(). When @flags contains VIR_DOMAIN_BLOCK_REBASE_COPY, this command is shorthand for virDomainBlockCopy() where the destination XML encodes @base as a <disk type='file'>, @bandwidth is properly scaled and passed as a typed parameter, the shallow and reuse external flags are preserved, and remaining flags control whether the XML encodes a destination format of raw instead of leaving the destination identical to the source format or probed from the reused file.

dom
pointer to domain object
disk
path to the block device, or device shorthand
base
path to backing file to keep, or device shorthand, or NULL for no backing file
bandwidth
(optional) specify bandwidth limit; flags determine the unit
flags
bitwise-OR of virDomainBlockRebaseFlags
Returns
0 if the operation has started, -1 on failure.

virDomainBlockResize

int	virDomainBlockResize		(virDomainPtr dom,
					 const char * disk,
					 unsigned long long size,
					 unsigned int flags)

Resize a block device of domain while the domain is running. If @flags is 0, then @size is in kibibytes (blocks of 1024 bytes); since 0.9.11, if @flags includes VIR_DOMAIN_BLOCK_RESIZE_BYTES, @size is in bytes instead. @size is taken directly as the new size. Depending on the file format, the hypervisor may round up to the next alignment boundary.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

Note that this call may fail if the underlying virtualization hypervisor does not support it; this call requires privileged access to the hypervisor.

dom
pointer to the domain object
disk
path to the block image, or shorthand
size
new size of the block image, see below for unit
flags
bitwise-OR of virDomainBlockResizeFlags
Returns
0 in case of success or -1 in case of failure.

virDomainBlockStats

int	virDomainBlockStats		(virDomainPtr dom,
					 const char * disk,
					 virDomainBlockStatsPtr stats,
					 size_t size)

This function returns block device (disk) stats for block devices attached to the domain.

The @disk parameter is either the device target shorthand (the <target dev='...'/> sub-element, such as "vda"), or (since 0.9.8) an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk. Some drivers might also accept the empty string for the @disk parameter, and then yield summary stats for the entire domain.

Domains may have more than one block device. To get stats for each you should make multiple calls to this function.

Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.

dom
pointer to the domain object
disk
path to the block device, or device shorthand
stats
block device stats (returned)
size
size of stats structure
Returns
0 in case of success or -1 in case of failure.

virDomainBlockStatsFlags

int	virDomainBlockStatsFlags	(virDomainPtr dom,
					 const char * disk,
					 virTypedParameterPtr params,
					 int * nparams,
					 unsigned int flags)

This function is to get block stats parameters for block devices attached to the domain.

The @disk parameter is either the device target shorthand (the <target dev='...'/> sub-element, such as "vda"), or (since 0.9.8) an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk. Some drivers might also accept the empty string for the @disk parameter, and then yield summary stats for the entire domain.

Domains may have more than one block device. To get stats for each you should make multiple calls to this function.

On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value.

As a special case, calling with @params as NULL and @nparams as 0 on input will cause @nparams on output to contain the number of parameters supported by the hypervisor. (Note that block devices of different types might support different parameters, so it might be necessary to compute @nparams for each block device). The caller should then allocate @params array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API again. See virDomainGetMemoryParameters() for more details.

dom
pointer to domain object
disk
path to the block device, or device shorthand
params
pointer to block stats parameter object (return value, allocated by the caller)
nparams
pointer to number of block stats; input and output
flags
bitwise-OR of virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainCoreDump

int	virDomainCoreDump		(virDomainPtr domain,
					 const char * to,
					 unsigned int flags)

This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host. Hypervisors may require the user to manually ensure proper permissions on the file named by @to.

If @flags includes VIR_DUMP_CRASH, then leave the guest shut off with a crashed state after the dump completes. If @flags includes VIR_DUMP_LIVE, then make the core dump while continuing to allow the guest to run; otherwise, the guest is suspended during the dump. VIR_DUMP_RESET flag forces reset of the guest after dump. The above three flags are mutually exclusive.

Additionally, if @flags includes VIR_DUMP_BYPASS_CACHE, then libvirt will attempt to bypass the file system cache while creating the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing saves to NFS.

For more control over the output format, see virDomainCoreDumpWithFormat().

domain
a domain object
to
path for the core file
flags
bitwise-OR of virDomainCoreDumpFlags
Returns
0 in case of success and -1 in case of failure.

virDomainCoreDumpWithFormat

int	virDomainCoreDumpWithFormat	(virDomainPtr domain,
					 const char * to,
					 unsigned int dumpformat,
					 unsigned int flags)

This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host. Hypervisors may require the user to manually ensure proper permissions on the file named by @to.

@dumpformat controls which format the dump will have; use of VIR_DOMAIN_CORE_DUMP_FORMAT_RAW mirrors what virDomainCoreDump() will perform. Not all hypervisors are able to support all formats.

If @flags includes VIR_DUMP_CRASH, then leave the guest shut off with a crashed state after the dump completes. If @flags includes VIR_DUMP_LIVE, then make the core dump while continuing to allow the guest to run; otherwise, the guest is suspended during the dump. VIR_DUMP_RESET flag forces reset of the guest after dump. The above three flags are mutually exclusive.

Additionally, if @flags includes VIR_DUMP_BYPASS_CACHE, then libvirt will attempt to bypass the file system cache while creating the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing saves to NFS.

domain
a domain object
to
path for the core file
dumpformat
format of domain memory's dump (one of virDomainCoreDumpFormat enum)
flags
bitwise-OR of virDomainCoreDumpFlags
Returns
0 in case of success and -1 in case of failure.

virDomainCreate

int	virDomainCreate			(virDomainPtr domain)

Launch a defined domain. If the call succeeds the domain moves from the defined to the running domains pools. The domain will be paused only if restoring from managed state created from a paused domain. For more control, see virDomainCreateWithFlags().

domain
pointer to a defined domain
Returns
0 in case of success, -1 in case of error

virDomainCreateLinux

virDomainPtr	virDomainCreateLinux	(virConnectPtr conn,
					 const char * xmlDesc,
					 unsigned int flags)

Deprecated after 0.4.6. Renamed to virDomainCreateXML() providing identical functionality. This existing name will be left indefinitely for API compatibility.

conn
pointer to the hypervisor connection
xmlDesc
string containing an XML description of the domain
flags
extra flags; not used yet, so callers should always pass 0
Returns
a new domain object or NULL in case of failure

virDomainCreateWithFiles

int	virDomainCreateWithFiles	(virDomainPtr domain,
					 unsigned int nfiles,
					 int * files,
					 unsigned int flags)

Launch a defined domain. If the call succeeds the domain moves from the defined to the running domains pools.

@files provides an array of file descriptors which will be made available to the 'init' process of the guest. The file handles exposed to the guest will be renumbered to start from 3 (ie immediately following stderr). This is only supported for guests which use container based virtualization technology.

If the VIR_DOMAIN_START_PAUSED flag is set, or if the guest domain has a managed save image that requested paused state (see virDomainManagedSave()) the guest domain will be started, but its CPUs will remain paused. The CPUs can later be manually started using virDomainResume(). In all other cases, the guest domain will be running.

If the VIR_DOMAIN_START_AUTODESTROY flag is set, the guest domain will be automatically destroyed when the virConnectPtr object is finally released. This will also happen if the client application crashes / loses its connection to the libvirtd daemon. Any domains marked for auto destroy will block attempts at migration, save-to-file, or snapshots.

If the VIR_DOMAIN_START_BYPASS_CACHE flag is set, and there is a managed save file for this domain (created by virDomainManagedSave()), then libvirt will attempt to bypass the file system cache while restoring the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing loads from NFS.

If the VIR_DOMAIN_START_FORCE_BOOT flag is set, then any managed save file for this domain is discarded, and the domain boots from scratch.

domain
pointer to a defined domain
nfiles
number of file descriptors passed
files
list of file descriptors passed
flags
bitwise-OR of supported virDomainCreateFlags
Returns
0 in case of success, -1 in case of error

virDomainCreateWithFlags

int	virDomainCreateWithFlags	(virDomainPtr domain,
					 unsigned int flags)

Launch a defined domain. If the call succeeds the domain moves from the defined to the running domains pools.

If the VIR_DOMAIN_START_PAUSED flag is set, or if the guest domain has a managed save image that requested paused state (see virDomainManagedSave()) the guest domain will be started, but its CPUs will remain paused. The CPUs can later be manually started using virDomainResume(). In all other cases, the guest domain will be running.

If the VIR_DOMAIN_START_AUTODESTROY flag is set, the guest domain will be automatically destroyed when the virConnectPtr object is finally released. This will also happen if the client application crashes / loses its connection to the libvirtd daemon. Any domains marked for auto destroy will block attempts at migration, save-to-file, or snapshots.

If the VIR_DOMAIN_START_BYPASS_CACHE flag is set, and there is a managed save file for this domain (created by virDomainManagedSave()), then libvirt will attempt to bypass the file system cache while restoring the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing loads from NFS.

If the VIR_DOMAIN_START_FORCE_BOOT flag is set, then any managed save file for this domain is discarded, and the domain boots from scratch.

domain
pointer to a defined domain
flags
bitwise-OR of supported virDomainCreateFlags
Returns
0 in case of success, -1 in case of error

virDomainCreateXML

virDomainPtr	virDomainCreateXML	(virConnectPtr conn,
					 const char * xmlDesc,
					 unsigned int flags)

Launch a new guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may require privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).

If the VIR_DOMAIN_START_PAUSED flag is set, the guest domain will be started, but its CPUs will remain paused. The CPUs can later be manually started using virDomainResume.

If the VIR_DOMAIN_START_AUTODESTROY flag is set, the guest domain will be automatically destroyed when the virConnectPtr object is finally released. This will also happen if the client application crashes / loses its connection to the libvirtd daemon. Any domains marked for auto destroy will block attempts at migration, save-to-file, or snapshots.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
xmlDesc
string containing an XML description of the domain
flags
bitwise-OR of supported virDomainCreateFlags
Returns
a new domain object or NULL in case of failure

virDomainCreateXMLWithFiles

virDomainPtr	virDomainCreateXMLWithFiles	(virConnectPtr conn,
						 const char * xmlDesc,
						 unsigned int nfiles,
						 int * files,
						 unsigned int flags)

Launch a new guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may require privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).

@files provides an array of file descriptors which will be made available to the 'init' process of the guest. The file handles exposed to the guest will be renumbered to start from 3 (ie immediately following stderr). This is only supported for guests which use container based virtualization technology.

If the VIR_DOMAIN_START_PAUSED flag is set, the guest domain will be started, but its CPUs will remain paused. The CPUs can later be manually started using virDomainResume.

If the VIR_DOMAIN_START_AUTODESTROY flag is set, the guest domain will be automatically destroyed when the virConnectPtr object is finally released. This will also happen if the client application crashes / loses its connection to the libvirtd daemon. Any domains marked for auto destroy will block attempts at migration, save-to-file, or snapshots.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
xmlDesc
string containing an XML description of the domain
nfiles
number of file descriptors passed
files
list of file descriptors passed
flags
bitwise-OR of supported virDomainCreateFlags
Returns
a new domain object or NULL in case of failure

virDomainDefineXML

virDomainPtr	virDomainDefineXML	(virConnectPtr conn,
					 const char * xml)

Define a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine(). A previous definition for this domain would be overridden if it already exists.

Some hypervisors may prevent this operation if there is a current block copy operation on a transient domain with the same id as the domain being defined; in that case, use virDomainBlockJobAbort() to stop the block copy first.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
xml
the XML description for the domain, preferably in UTF-8
Returns
NULL in case of error, a pointer to the domain otherwise

virDomainDefineXMLFlags

virDomainPtr	virDomainDefineXMLFlags	(virConnectPtr conn,
					 const char * xml,
					 unsigned int flags)

Defines a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine(). A previous definition for this domain would be overridden if it already exists.

Some hypervisors may prevent this operation if there is a current block copy operation on a transient domain with the same id as the domain being defined; in that case, use virDomainBlockJobAbort() to stop the block copy first.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
xml
the XML description for the domain, preferably in UTF-8
flags
bitwise OR of the virDomainDefineFlags constants
Returns
NULL in case of error, a pointer to the domain otherwise

virDomainDelIOThread

int	virDomainDelIOThread		(virDomainPtr domain,
					 unsigned int iothread_id,
					 unsigned int flags)

Dynamically delete an IOThread from the domain. The @iothread_id to be deleted must not have a resource associated with it and can be any of the currently valid IOThread ID's.

Note that this call can fail if the underlying virtualization hypervisor does not support it or if reducing the number is arbitrarily limited. This function requires privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and may fail if domain is not alive. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed.

domain
a domain object
iothread_id
the specific IOThread ID value to delete
flags
bitwise-OR of virDomainModificationImpact
Returns
0 in case of success, -1 in case of failure.

virDomainDestroy

int	virDomainDestroy		(virDomainPtr domain)

Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virDomainPtr object. This function may require privileged access.

virDomainDestroy first requests that a guest terminate (e.g. SIGTERM), then waits for it to comply. After a reasonable timeout, if the guest still exists, virDomainDestroy will forcefully terminate the guest (e.g. SIGKILL) if necessary (which may produce undesirable results, for example unflushed disk cache in the guest). To avoid this possibility, it's recommended to instead call virDomainDestroyFlags, sending the VIR_DOMAIN_DESTROY_GRACEFUL flag.

If the domain is transient and has any snapshot metadata (see virDomainSnapshotNum()), then that metadata will automatically be deleted when the domain quits.

domain
a domain object
Returns
0 in case of success and -1 in case of failure.

virDomainDestroyFlags

int	virDomainDestroyFlags		(virDomainPtr domain,
					 unsigned int flags)

Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virDomainPtr object. This function may require privileged access.

Calling this function with no @flags set (equal to zero) is equivalent to calling virDomainDestroy, and after a reasonable timeout will forcefully terminate the guest (e.g. SIGKILL) if necessary (which may produce undesirable results, for example unflushed disk cache in the guest). Including VIR_DOMAIN_DESTROY_GRACEFUL in the flags will prevent the forceful termination of the guest, and virDomainDestroyFlags will instead return an error if the guest doesn't terminate by the end of the timeout; at that time, the management application can decide if calling again without VIR_DOMAIN_DESTROY_GRACEFUL is appropriate.

Another alternative which may produce cleaner results for the guest's disks is to use virDomainShutdown() instead, but that depends on guest support (some hypervisor/guest combinations may ignore the shutdown request).

domain
a domain object
flags
bitwise-OR of virDomainDestroyFlagsValues
Returns
0 in case of success and -1 in case of failure.

virDomainDetachDevice

int	virDomainDetachDevice		(virDomainPtr domain,
					 const char * xml)

This is an equivalent of virDomainDetachDeviceFlags() when called with @flags parameter set to VIR_DOMAIN_AFFECT_LIVE.

See virDomainDetachDeviceFlags() for more details.

domain
pointer to domain object
xml
pointer to XML description of one device
Returns
0 in case of success, -1 in case of failure.

virDomainDetachDeviceFlags

int	virDomainDetachDeviceFlags	(virDomainPtr domain,
					 const char * xml,
					 unsigned int flags)

Detach a virtual device from a domain, using the flags parameter to control how the device is detached. VIR_DOMAIN_AFFECT_CURRENT specifies that the device allocation is removed based on current domain state. VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be deallocated from the active domain instance only and is not from the persisted domain configuration. VIR_DOMAIN_AFFECT_CONFIG specifies that the device shall be deallocated from the persisted domain configuration only. Note that the target hypervisor must return an error if unable to satisfy flags. E.g. the hypervisor driver will return failure if LIVE is specified but it only supports removing the persisted device allocation.

Some hypervisors may prevent this operation if there is a current block copy operation on the device being detached; in that case, use virDomainBlockJobAbort() to stop the block copy first.

Beware that depending on the hypervisor and device type, detaching a device from a running domain may be asynchronous. That is, calling virDomainDetachDeviceFlags may just request device removal while the device is actually removed later (in cooperation with a guest OS). Previously, this fact was ignored and the device could have been removed from domain configuration before it was actually removed by the hypervisor causing various failures on subsequent operations. To check whether the device was successfully removed, either recheck domain configuration using virDomainGetXMLDesc() or add a handler for the VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED event. In case the device is already gone when virDomainDetachDeviceFlags returns, the event is delivered before this API call ends. To help existing clients work better in most cases, this API will try to transform an asynchronous device removal that finishes shortly after the request into a synchronous removal. In other words, this API may wait a bit for the removal to complete in case it was not synchronous.

Be aware that hotplug changes might not persist across a domain going into S4 state (also known as hibernation) unless you also modify the persistent domain definition.

The supplied XML description of the device should be as specific as its definition in the domain XML. The set of attributes used to match the device are internal to the drivers. Using a partial definition, or attempting to detach a device that is not present in the domain XML, but shares some specific attributes with one that is present, may lead to unexpected results.

domain
pointer to domain object
xml
pointer to XML description of one device
flags
bitwise-OR of virDomainDeviceModifyFlags
Returns
0 in case of success, -1 in case of failure.

virDomainFSFreeze

int	virDomainFSFreeze		(virDomainPtr dom,
					 const char ** mountpoints,
					 unsigned int nmountpoints,
					 unsigned int flags)

Freeze specified filesystems within the guest (hence guest agent may be required depending on hypervisor used). If @mountpoints is NULL and @nmountpoints is 0, every mounted filesystem on the guest is frozen. In some environments (e.g. QEMU guest with guest agent which doesn't support mountpoints argument), @mountpoints may need to be NULL.

dom
a domain object
mountpoints
list of mount points to be frozen
nmountpoints
the number of mount points specified in @mountpoints
flags
extra flags; not used yet, so callers should always pass 0
Returns
the number of frozen filesystems on success, -1 otherwise.

virDomainFSInfoFree

void	virDomainFSInfoFree		(virDomainFSInfoPtr info)

Frees all the memory occupied by @info.

info
pointer to a FSInfo object

virDomainFSThaw

int	virDomainFSThaw			(virDomainPtr dom,
					 const char ** mountpoints,
					 unsigned int nmountpoints,
					 unsigned int flags)

Thaw specified filesystems within the guest. If @mountpoints is NULL and @nmountpoints is 0, every mounted filesystem on the guest is thawed. In some drivers (e.g. QEMU driver), @mountpoints may need to be NULL.

dom
a domain object
mountpoints
list of mount points to be thawed
nmountpoints
the number of mount points specified in @mountpoints
flags
extra flags; not used yet, so callers should always pass 0
Returns
the number of thawed filesystems on success, -1 otherwise.

virDomainFSTrim

int	virDomainFSTrim			(virDomainPtr dom,
					 const char * mountPoint,
					 unsigned long long minimum,
					 unsigned int flags)

Calls FITRIM within the guest (hence guest agent may be required depending on hypervisor used). Either call it on each mounted filesystem (@mountPoint is NULL) or just on specified @mountPoint. @minimum hints that free ranges smaller than this may be ignored (this is a hint and the guest may not respect it). By increasing this value, the fstrim operation will complete more quickly for filesystems with badly fragmented free space, although not all blocks will be discarded. If @minimum is not zero, the command may fail.

dom
a domain object
mountPoint
which mount point to trim
minimum
Minimum contiguous free range to discard in bytes
flags
extra flags, not used yet, so callers should always pass 0
Returns
0 on success, -1 otherwise.

virDomainFree

int	virDomainFree			(virDomainPtr domain)

Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.

domain
a domain object
Returns
0 in case of success and -1 in case of failure.

virDomainGetAutostart

int	virDomainGetAutostart		(virDomainPtr domain,
					 int * autostart)

Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.

domain
a domain object
autostart
the value returned
Returns
-1 in case of error, 0 in case of success

virDomainGetBlkioParameters

int	virDomainGetBlkioParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int * nparams,
					 unsigned int flags)

Get all blkio parameters. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value.

As a special case, calling with @params as NULL and @nparams as 0 on input will cause @nparams on output to contain the number of parameters supported by the hypervisor. The caller should then allocate @params array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API again.

See virDomainGetMemoryParameters() for an equivalent usage example.

This function may require privileged access to the hypervisor. This function expects the caller to allocate the @params.

domain
pointer to domain object
params
pointer to blkio parameter object (return value, allocated by the caller)
nparams
pointer to number of blkio parameters; input and output
flags
bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainGetBlockInfo

int	virDomainGetBlockInfo		(virDomainPtr domain,
					 const char * disk,
					 virDomainBlockInfoPtr info,
					 unsigned int flags)

Extract information about a domain's block device.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

For QEMU domains, the allocation and physical virDomainBlockInfo values returned will generally be the same, except when using a non raw, block backing device, such as qcow2 for an active domain. When the persistent domain is not active, QEMU will return the default which is the same value for allocation and physical.

Active QEMU domains can return an allocation value which is more representative of the currently used blocks by the device compared to the physical size of the device. Applications can use/monitor the allocation value with the understanding that if the domain becomes inactive during an attempt to get the value, the default values will be returned. Thus, the application should check after the call for the domain being inactive if the values are the same. Optionally, the application could be watching for a shutdown event and then ignore any values received afterwards. This can be an issue when a domain is being migrated and the exact timing of the domain being made inactive and check of the allocation value results the default being returned. For a transient domain in the similar situation, this call will return -1 and an error message indicating the "domain is not running".

The following is some pseudo code illustrating the call sequence:

...
virDomainPtr dom;
virDomainBlockInfo info;
char *device;
...
// Either get a list of all domains or a specific domain
// via a virDomainLookupBy*() call.
//
// It's also required to fill in the device pointer, but that's
// specific to the implementation. For the purposes of this example
// a qcow2 backed device name string would need to be provided.
...
// If the following call is made on a persistent domain with a
// qcow2 block backed block device, then it's possible the returned
// allocation equals the physical value. In that case, the domain
// that may have been active prior to calling has become inactive,
// such as is the case during a domain migration. Thus once we
// get data returned, check for active domain when the values are
// the same.
if (virDomainGetBlockInfo(dom, device, &info, 0) < 0)
    goto failure;
if (info.allocation == info.physical) {
    // If the domain is no longer active,
    // then the defaults are being returned.
    if (!virDomainIsActive())
            goto ignore_return;
}
// Do something with the allocation and physical values
...
domain
a domain object
disk
path to the block device, or device shorthand
info
pointer to a virDomainBlockInfo structure allocated by the user
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success and -1 in case of failure.

virDomainGetBlockIoTune

int	virDomainGetBlockIoTune		(virDomainPtr dom,
					 const char * disk,
					 virTypedParameterPtr params,
					 int * nparams,
					 unsigned int flags)

Get all block IO tunable parameters for a given device. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value.

As a special case, calling with @params as NULL and @nparams as 0 on input will cause @nparams on output to contain the number of parameters supported by the hypervisor, either for the given @disk (note that block devices of different types might support different parameters), or if @disk is NULL, for all possible disks. The caller should then allocate @params array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API again. See virDomainGetMemoryParameters() for more details.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or the device target shorthand (the <target dev='...'/> sub-element, such as "xvda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk. This parameter cannot be NULL unless @nparams is 0 on input.

dom
pointer to domain object
disk
path to the block device, or device shorthand
params
Pointer to blkio parameter object (return value, allocated by the caller)
nparams
Pointer to number of blkio parameters
flags
bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainGetBlockJobInfo

int	virDomainGetBlockJobInfo	(virDomainPtr dom,
					 const char * disk,
					 virDomainBlockJobInfoPtr info,
					 unsigned int flags)

Request block job information for the given disk. If an operation is active @info will be updated with the current progress. The units used for the bandwidth field of @info depends on @flags. If @flags includes VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES, bandwidth is in bytes/second (although this mode can risk failure due to overflow, depending on both client and server word size); otherwise, the value is rounded up to MiB/s.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or (since 0.9.5) the device target shorthand (the <target dev='...'/> sub-element, such as "vda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

As a corner case underlying hypervisor may report cur == 0 and end == 0 when the block job hasn't been started yet. In this case libvirt reports cur = 0 and end = 1. However, hypervisor may return cur == 0 and end == 0 if the block job has finished and was no-op. In this case libvirt reports cur = 1 and end = 1. Since 2.3.0.

dom
pointer to domain object
disk
path to the block device, or device shorthand
info
pointer to a virDomainBlockJobInfo structure
flags
bitwise-OR of virDomainBlockJobInfoFlags
Returns
-1 in case of failure, 0 when nothing found, 1 when info was found.

virDomainGetCPUStats

int	virDomainGetCPUStats		(virDomainPtr domain,
					 virTypedParameterPtr params,
					 unsigned int nparams,
					 int start_cpu,
					 unsigned int ncpus,
					 unsigned int flags)

Get statistics relating to CPU usage attributable to a single domain (in contrast to the statistics returned by virNodeGetCPUStats() for all processes on the host). @dom must be running (an inactive domain has no attributable cpu usage). On input, @params must contain at least @nparams * @ncpus entries, allocated by the caller.

If @start_cpu is -1, then @ncpus must be 1, and the returned results reflect the statistics attributable to the entire domain (such as user and system time for the process as a whole). Otherwise, @start_cpu represents which cpu to start with, and @ncpus represents how many consecutive processors to query, with statistics attributable per processor (such as per-cpu usage). If @ncpus is larger than the number of cpus available to query, then the trailing part of the array will be unpopulated.

The remote driver imposes a limit of 128 @ncpus and 16 @nparams; the number of parameters per cpu should not exceed 16, but if you have a host with more than 128 CPUs, your program should split the request into multiple calls.

As special cases, if @params is NULL and @nparams is 0 and @ncpus is 1, and the return value will be how many statistics are available for the given @start_cpu. This number may be different for @start_cpu of -1 than for any non-negative value, but will be the same for all non-negative @start_cpu. Likewise, if @params is NULL and @nparams is 0 and @ncpus is 0, the number of cpus available to query is returned. From the host perspective, this would typically match the cpus member of virNodeGetInfo(), but might be less due to host cpu hotplug.

For now, @flags is unused, and the statistics all relate to the usage from the host perspective. It is possible that a future version will support a flag that queries the cpu usage from the guest's perspective, where the maximum cpu to query would be related to virDomainGetVcpusFlags() rather than virNodeGetInfo(). An individual guest vcpu cannot be reliably mapped back to a specific host cpu unless a single-processor vcpu pinning was used, but when @start_cpu is -1, any difference in usage between a host and guest perspective would serve as a measure of hypervisor overhead.

Typical use sequence is below.

getting total stats: set start_cpu as -1, ncpus 1

virDomainGetCPUStats(dom, NULL, 0, -1, 1, 0); // nparams
params = calloc(nparams, sizeof(virTypedParameter))
virDomainGetCPUStats(dom, params, nparams, -1, 1, 0); // total stats.

getting per-cpu stats:

virDomainGetCPUStats(dom, NULL, 0, 0, 0, 0); // ncpus
virDomainGetCPUStats(dom, NULL, 0, 0, 1, 0); // nparams
params = calloc(ncpus * nparams, sizeof(virTypedParameter));
virDomainGetCPUStats(dom, params, nparams, 0, ncpus, 0); // per-cpu stats
domain
domain to query
params
array to populate on output
nparams
number of parameters per cpu
start_cpu
which cpu to start with, or -1 for summary
ncpus
how many cpus to query
flags
bitwise-OR of virTypedParameterFlags
Returns
-1 on failure, or the number of statistics that were populated per cpu on success (this will be less than the total number of populated @params, unless @ncpus was 1; and may be less than @nparams). The populated parameters start at each stride of @nparams, which means the results may be discontiguous; any unpopulated parameters will be zeroed on success (this includes skipped elements if @nparams is too large, and tail elements if @ncpus is too large). The caller is responsible for freeing any returned string parameters.

virDomainGetConnect

virConnectPtr	virDomainGetConnect	(virDomainPtr dom)

Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call.

WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the domain object together.

dom
pointer to a domain
Returns
the virConnectPtr or NULL in case of failure.

virDomainGetControlInfo

int	virDomainGetControlInfo		(virDomainPtr domain,
					 virDomainControlInfoPtr info,
					 unsigned int flags)

Extract details about current state of control interface to a domain.

domain
a domain object
info
pointer to a virDomainControlInfo structure allocated by the user
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success and -1 in case of failure.

virDomainGetDiskErrors

int	virDomainGetDiskErrors		(virDomainPtr dom,
					 virDomainDiskErrorPtr errors,
					 unsigned int maxerrors,
					 unsigned int flags)

The function populates @errors array with all disks that encountered an I/O error. Disks with no error will not be returned in the @errors array. Each disk is identified by its target (the dev attribute of target subelement in domain XML), such as "vda", and accompanied with the error that was seen on it. The caller is also responsible for calling free() on each disk name returned.

In a special case when @errors is NULL and @maxerrors is 0, the function returns preferred size of @errors that the caller should use to get all disk errors.

Since calling virDomainGetDiskErrors(dom, NULL, 0, 0) to get preferred size of @errors array and getting the errors are two separate operations, new disks may be hotplugged to the domain and new errors may be encountered between the two calls. Thus, this function may not return all disk errors because the supplied array is not large enough. Such errors may, however, be detected by listening to domain events.

dom
a domain object
errors
array to populate on output
maxerrors
size of @errors array
flags
extra flags; not used yet, so callers should always pass 0
Returns
number of disks with errors filled in the @errors array or -1 on error.

virDomainGetEmulatorPinInfo

int	virDomainGetEmulatorPinInfo	(virDomainPtr domain,
					 unsigned char * cpumap,
					 int maplen,
					 unsigned int flags)

Query the CPU affinity setting of all emulator threads of domain, store it in cpumap.

domain
pointer to domain object, or NULL for Domain0
cpumap
pointer to a bit map of real CPUs for all emulator threads of this domain (in 8-bit bytes) (OUT) There is only one cpumap for all emulator threads. Must not be NULL.
maplen
the number of bytes in one cpumap, from 1 up to size of CPU map. Must be positive.
flags
bitwise-OR of virDomainModificationImpact Must not be VIR_DOMAIN_AFFECT_LIVE and VIR_DOMAIN_AFFECT_CONFIG concurrently.
Returns
1 in case of success, 0 in case of no emulator threads are pined to pcpus, -1 in case of failure.

virDomainGetFSInfo

int	virDomainGetFSInfo		(virDomainPtr dom,
					 virDomainFSInfoPtr ** info,
					 unsigned int flags)

Get a list of mapping information for each mounted file systems within the specified guest and the disks.

dom
a domain object
info
a pointer to a variable to store an array of mount points information
flags
extra flags; not used yet, so callers should always pass 0
Returns
the number of returned mount points, or -1 in case of error. On success, the array of the information is stored into @info. The caller is responsible for calling virDomainFSInfoFree() on each array element, then calling free() on @info. On error, @info is set to NULL.

virDomainGetGuestVcpus

int	virDomainGetGuestVcpus		(virDomainPtr domain,
					 virTypedParameterPtr * params,
					 unsigned int * nparams,
					 unsigned int flags)

Queries the guest agent for state and information regarding vCPUs from guest's perspective. The reported data depends on the guest agent implementation.

Reported fields stored in @params: 'vcpus': string containing bitmap representing vCPU ids as reported by the guest 'online': string containing bitmap representing online vCPUs as reported by the guest agent. 'offlinable': string containing bitmap representing ids of vCPUs that can be offlined

This API requires the VM to run. The caller is responsible for calling virTypedParamsFree to free memory returned in @params.

domain
pointer to domain object
params
pointer that will be filled with an array of typed parameters
nparams
pointer filled with number of elements in @params
flags
currently unused, callers shall pass 0
Returns
0 on success, -1 on error.

virDomainGetHostname

char *	virDomainGetHostname		(virDomainPtr domain,
					 unsigned int flags)

Get the hostname for that domain.

Dependent on hypervisor used, this may require a guest agent to be available.

domain
a domain object
flags
extra flags; not used yet, so callers should always pass 0
Returns
the hostname which must be freed by the caller, or NULL if there was an error.

virDomainGetID

unsigned int	virDomainGetID		(virDomainPtr domain)

Get the hypervisor ID number for the domain

domain
a domain object
Returns
the domain ID number or (unsigned int) -1 in case of error

virDomainGetIOThreadInfo

int	virDomainGetIOThreadInfo	(virDomainPtr dom,
					 virDomainIOThreadInfoPtr ** info,
					 unsigned int flags)

Fetch IOThreads of an active domain including the cpumap information to determine on which CPU the IOThread has affinity to run.

dom
a domain object
info
pointer to an array of virDomainIOThreadInfo structures (OUT)
flags
bitwise-OR of virDomainModificationImpact Must not be VIR_DOMAIN_AFFECT_LIVE and VIR_DOMAIN_AFFECT_CONFIG concurrently.
Returns
the number of IOThreads or -1 in case of error. On success, the array of information is stored into @info. The caller is responsible for calling virDomainIOThreadInfoFree() on each array element, then calling free() on @info. On error, @info is set to NULL.

virDomainGetInfo

int	virDomainGetInfo		(virDomainPtr domain,
					 virDomainInfoPtr info)

Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.

domain
a domain object
info
pointer to a virDomainInfo structure allocated by the user
Returns
0 in case of success and -1 in case of failure.

virDomainGetInterfaceParameters

int	virDomainGetInterfaceParameters	(virDomainPtr domain,
					 const char * device,
					 virTypedParameterPtr params,
					 int * nparams,
					 unsigned int flags)

Get all interface parameters. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value.

As a special case, calling with @params as NULL and @nparams as 0 on input will cause @nparams on output to contain the number of parameters supported by the hypervisor. The caller should then allocate @params array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API again. See virDomainGetMemoryParameters() for an equivalent usage example.

This function may require privileged access to the hypervisor. This function expects the caller to allocate the @params.

domain
pointer to domain object
device
the interface name or mac address
params
pointer to interface parameter objects (return value, allocated by the caller)
nparams
pointer to number of interface parameter; input and output
flags
bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainGetJobInfo

int	virDomainGetJobInfo		(virDomainPtr domain,
					 virDomainJobInfoPtr info)

Extract information about progress of a background job on a domain. Will return an error if the domain is not active.

This function returns a limited amount of information in comparison to virDomainGetJobStats().

domain
a domain object
info
pointer to a virDomainJobInfo structure allocated by the user
Returns
0 in case of success and -1 in case of failure.

virDomainGetJobStats

int	virDomainGetJobStats		(virDomainPtr domain,
					 int * type,
					 virTypedParameterPtr * params,
					 int * nparams,
					 unsigned int flags)

Extract information about progress of a background job on a domain. Will return an error if the domain is not active. The function returns a superset of progress information provided by virDomainGetJobInfo. Possible fields returned in @params are defined by VIR_DOMAIN_JOB_* macros and new fields will likely be introduced in the future so callers may receive fields that they do not understand in case they talk to a newer server.

When @flags contains VIR_DOMAIN_JOB_STATS_COMPLETED, the function will return statistics about a recently completed job. Specifically, this flag may be used to query statistics of a completed incoming pre-copy migration (statistics for post-copy migration are only available on the source hsot). Statistics of a completed job are automatically destroyed once read or when libvirtd is restarted. Note that time information returned for completed migrations may be completely irrelevant unless both source and destination hosts have synchronized time (i.e., NTP daemon is running on both of them). The statistics of a completed job can also be obtained by listening to a VIR_DOMAIN_EVENT_ID_JOB_COMPLETED event (on the source host in case of a migration job).

domain
a domain object
type
where to store the job type (one of virDomainJobType)
params
where to store job statistics
nparams
number of items in @params
flags
bitwise-OR of virDomainGetJobStatsFlags
Returns
0 in case of success and -1 in case of failure.

virDomainGetMaxMemory

unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)

Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.

domain
a domain object or NULL
Returns
the memory size in kibibytes (blocks of 1024 bytes), or 0 in case of error.

virDomainGetMaxVcpus

int	virDomainGetMaxVcpus		(virDomainPtr domain)

Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus(). If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with. For more details, see virDomainGetVcpusFlags().

domain
pointer to domain object
Returns
the maximum of virtual CPU or -1 in case of error.

virDomainGetMemoryParameters

int	virDomainGetMemoryParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int * nparams,
					 unsigned int flags)

Get all memory parameters. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value.

As a special case, calling with @params as NULL and @nparams as 0 on input will cause @nparams on output to contain the number of parameters supported by the hypervisor. The caller should then allocate @params array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API again.

Here is a sample code snippet:

if (virDomainGetMemoryParameters(dom, NULL, &nparams, 0) == 0 &&
    nparams != 0) {
    if ((params = malloc(sizeof(*params) * nparams)) == NULL)
        goto error;
    memset(params, 0, sizeof(*params) * nparams);
    if (virDomainGetMemoryParameters(dom, params, &nparams, 0))
        goto error;
}

This function may require privileged access to the hypervisor. This function expects the caller to allocate the @params.

domain
pointer to domain object
params
pointer to memory parameter object (return value, allocated by the caller)
nparams
pointer to number of memory parameters; input and output
flags
bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainGetMetadata

char *	virDomainGetMetadata		(virDomainPtr domain,
					 int type,
					 const char * uri,
					 unsigned int flags)

Retrieves the appropriate domain element given by @type. If VIR_DOMAIN_METADATA_ELEMENT is requested parameter @uri must be set to the name of the namespace the requested elements belong to, otherwise must be NULL.

If an element of the domain XML is not present, the resulting error will be VIR_ERR_NO_DOMAIN_METADATA. This method forms a shortcut for seeing information from virDomainSetMetadata() without having to go through virDomainGetXMLDesc().

@flags controls whether the live domain or persistent configuration will be queried.

domain
a domain object
type
type of metadata, from virDomainMetadataType
uri
XML namespace identifier
flags
bitwise-OR of virDomainModificationImpact
Returns
the metadata string on success (caller must free), or NULL in case of failure.

virDomainGetName

const char *	virDomainGetName	(virDomainPtr domain)

Get the public name for that domain

domain
a domain object
Returns
a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.

virDomainGetNumaParameters

int	virDomainGetNumaParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int * nparams,
					 unsigned int flags)

Get all numa parameters. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value.

As a special case, calling with @params as NULL and @nparams as 0 on input will cause @nparams on output to contain the number of parameters supported by the hypervisor. The caller should then allocate @params array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API again.

See virDomainGetMemoryParameters() for an equivalent usage example.

This function may require privileged access to the hypervisor. This function expects the caller to allocate the @params.

domain
pointer to domain object
params
pointer to numa parameter object (return value, allocated by the caller)
nparams
pointer to number of numa parameters
flags
bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainGetOSType

char *	virDomainGetOSType		(virDomainPtr domain)

Get the type of domain operation system.

domain
a domain object
Returns
the new string or NULL in case of error, the string must be freed by the caller.

virDomainGetPerfEvents

int	virDomainGetPerfEvents		(virDomainPtr domain,
					 virTypedParameterPtr * params,
					 int * nparams,
					 unsigned int flags)

Get all Linux perf events setting. Possible fields returned in @params are defined by VIR_PERF_EVENT_* macros and new fields will likely be introduced in the future.

Linux perf events are performance analyzing tool in Linux.

domain
a domain object
params
where to store perf events setting
nparams
number of items in @params
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of failure, 0 in case of success.

virDomainGetSchedulerParameters

int	virDomainGetSchedulerParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int * nparams)

Get all scheduler parameters. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value. @nparams cannot be 0.

It is hypervisor specific whether this returns the live or persistent state; for more control, use virDomainGetSchedulerParametersFlags().

domain
pointer to domain object
params
pointer to scheduler parameter objects (return value)
nparams
pointer to number of scheduler parameter objects (this value should generally be as large as the returned value nparams of virDomainGetSchedulerType()); input and output
Returns
-1 in case of error, 0 in case of success.

virDomainGetSchedulerParametersFlags

int	virDomainGetSchedulerParametersFlags	(virDomainPtr domain,
						 virTypedParameterPtr params,
						 int * nparams,
						 unsigned int flags)

Get all scheduler parameters. On input, @nparams gives the size of the @params array; on output, @nparams gives how many slots were filled with parameter information, which might be less but will not exceed the input value. @nparams cannot be 0.

The value of @flags can be exactly VIR_DOMAIN_AFFECT_CURRENT, VIR_DOMAIN_AFFECT_LIVE, or VIR_DOMAIN_AFFECT_CONFIG.

Here is a sample code snippet:

char *ret = virDomainGetSchedulerType(dom, &nparams);
if (ret && nparams != 0) {
    if ((params = malloc(sizeof(*params) * nparams)) == NULL)
        goto error;
    memset(params, 0, sizeof(*params) * nparams);
    if (virDomainGetSchedulerParametersFlags(dom, params, &nparams, 0))
        goto error;
}
domain
pointer to domain object
params
pointer to scheduler parameter object (return value)
nparams
pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType()); input and output
flags
bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
Returns
-1 in case of error, 0 in case of success.

virDomainGetSchedulerType

char *	virDomainGetSchedulerType	(virDomainPtr domain,
					 int * nparams)

Get the scheduler type and the number of scheduler parameters.

domain
pointer to domain object
nparams
pointer to number of scheduler parameters, can be NULL (return value)
Returns
NULL in case of error. The caller must free the returned string.

virDomainGetSecurityLabel

int	virDomainGetSecurityLabel	(virDomainPtr domain,
					 virSecurityLabelPtr seclabel)

Extract security label of an active domain. The 'label' field in the @seclabel argument will be initialized to the empty string if the domain is not running under a security model.

domain
a domain object
seclabel
pointer to a virSecurityLabel structure
Returns
0 in case of success, -1 in case of failure

virDomainGetSecurityLabelList

int	virDomainGetSecurityLabelList	(virDomainPtr domain,
					 virSecurityLabelPtr * seclabels)

Extract the security labels of an active domain. The 'label' field in the @seclabels argument will be initialized to the empty string if the domain is not running under a security model.

domain
a domain object
seclabels
will be auto-allocated and filled with domains' security labels. Caller must free memory on return.
Returns
number of elemnets in @seclabels on success, -1 in case of failure.

virDomainGetState

int	virDomainGetState		(virDomainPtr domain,
					 int * state,
					 int * reason,
					 unsigned int flags)

Extract domain state. Each state can be accompanied with a reason (if known) which led to the state.

domain
a domain object
state
returned state of the domain (one of virDomainState)
reason
returned reason which led to @state (one of virDomain*Reason corresponding to the current state); it is allowed to be NULL
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success and -1 in case of failure.

virDomainGetTime

int	virDomainGetTime		(virDomainPtr dom,
					 long long * seconds,
					 unsigned int * nseconds,
					 unsigned int flags)

Extract information about guest time and store it into @seconds and @nseconds. The @seconds represents the number of seconds since the UNIX Epoch of 1970-01-01 00:00:00 in UTC.

Please note that some hypervisors may require guest agent to be configured and running in order to run this API.

dom
a domain object
seconds
domain's time in seconds
nseconds
the nanoscond part of @seconds
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 on success, -1 otherwise.

virDomainGetUUID

int	virDomainGetUUID		(virDomainPtr domain,
					 unsigned char * uuid)

Get the UUID for a domain

domain
a domain object
uuid
pointer to a VIR_UUID_BUFLEN bytes array
Returns
-1 in case of error, 0 in case of success

virDomainGetUUIDString

int	virDomainGetUUIDString		(virDomainPtr domain,
					 char * buf)

Get the UUID for a domain as string. For more information about UUID see RFC4122.

domain
a domain object
buf
pointer to a VIR_UUID_STRING_BUFLEN bytes array
Returns
-1 in case of error, 0 in case of success

virDomainGetVcpuPinInfo

int	virDomainGetVcpuPinInfo		(virDomainPtr domain,
					 int ncpumaps,
					 unsigned char * cpumaps,
					 int maplen,
					 unsigned int flags)

Query the CPU affinity setting of all virtual CPUs of domain, store it in cpumaps.

domain
pointer to domain object, or NULL for Domain0
ncpumaps
the number of cpumap (listed first to match virDomainGetVcpus)
cpumaps
pointer to a bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) It's assumed there is <ncpumaps> cpumap in cpumaps array. The memory allocated to cpumaps must be (ncpumaps * maplen) bytes (ie: calloc(ncpumaps, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API. Must not be NULL.
maplen
the number of bytes in one cpumap, from 1 up to size of CPU map. Must be positive.
flags
bitwise-OR of virDomainModificationImpact Must not be VIR_DOMAIN_AFFECT_LIVE and VIR_DOMAIN_AFFECT_CONFIG concurrently.
Returns
the number of virtual CPUs in case of success, -1 in case of failure.

virDomainGetVcpus

int	virDomainGetVcpus		(virDomainPtr domain,
					 virVcpuInfoPtr info,
					 int maxinfo,
					 unsigned char * cpumaps,
					 int maplen)

Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn't NULL. This call may fail on an inactive domain.

See also virDomainGetVcpuPinInfo for querying just cpumaps, including on an inactive domain.

domain
pointer to domain object, or NULL for Domain0
info
pointer to an array of virVcpuInfo structures (OUT)
maxinfo
number of structures in info array
cpumaps
pointer to a bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It's assumed there is <maxinfo> cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.
maplen
number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). Must be zero when cpumaps is NULL and positive when it is non-NULL.
Returns
the number of info filled in case of success, -1 in case of failure.

virDomainGetVcpusFlags

int	virDomainGetVcpusFlags		(virDomainPtr domain,
					 unsigned int flags)

Query the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it. This function may require privileged access to the hypervisor.

If @flags includes VIR_DOMAIN_AFFECT_LIVE, this will query a running domain (which will fail if domain is not active); if it includes VIR_DOMAIN_AFFECT_CONFIG, this will query the XML description of the domain. It is an error to set both flags. If neither flag is set (that is, VIR_DOMAIN_AFFECT_CURRENT), then the configuration queried depends on whether the domain is currently running.

If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then the maximum virtual CPU limit is queried. Otherwise, this call queries the current virtual CPU count.

If @flags includes VIR_DOMAIN_VCPU_GUEST, then the state of the processors is queried in the guest instead of the hypervisor. This flag is only usable on live domains. Guest agent may be needed for this flag to be available.

domain
pointer to domain object, or NULL for Domain0
flags
bitwise-OR of virDomainVcpuFlags
Returns
the number of vCPUs in case of success, -1 in case of failure.

virDomainGetXMLDesc

char *	virDomainGetXMLDesc		(virDomainPtr domain,
					 unsigned int flags)

Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateXML().

No security-sensitive data will be included unless @flags contains VIR_DOMAIN_XML_SECURE; this flag is rejected on read-only connections. If @flags includes VIR_DOMAIN_XML_INACTIVE, then the XML represents the configuration that will be used on the next boot of a persistent domain; otherwise, the configuration represents the currently running domain. If @flags contains VIR_DOMAIN_XML_UPDATE_CPU, then the portion of the domain XML describing CPU capabilities is modified to match actual capabilities of the host.

domain
a domain object
flags
bitwise-OR of virDomainXMLFlags
Returns
a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.

virDomainHasManagedSaveImage

int	virDomainHasManagedSaveImage	(virDomainPtr dom,
					 unsigned int flags)

Check if a domain has a managed save image as created by virDomainManagedSave(). Note that any running domain should not have such an image, as it should have been removed on restart.

dom
pointer to the domain
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 if no image is present, 1 if an image is present, and -1 in case of error

virDomainIOThreadInfoFree

void	virDomainIOThreadInfoFree	(virDomainIOThreadInfoPtr info)

Frees the memory used by @info.

info
pointer to a virDomainIOThreadInfo object

virDomainInjectNMI

int	virDomainInjectNMI		(virDomainPtr domain,
					 unsigned int flags)

Send NMI to the guest

domain
pointer to domain object, or NULL for Domain0
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 in case of failure.

virDomainInterfaceAddresses

int	virDomainInterfaceAddresses	(virDomainPtr dom,
					 virDomainInterfacePtr ** ifaces,
					 unsigned int source,
					 unsigned int flags)

Return a pointer to the allocated array of pointers to interfaces present in given domain along with their IP and MAC addresses. Note that single interface can have multiple or even 0 IP addresses.

This API dynamically allocates the virDomainInterfacePtr struct based on how many interfaces domain @dom has, usually there's 1:1 correlation. The count of the interfaces is returned as the return value.

If @source is VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE, the DHCP lease file associated with any virtual networks will be examined to obtain the interface addresses. This only returns data for interfaces which are connected to virtual networks managed by libvirt.

If @source is VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT, a configured guest agent is needed for successful return from this API. Moreover, if guest agent is used then the interface name is the one seen by guest OS. To match such interface with the one from @dom XML use MAC address or IP range.

@ifaces->name and @ifaces->hwaddr are never NULL.

The caller *must* free @ifaces when no longer needed. Usual use case looks like this:

virDomainInterfacePtr *ifaces = NULL;
int ifaces_count = 0;
size_t i, j;
virDomainPtr dom = ... obtain a domain here ...;

if ((ifaces_count = virDomainInterfaceAddresses(dom, &ifaces,
         VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE)) < 0)
    goto cleanup;

... do something with returned values, for example:

for (i = 0; i < ifaces_count; i++) {
    printf("name: %s", ifaces[i]->name);
    if (ifaces[i]->hwaddr)
        printf(" hwaddr: %s", ifaces[i]->hwaddr);

    for (j = 0; j < ifaces[i]->naddrs; j++) {
        virDomainIPAddressPtr ip_addr = ifaces[i]->addrs + j;
        printf("[addr: %s prefix: %d type: %d]",
               ip_addr->addr, ip_addr->prefix, ip_addr->type);
    }
    printf("\n");
}

cleanup:
    if (ifaces && ifaces_count > 0)
        for (i = 0; i < ifaces_count; i++)
            virDomainInterfaceFree(ifaces[i]);
    free(ifaces);
dom
domain object
ifaces
pointer to an array of pointers pointing to interface objects
source
one of the virDomainInterfaceAddressesSource constants
flags
currently unused, pass zero
Returns
the number of interfaces on success, -1 in case of error.

virDomainInterfaceFree

void	virDomainInterfaceFree		(virDomainInterfacePtr iface)

Free the interface object. The data structure is freed and should not be used thereafter. If @iface is NULL, then this method has no effect.

iface
an interface object

virDomainInterfaceStats

int	virDomainInterfaceStats		(virDomainPtr dom,
					 const char * path,
					 virDomainInterfaceStatsPtr stats,
					 size_t size)

This function returns network interface stats for interfaces attached to the domain.

The path parameter is the name of the network interface.

Domains may have more than one network interface. To get stats for each you should make multiple calls to this function.

Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.

dom
pointer to the domain object
path
path to the interface
stats
network interface stats (returned)
size
size of stats structure
Returns
0 in case of success or -1 in case of failure.

virDomainIsActive

int	virDomainIsActive		(virDomainPtr dom)

Determine if the domain is currently running

dom
pointer to the domain object
Returns
1 if running, 0 if inactive, -1 on error

virDomainIsPersistent

int	virDomainIsPersistent		(virDomainPtr dom)

Determine if the domain has a persistent configuration which means it will still exist after shutting down

dom
pointer to the domain object
Returns
1 if persistent, 0 if transient, -1 on error

virDomainIsUpdated

int	virDomainIsUpdated		(virDomainPtr dom)

Determine if the domain has been updated.

dom
pointer to the domain object
Returns
1 if updated, 0 if not, -1 on error

virDomainListGetStats

int	virDomainListGetStats		(virDomainPtr * doms,
					 unsigned int stats,
					 virDomainStatsRecordPtr ** retStats,
					 unsigned int flags)

Query statistics for domains provided by @doms. Note that all domains in @doms must share the same connection.

Report statistics of various parameters for a running VM according to @stats field. The statistics are returned as an array of structures for each queried domain. The structure contains an array of typed parameters containing the individual statistics. The typed parameter name for each statistic field consists of a dot-separated string containing name of the requested group followed by a group specific description of the statistic value.

The statistic groups are enabled using the @stats parameter which is a binary-OR of enum virDomainStatsTypes. The stats groups are documented in virConnectGetAllDomainStats.

Using 0 for @stats returns all stats groups supported by the given hypervisor.

Specifying VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS as @flags makes the function return error in case some of the stat types in @stats were not recognized by the daemon. However, even with this flag, a hypervisor may omit individual fields within a known group if the information is not available; as an extreme example, a supported group may produce zero fields for offline domains if the statistics are meaningful only for a running domain.

Note that any of the domain list filtering flags in @flags may be rejected by this function.

doms
NULL terminated array of domains
stats
stats to return, binary-OR of virDomainStatsTypes
retStats
Pointer that will be filled with the array of returned stats
flags
extra flags; binary-OR of virConnectGetAllDomainStatsFlags
Returns
the count of returned statistics structures on success, -1 on error. The requested data are returned in the @retStats parameter. The returned array should be freed by the caller. See virDomainStatsRecordListFree. Note that the count of returned stats may be less than the domain count provided via @doms.

virDomainLookupByID

virDomainPtr	virDomainLookupByID	(virConnectPtr conn,
					 int id)

Try to find a domain based on the hypervisor ID number Note that this won't work for inactive domains which have an ID of -1, in that case a lookup based on the Name or UUId need to be done instead.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
id
the domain ID number
Returns
a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.

virDomainLookupByName

virDomainPtr	virDomainLookupByName	(virConnectPtr conn,
					 const char * name)

Try to lookup a domain on the given hypervisor based on its name.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
name
name for the domain
Returns
a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.

virDomainLookupByUUID

virDomainPtr	virDomainLookupByUUID	(virConnectPtr conn,
					 const unsigned char * uuid)

Try to lookup a domain on the given hypervisor based on its UUID.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
uuid
the raw UUID for the domain
Returns
a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.

virDomainLookupByUUIDString

virDomainPtr	virDomainLookupByUUIDString	(virConnectPtr conn,
						 const char * uuidstr)

Try to lookup a domain on the given hypervisor based on its UUID.

virDomainFree should be used to free the resources after the domain object is no longer needed.

conn
pointer to the hypervisor connection
uuidstr
the string UUID for the domain
Returns
a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.

virDomainManagedSave

int	virDomainManagedSave		(virDomainPtr dom,
					 unsigned int flags)

This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore. The difference from virDomainSave() is that libvirt is keeping track of the saved state itself, and will reuse it once the domain is being restarted (automatically or via an explicit libvirt call). As a result any running domain is sure to not have a managed saved image. This also implies that managed save only works on persistent domains, since the domain must still exist in order to use virDomainCreate() to restart it.

If @flags includes VIR_DOMAIN_SAVE_BYPASS_CACHE, then libvirt will attempt to bypass the file system cache while creating the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing saves to NFS.

Normally, the managed saved state will remember whether the domain was running or paused, and start will resume to the same state. Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in @flags will override the default saved into the file. These two flags are mutually exclusive.

dom
pointer to the domain
flags
bitwise-OR of virDomainSaveRestoreFlags
Returns
0 in case of success or -1 in case of failure

virDomainManagedSaveRemove

int	virDomainManagedSaveRemove	(virDomainPtr dom,
					 unsigned int flags)

Remove any managed save image for this domain.

dom
pointer to the domain
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, and -1 in case of error

virDomainMemoryPeek

int	virDomainMemoryPeek		(virDomainPtr dom,
					 unsigned long long start,
					 size_t size,
					 void * buffer,
					 unsigned int flags)

This function allows you to read the contents of a domain's memory.

The memory which is read is controlled by the 'start', 'size' and 'flags' parameters.

If 'flags' is VIR_MEMORY_VIRTUAL then the 'start' and 'size' parameters are interpreted as virtual memory addresses for whichever task happens to be running on the domain at the moment. Although this sounds haphazard it is in fact what you want in order to read Linux kernel state, because it ensures that pointers in the kernel image can be interpreted coherently.

'buffer' is the return buffer and must be at least 'size' bytes. 'size' may be 0 to test if the call would succeed.

NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to <= 65536 bytes. However, with 0.9.13 this RPC limit has been raised to 1M byte. Starting with version 1.0.6 the RPC limit has been raised again. Now large requests up to 16M byte are supported.

dom
pointer to the domain object
start
start of memory to peek
size
size of memory to peek
buffer
return buffer (must be at least size bytes)
flags
bitwise-OR of virDomainMemoryFlags
Returns
0 in case of success or -1 in case of failure. really 64 bits

virDomainMemoryStats

int	virDomainMemoryStats		(virDomainPtr dom,
					 virDomainMemoryStatPtr stats,
					 unsigned int nr_stats,
					 unsigned int flags)

This function provides memory statistics for the domain.

Up to 'nr_stats' elements of 'stats' will be populated with memory statistics from the domain. Only statistics supported by the domain, the driver, and this version of libvirt will be returned.

Memory Statistics:

VIR_DOMAIN_MEMORY_STAT_SWAP_IN: The total amount of data read from swap space (in kb). VIR_DOMAIN_MEMORY_STAT_SWAP_OUT: The total amount of memory written out to swap space (in kb). VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT: The number of page faults that required disk IO to service. VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT: The number of page faults serviced without disk IO. VIR_DOMAIN_MEMORY_STAT_UNUSED: The amount of memory which is not being used for any purpose (in kb). VIR_DOMAIN_MEMORY_STAT_AVAILABLE: The total amount of memory available to the domain's OS (in kb). VIR_DOMAIN_MEMORY_STAT_USABLE: How much the balloon can be inflated without pushing the guest system to swap, corresponds to 'Available' in /proc/meminfo VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON: Current balloon value (in kb). VIR_DOMAIN_MEMORY_STAT_LAST_UPDATE Timestamp of the last statistic

dom
pointer to the domain object
stats
nr_stats-sized array of stat structures (returned)
nr_stats
number of memory statistics requested
flags
extra flags; not used yet, so callers should always pass 0
Returns
The number of stats provided or -1 in case of failure.

virDomainMigrate

virDomainPtr	virDomainMigrate	(virDomainPtr domain,
					 virConnectPtr dconn,
					 unsigned long flags,
					 const char * dname,
					 const char * uri,
					 unsigned long bandwidth)

Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host).

This function is similar to virDomainMigrate3, but it only supports a fixed set of parameters: @dname corresponds to VIR_MIGRATE_PARAM_DEST_NAME, @uri is VIR_MIGRATE_PARAM_URI, and @bandwidth is VIR_MIGRATE_PARAM_BANDWIDTH.

virDomainFree should be used to free the resources after the returned domain object is no longer needed.

domain
a domain object
dconn
destination host (a connection object)
flags
bitwise-OR of virDomainMigrateFlags
dname
(optional) rename domain to this at destination
uri
(optional) dest hostname/URI as seen from the source host
bandwidth
(optional) specify migration bandwidth limit in MiB/s
Returns
the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).

virDomainMigrate2

virDomainPtr	virDomainMigrate2	(virDomainPtr domain,
					 virConnectPtr dconn,
					 const char * dxml,
					 unsigned long flags,
					 const char * dname,
					 const char * uri,
					 unsigned long bandwidth)

Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host).

This function is similar to virDomainMigrate3, but it only supports a fixed set of parameters: @dxml corresponds to VIR_MIGRATE_PARAM_DEST_XML, @dname is VIR_MIGRATE_PARAM_DEST_NAME, @uri is VIR_MIGRATE_PARAM_URI, and @bandwidth is VIR_MIGRATE_PARAM_BANDWIDTH.

virDomainFree should be used to free the resources after the returned domain object is no longer needed.

domain
a domain object
dconn
destination host (a connection object)
dxml
(optional) XML config for launching guest on target
flags
bitwise-OR of virDomainMigrateFlags
dname
(optional) rename domain to this at destination
uri
(optional) dest hostname/URI as seen from the source host
bandwidth
(optional) specify migration bandwidth limit in MiB/s
Returns
the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).

virDomainMigrate3

virDomainPtr	virDomainMigrate3	(virDomainPtr domain,
					 virConnectPtr dconn,
					 virTypedParameterPtr params,
					 unsigned int nparams,
					 unsigned int flags)

Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host).

See VIR_MIGRATE_PARAM_* and virDomainMigrateFlags for detailed description of accepted migration parameters and flags.

See virDomainMigrateFlags documentation for description of individual flags.

VIR_MIGRATE_TUNNELLED and VIR_MIGRATE_PEER2PEER are not supported by this API, use virDomainMigrateToURI3 instead.

There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.

virDomainFree should be used to free the resources after the returned domain object is no longer needed.

domain
a domain object
dconn
destination host (a connection object)
params
(optional) migration parameters
nparams
(optional) number of migration parameters in @params
flags
bitwise-OR of virDomainMigrateFlags
Returns
the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).

virDomainMigrateGetCompressionCache

int	virDomainMigrateGetCompressionCache	(virDomainPtr domain,
						 unsigned long long * cacheSize,
						 unsigned int flags)

Gets current size of the cache (in bytes) used for compressing repeatedly transferred memory pages during live migration.

domain
a domain object
cacheSize
return value of current size of the cache (in bytes)
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 otherwise.

virDomainMigrateGetMaxSpeed

int	virDomainMigrateGetMaxSpeed	(virDomainPtr domain,
					 unsigned long * bandwidth,
					 unsigned int flags)

Get the current maximum bandwidth (in MiB/s) that will be used if the domain is migrated. Not all hypervisors will support a bandwidth limit.

domain
a domain object
bandwidth
return value of current migration bandwidth limit in MiB/s
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 otherwise.

virDomainMigrateSetCompressionCache

int	virDomainMigrateSetCompressionCache	(virDomainPtr domain,
						 unsigned long long cacheSize,
						 unsigned int flags)

Sets size of the cache (in bytes) used for compressing repeatedly transferred memory pages during live migration. It's supposed to be called while the domain is being live-migrated as a reaction to migration progress and increasing number of compression cache misses obtained from virDomainGetJobStats.

domain
a domain object
cacheSize
size of the cache (in bytes) used for compression
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 otherwise.

virDomainMigrateSetMaxDowntime

int	virDomainMigrateSetMaxDowntime	(virDomainPtr domain,
					 unsigned long long downtime,
					 unsigned int flags)

Sets maximum tolerable time for which the domain is allowed to be paused at the end of live migration. It's supposed to be called while the domain is being live-migrated as a reaction to migration progress.

domain
a domain object
downtime
maximum tolerable downtime for live migration, in milliseconds
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 otherwise.

virDomainMigrateSetMaxSpeed

int	virDomainMigrateSetMaxSpeed	(virDomainPtr domain,
					 unsigned long bandwidth,
					 unsigned int flags)

The maximum bandwidth (in MiB/s) that will be used to do migration can be specified with the bandwidth parameter. Not all hypervisors will support a bandwidth cap

domain
a domain object
bandwidth
migration bandwidth limit in MiB/s
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 otherwise.

virDomainMigrateStartPostCopy

int	virDomainMigrateStartPostCopy	(virDomainPtr domain,
					 unsigned int flags)

Starts post-copy migration. This function has to be called while migration (initiated with VIR_MIGRATE_POSTCOPY flag) is in progress.

Traditional pre-copy migration iteratively walks through guest memory pages and migrates those that changed since the previous iteration. The iterative phase stops when the number of dirty pages is low enough so that the virtual CPUs can be paused, all dirty pages transferred to the destination, where the virtual CPUs are unpaused, and all this can happen within a predefined downtime period. It's clear that this process may never converge if downtime is too short and/or the guest keeps changing a lot of memory pages.

When migration is switched to post-copy mode, the virtual CPUs are paused immediately, only a minimum set of pages is transferred, and the CPUs are unpaused on destination. The source keeps sending all remaining memory pages to the destination while the guest is already running there. Whenever the guest tries to read a memory page which has not been migrated yet, the hypervisor has to tell the source to transfer that page in a priority channel. To minimize such page faults, it is a good idea to run at least one iteration of pre-copy migration before switching to post-copy.

Post-copy migration is guaranteed to converge since each page is transferred at most once no matter how fast it changes. On the other hand once the guest is running on the destination host, the migration can no longer be rolled back because none of the hosts has complete state. If this happens, libvirt will leave the domain paused on both hosts with VIR_DOMAIN_PAUSED_POSTCOPY_FAILED reason. It's up to the upper layer to decide what to do in such case.

The following domain life cycle events are emitted during post-copy migration: VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY (on the source) -- migration entered post-copy mode. VIR_DOMAIN_EVENT_RESUMED_POSTCOPY (on the destination) -- the guest is running on the destination host while some of its memory pages still remain on the source host; neither the source nor the destination host contain a complete guest state from this point until migration finishes. VIR_DOMAIN_EVENT_RESUMED_MIGRATED (on the destination), VIR_DOMAIN_EVENT_STOPPED_MIGRATED (on the source) -- migration finished successfully and the destination host holds a complete guest state. VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED (on the destination) -- emitted when migration fails in post-copy mode and it's unclear whether any of the hosts has a complete guest state.

The progress of a post-copy migration can be monitored normally using virDomainGetJobStats on the source host. Fetching statistics of a completed post-copy migration can also be done on the source host (by calling virDomainGetJobStats or listening to VIR_DOMAIN_EVENT_ID_JOB_COMPLETED event, but (in contrast to pre-copy migration) the statistics are not available on the destination host. Thus, VIR_DOMAIN_EVENT_ID_JOB_COMPLETED event is the only way of getting statistics of a completed post-copy migration of a transient domain (because the domain is removed after migration and there's no domain to run virDomainGetJobStats on).

domain
a domain object
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 otherwise.

virDomainMigrateToURI

int	virDomainMigrateToURI		(virDomainPtr domain,
					 const char * duri,
					 unsigned long flags,
					 const char * dname,
					 unsigned long bandwidth)

Migrate the domain object from its current host to the destination host given by duri.

This function is similar to virDomainMigrateToURI3, but it only supports a fixed set of parameters: @dname corresponds to VIR_MIGRATE_PARAM_DEST_NAME, and @bandwidth corresponds to VIR_MIGRATE_PARAM_BANDWIDTH.

The operation of this API hinges on the VIR_MIGRATE_PEER2PEER flag.

If the VIR_MIGRATE_PEER2PEER flag IS set, the @duri parameter must be a valid libvirt connection URI, by which the source libvirt driver can connect to the destination libvirt. In other words, @duri corresponds to @dconnuri of virDomainMigrateToURI3.

If the VIR_MIGRATE_PEER2PEER flag is NOT set, the @duri parameter takes a hypervisor specific URI used to initiate the migration. In this case @duri corresponds to VIR_MIGRATE_PARAM_URI of virDomainMigrateToURI3.

domain
a domain object
duri
mandatory URI for the destination host
flags
bitwise-OR of virDomainMigrateFlags
dname
(optional) rename domain to this at destination
bandwidth
(optional) specify migration bandwidth limit in MiB/s
Returns
0 if the migration succeeded, -1 upon error.

virDomainMigrateToURI2

int	virDomainMigrateToURI2		(virDomainPtr domain,
					 const char * dconnuri,
					 const char * miguri,
					 const char * dxml,
					 unsigned long flags,
					 const char * dname,
					 unsigned long bandwidth)

Migrate the domain object from its current host to the destination host given by @dconnuri.

This function is similar to virDomainMigrateToURI3, but it only supports a fixed set of parameters: @miguri corresponds to VIR_MIGRATE_PARAM_URI, @dxml is VIR_MIGRATE_PARAM_DEST_XML, @dname is VIR_MIGRATE_PARAM_DEST_NAME, and @bandwidth corresponds to VIR_MIGRATE_PARAM_BANDWIDTH.

The operation of this API hinges on the VIR_MIGRATE_PEER2PEER flag.

If the VIR_MIGRATE_PEER2PEER flag IS set, the @dconnuri parameter must be a valid libvirt connection URI, by which the source libvirt driver can connect to the destination libvirt. In other words, @dconnuri has the same semantics as in virDomainMigrateToURI3.

If the VIR_MIGRATE_PEER2PEER flag is NOT set, the @dconnuri must be NULL and the @miguri parameter takes a hypervisor specific URI used to initiate the migration. In this case @miguri corresponds to VIR_MIGRATE_PARAM_URI of virDomainMigrateToURI3.

domain
a domain object
dconnuri
(optional) URI for target libvirtd if @flags includes VIR_MIGRATE_PEER2PEER
miguri
(optional) URI for invoking the migration, not if @flags includs VIR_MIGRATE_TUNNELLED
dxml
(optional) XML config for launching guest on target
flags
bitwise-OR of virDomainMigrateFlags
dname
(optional) rename domain to this at destination
bandwidth
(optional) specify migration bandwidth limit in MiB/s
Returns
0 if the migration succeeded, -1 upon error.

virDomainMigrateToURI3

int	virDomainMigrateToURI3		(virDomainPtr domain,
					 const char * dconnuri,
					 virTypedParameterPtr params,
					 unsigned int nparams,
					 unsigned int flags)

Migrate the domain object from its current host to the destination host given by URI.

See VIR_MIGRATE_PARAM_* and virDomainMigrateFlags for detailed description of accepted migration parameters and flags.

The operation of this API hinges on the VIR_MIGRATE_PEER2PEER flag.

If the VIR_MIGRATE_PEER2PEER flag is set, the @dconnuri parameter must be a valid libvirt connection URI, by which the source libvirt daemon can connect to the destination libvirt.

If the VIR_MIGRATE_PEER2PEER flag is NOT set, then @dconnuri must be NULL and VIR_MIGRATE_PARAM_URI migration parameter must be filled in with hypervisor specific URI used to initiate the migration. The uri_transports element of the hypervisor capabilities XML includes supported URI schemes. This is called "direct" migration. Not all hypervisors support this mode of migration, so if the VIR_MIGRATE_PEER2PEER flag is not set, then it may be necessary to use the alternative virDomainMigrate3 API providing an explicit virConnectPtr for the destination host.

There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.

domain
a domain object
dconnuri
(optional) URI for target libvirtd if @flags includes VIR_MIGRATE_PEER2PEER
params
(optional) migration parameters
nparams
(optional) number of migration parameters in @params
flags
bitwise-OR of virDomainMigrateFlags
Returns
0 if the migration succeeded, -1 upon error.

virDomainOpenChannel

int	virDomainOpenChannel		(virDomainPtr dom,
					 const char * name,
					 virStreamPtr st,
					 unsigned int flags)

This opens the host interface associated with a channel device on a guest, if the host interface is supported. If @name is given, it can match either the device alias (e.g. "channel0"), or the virtio target name (e.g. "org.qemu.guest_agent.0"). If @name is omitted, then the first channel is opened. The channel is associated with the passed in @st stream, which should have been opened in non-blocking mode for bi-directional I/O.

By default, when @flags is 0, the open will fail if libvirt detects that the channel is already in use by another client; passing VIR_DOMAIN_CHANNEL_FORCE will cause libvirt to forcefully remove the other client prior to opening this channel.

dom
a domain object
name
the channel name, or NULL
st
a stream to associate with the channel
flags
bitwise-OR of virDomainChannelFlags
Returns
0 if the channel was opened, -1 on error

virDomainOpenConsole

int	virDomainOpenConsole		(virDomainPtr dom,
					 const char * dev_name,
					 virStreamPtr st,
					 unsigned int flags)

This opens the backend associated with a console, serial or parallel port device on a guest, if the backend is supported. If the @dev_name is omitted, then the first console or serial device is opened. The console is associated with the passed in @st stream, which should have been opened in non-blocking mode for bi-directional I/O.

By default, when @flags is 0, the open will fail if libvirt detects that the console is already in use by another client; passing VIR_DOMAIN_CONSOLE_FORCE will cause libvirt to forcefully remove the other client prior to opening this console.

If flag VIR_DOMAIN_CONSOLE_SAFE the console is opened only in the case where the hypervisor driver supports safe (mutually exclusive) console handling.

Older servers did not support either flag, and also did not forbid simultaneous clients on a console, with potentially confusing results. When passing @flags of 0 in order to support a wider range of server versions, it is up to the client to ensure mutual exclusion.

dom
a domain object
dev_name
the console, serial or parallel port device alias, or NULL
st
a stream to associate with the console
flags
bitwise-OR of virDomainConsoleFlags
Returns
0 if the console was opened, -1 on error

virDomainOpenGraphics

int	virDomainOpenGraphics		(virDomainPtr dom,
					 unsigned int idx,
					 int fd,
					 unsigned int flags)

This will attempt to connect the file descriptor @fd, to the graphics backend of @dom. If @dom has multiple graphics backends configured, then @idx will determine which one is opened, starting from @idx 0.

To disable any authentication, pass the VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH constant for @flags.

The caller should use an anonymous socketpair to open @fd before invocation.

This method can only be used when connected to a local libvirt hypervisor, over a UNIX domain socket. Attempts to use this method over a TCP connection will always fail

dom
pointer to domain object
idx
index of graphics config to open
fd
file descriptor to attach graphics to
flags
bitwise-OR of virDomainOpenGraphicsFlags
Returns
0 on success, -1 on failure

virDomainOpenGraphicsFD

int	virDomainOpenGraphicsFD		(virDomainPtr dom,
					 unsigned int idx,
					 unsigned int flags)

This will create a socket pair connected to the graphics backend of @dom. One end of the socket will be returned on success, and the other end is handed to the hypervisor. If @dom has multiple graphics backends configured, then @idx will determine which one is opened, starting from @idx 0.

To disable any authentication, pass the VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH constant for @flags.

This method can only be used when connected to a local libvirt hypervisor, over a UNIX domain socket. Attempts to use this method over a TCP connection will always fail.

dom
pointer to domain object
idx
index of graphics config to open
flags
bitwise-OR of virDomainOpenGraphicsFlags
Returns
an fd on success, -1 on failure

virDomainPMSuspendForDuration

int	virDomainPMSuspendForDuration	(virDomainPtr dom,
					 unsigned int target,
					 unsigned long long duration,
					 unsigned int flags)

Attempt to have the guest enter the given @target power management suspension level. If @duration is non-zero, also schedule the guest to resume normal operation after that many seconds, if nothing else has resumed it earlier. Some hypervisors require that @duration be 0, for an indefinite suspension.

Dependent on hypervisor used, this may require a guest agent to be available, e.g. QEMU.

Beware that at least for QEMU, the domain's process will be terminated when VIR_NODE_SUSPEND_TARGET_DISK is used and a new process will be launched when libvirt is asked to wake up the domain. As a result of this, any runtime changes, such as device hotplug or memory settings, are lost unless such changes were made with VIR_DOMAIN_AFFECT_CONFIG flag.

dom
a domain object
target
a value from virNodeSuspendTarget
duration
duration in seconds to suspend, or 0 for indefinite
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 on success, -1 on failure.

virDomainPMWakeup

int	virDomainPMWakeup		(virDomainPtr dom,
					 unsigned int flags)

Inject a wakeup into the guest that previously used virDomainPMSuspendForDuration, rather than waiting for the previously requested duration (if any) to elapse.

dom
a domain object
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 on success, -1 on failure.

virDomainPinEmulator

int	virDomainPinEmulator		(virDomainPtr domain,
					 unsigned char * cpumap,
					 int maplen,
					 unsigned int flags)

Dynamically change the real CPUs which can be allocated to all emulator threads. This function may require privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and may fail if domain is not alive. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed. Not all hypervisors can support all flag combinations.

See also virDomainGetEmulatorPinInfo for querying this information.

domain
pointer to domain object, or NULL for Domain0
cpumap
pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.
maplen
number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.
flags
bitwise-OR of virDomainModificationImpact
Returns
0 in case of success, -1 in case of failure.

virDomainPinIOThread

int	virDomainPinIOThread		(virDomainPtr domain,
					 unsigned int iothread_id,
					 unsigned char * cpumap,
					 int maplen,
					 unsigned int flags)

Dynamically change the real CPUs which can be allocated to an IOThread. This function may require privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and may fail if domain is not alive. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed. Not all hypervisors can support all flag combinations.

See also virDomainGetIOThreadInfo for querying this information.

domain
a domain object
iothread_id
the IOThread ID to set the CPU affinity
cpumap
pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.
maplen
number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.
flags
bitwise-OR of virDomainModificationImpact
Returns
0 in case of success, -1 in case of failure.

virDomainPinVcpu

int	virDomainPinVcpu		(virDomainPtr domain,
					 unsigned int vcpu,
					 unsigned char * cpumap,
					 int maplen)

Dynamically change the real CPUs which can be allocated to a virtual CPU. This function may require privileged access to the hypervisor.

This command only changes the runtime configuration of the domain, so can only be called on an active domain.

domain
pointer to domain object, or NULL for Domain0
vcpu
virtual CPU number
cpumap
pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.
maplen
number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.
Returns
0 in case of success, -1 in case of failure.

virDomainPinVcpuFlags

int	virDomainPinVcpuFlags		(virDomainPtr domain,
					 unsigned int vcpu,
					 unsigned char * cpumap,
					 int maplen,
					 unsigned int flags)

Dynamically change the real CPUs which can be allocated to a virtual CPU. This function may require privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and may fail if domain is not alive. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed. Not all hypervisors can support all flag combinations.

See also virDomainGetVcpuPinInfo for querying this information.

domain
pointer to domain object, or NULL for Domain0
vcpu
virtual CPU number
cpumap
pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.
maplen
number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.
flags
bitwise-OR of virDomainModificationImpact
Returns
0 in case of success, -1 in case of failure.

virDomainReboot

int	virDomainReboot			(virDomainPtr domain,
					 unsigned int flags)

Reboot a domain, the domain object is still usable thereafter, but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request. Additionally, the hypervisor may check and support the domain 'on_reboot' XML setting resulting in a domain that shuts down instead of rebooting.

If @flags is set to zero, then the hypervisor will choose the method of shutdown it considers best. To have greater control pass one or more of the virDomainRebootFlagValues. The order in which the hypervisor tries each shutdown method is undefined, and a hypervisor is not required to support all methods.

To use guest agent (VIR_DOMAIN_REBOOT_GUEST_AGENT) the domain XML must have <channel> configured.

Due to implementation limitations in some drivers (the qemu driver, for instance) it is not advised to migrate or save a guest that is rebooting as a result of this API. Migrating such a guest can lead to a plain shutdown on the destination.

domain
a domain object
flags
bitwise-OR of virDomainRebootFlagValues
Returns
0 in case of success and -1 in case of failure.

virDomainRef

int	virDomainRef			(virDomainPtr domain)

Increment the reference count on the domain. For each additional call to this method, there shall be a corresponding call to virDomainFree to release the reference count, once the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a domain would increment the reference count.

domain
the domain to hold a reference on
Returns
0 in case of success and -1 in case of failure.

virDomainRename

int	virDomainRename			(virDomainPtr dom,
					 const char * new_name,
					 unsigned int flags)

Rename a domain. New domain name is specified in the second argument. Depending on each driver implementation it may be required that domain is in a specific state.

There might be some attributes and/or elements in domain XML that if no value provided at XML defining time, libvirt will derive their value from the domain name. These are not updated by this API. Users are strongly advised to change these after the rename was successful.

dom
pointer to the domain object
new_name
new domain name
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 if successfully renamed, -1 on error

virDomainReset

int	virDomainReset			(virDomainPtr domain,
					 unsigned int flags)

Reset a domain immediately without any guest OS shutdown. Reset emulates the power reset button on a machine, where all hardware sees the RST line set and reinitializes internal state.

Note that there is a risk of data loss caused by reset without any guest OS shutdown.

domain
a domain object
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success and -1 in case of failure.

virDomainRestore

int	virDomainRestore		(virConnectPtr conn,
					 const char * from)

This method will restore a domain saved to disk by virDomainSave().

See virDomainRestoreFlags() for more control.

conn
pointer to the hypervisor connection
from
path to the input file
Returns
0 in case of success and -1 in case of failure.

virDomainRestoreFlags

int	virDomainRestoreFlags		(virConnectPtr conn,
					 const char * from,
					 const char * dxml,
					 unsigned int flags)

This method will restore a domain saved to disk by virDomainSave().

If the hypervisor supports it, @dxml can be used to alter host-specific portions of the domain XML that will be used when restoring an image. For example, it is possible to alter the backing filename that is associated with a disk device, in order to prepare for file renaming done as part of backing up the disk device while the domain is stopped.

If @flags includes VIR_DOMAIN_SAVE_BYPASS_CACHE, then libvirt will attempt to bypass the file system cache while restoring the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing restores from NFS.

Normally, the saved state file will remember whether the domain was running or paused, and restore defaults to the same state. Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in @flags will override the default read from the file. These two flags are mutually exclusive.

conn
pointer to the hypervisor connection
from
path to the input file
dxml
(optional) XML config for adjusting guest xml used on restore
flags
bitwise-OR of virDomainSaveRestoreFlags
Returns
0 in case of success and -1 in case of failure.

virDomainResume

int	virDomainResume			(virDomainPtr domain)

Resume a suspended domain, the process is restarted from the state where it was frozen by calling virDomainSuspend(). This function may require privileged access Moreover, resume may not be supported if domain is in some special state like VIR_DOMAIN_PMSUSPENDED.

domain
a domain object
Returns
0 in case of success and -1 in case of failure.

virDomainSave

int	virDomainSave			(virDomainPtr domain,
					 const char * to)

This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this ends the life of a transient domain). Use virDomainRestore() to restore a domain after saving.

See virDomainSaveFlags() for more control. Also, a save file can be inspected or modified slightly with virDomainSaveImageGetXMLDesc() and virDomainSaveImageDefineXML().

domain
a domain object
to
path for the output file
Returns
0 in case of success and -1 in case of failure.

virDomainSaveFlags

int	virDomainSaveFlags		(virDomainPtr domain,
					 const char * to,
					 const char * dxml,
					 unsigned int flags)

This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this ends the life of a transient domain). Use virDomainRestore() to restore a domain after saving.

If the hypervisor supports it, @dxml can be used to alter host-specific portions of the domain XML that will be used when restoring an image. For example, it is possible to alter the backing filename that is associated with a disk device, in order to prepare for file renaming done as part of backing up the disk device while the domain is stopped.

If @flags includes VIR_DOMAIN_SAVE_BYPASS_CACHE, then libvirt will attempt to bypass the file system cache while creating the file, or fail if it cannot do so for the given system; this can allow less pressure on file system cache, but also risks slowing saves to NFS.

Normally, the saved state file will remember whether the domain was running or paused, and restore defaults to the same state. Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in @flags will override what state gets saved into the file. These two flags are mutually exclusive.

A save file can be inspected or modified slightly with virDomainSaveImageGetXMLDesc() and virDomainSaveImageDefineXML().

Some hypervisors may prevent this operation if there is a current block copy operation; in that case, use virDomainBlockJobAbort() to stop the block copy first.

domain
a domain object
to
path for the output file
dxml
(optional) XML config for adjusting guest xml used on restore
flags
bitwise-OR of virDomainSaveRestoreFlags
Returns
0 in case of success and -1 in case of failure.

virDomainSaveImageDefineXML

int	virDomainSaveImageDefineXML	(virConnectPtr conn,
					 const char * file,
					 const char * dxml,
					 unsigned int flags)

This updates the definition of a domain stored in a saved state file. @file must be a file created previously by virDomainSave() or virDomainSaveFlags().

@dxml can be used to alter host-specific portions of the domain XML that will be used when restoring an image. For example, it is possible to alter the backing filename that is associated with a disk device, to match renaming done as part of backing up the disk device while the domain is stopped.

Normally, the saved state file will remember whether the domain was running or paused, and restore defaults to the same state. Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in @flags will override the default saved into the file; omitting both leaves the file's default unchanged. These two flags are mutually exclusive.

conn
pointer to the hypervisor connection
file
path to saved state file
dxml
XML config for adjusting guest xml used on restore
flags
bitwise-OR of virDomainSaveRestoreFlags
Returns
0 in case of success and -1 in case of failure.

virDomainSaveImageGetXMLDesc

char *	virDomainSaveImageGetXMLDesc	(virConnectPtr conn,
					 const char * file,
					 unsigned int flags)

This method will extract the XML describing the domain at the time a saved state file was created. @file must be a file created previously by virDomainSave() or virDomainSaveFlags().

No security-sensitive data will be included unless @flags contains VIR_DOMAIN_XML_SECURE; this flag is rejected on read-only connections. For this API, @flags should not contain either VIR_DOMAIN_XML_INACTIVE or VIR_DOMAIN_XML_UPDATE_CPU.

conn
pointer to the hypervisor connection
file
path to saved state file
flags
bitwise-OR of subset of virDomainXMLFlags
Returns
a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. The caller must free() the returned value.

virDomainScreenshot

char *	virDomainScreenshot		(virDomainPtr domain,
					 virStreamPtr stream,
					 unsigned int screen,
					 unsigned int flags)

Take a screenshot of current domain console as a stream. The image format is hypervisor specific. Moreover, some hypervisors supports multiple displays per domain. These can be distinguished by @screen argument.

This call sets up a stream; subsequent use of stream API is necessary to transfer actual data, determine how much data is successfully transferred, and detect any errors.

The screen ID is the sequential number of screen. In case of multiple graphics cards, heads are enumerated before devices, e.g. having two graphics cards, both with four heads, screen ID 5 addresses the second head on the second card.

domain
a domain object
stream
stream to use as output
screen
monitor ID to take screenshot from
flags
extra flags; not used yet, so callers should always pass 0
Returns
a string representing the mime-type of the image format, or NULL upon error. The caller must free() the returned value.

virDomainSendKey

int	virDomainSendKey		(virDomainPtr domain,
					 unsigned int codeset,
					 unsigned int holdtime,
					 unsigned int * keycodes,
					 int nkeycodes,
					 unsigned int flags)

Send key(s) to the guest.

domain
pointer to domain object, or NULL for Domain0
codeset
the code set of keycodes, from virKeycodeSet
holdtime
the duration (in milliseconds) that the keys will be held
keycodes
array of keycodes
nkeycodes
number of keycodes, up to VIR_DOMAIN_SEND_KEY_MAX_KEYS
flags
extra flags; not used yet, so callers should always pass 0
Returns
0 in case of success, -1 in case of failure.

virDomainSendProcessSignal

int	virDomainSendProcessSignal	(virDomainPtr domain,
					 long long pid_value,
					 unsigned int signum,
					 unsigned int flags)

Send a signal to the designated process in the guest

The signal numbers must be taken from the virDomainProcessSignal enum. These will be translated to the corresponding signal number for the guest OS, by the guest agent delivering the signal. If there is no mapping from virDomainProcessSignal to the native OS signals, this API will report an error.

If @pid_value is an integer greater than zero, it is treated as a process ID. If @pid_value is an integer less than zero, it is treated as a process group ID. All the @pid_value numbers are from the container/guest namespace. The value zero is not valid.

Not all hypervisors will support sending signals to arbitrary processes or process groups. If this API is implemented the minimum requirement is to be able to use @pid_value == 1 (i.e. kill init). No other value is required to be supported.

If the @signum is VIR_DOMAIN_PROCESS_SIGNAL_NOP then this API will simply report whether the process is running in the container/guest.

domain
pointer to domain object
pid_value
a positive integer process ID, or negative integer process group ID
signum
a signal from the virDomainProcessSignal enum
flags
currently unused, pass 0
Returns
0 in case of success, -1 in case of failure.

virDomainSetAutostart

int	virDomainSetAutostart		(virDomainPtr domain,
					 int autostart)

Configure the domain to be automatically started when the host machine boots.

domain
a domain object
autostart
whether the domain should be automatically started 0 or 1
Returns
-1 in case of error, 0 in case of success

virDomainSetBlkioParameters

int	virDomainSetBlkioParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Change all or a subset of the blkio tunables. This function may require privileged access to the hypervisor.

domain
pointer to domain object
params
pointer to blkio parameter objects
nparams
number of blkio parameters (this value can be the same or less than the number of parameters supported)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetBlockIoTune

int	virDomainSetBlockIoTune		(virDomainPtr dom,
					 const char * disk,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Change all or a subset of the per-device block IO tunables.

The @disk parameter is either an unambiguous source name of the block device (the <source file='...'/> sub-element, such as "/path/to/image"), or the device target shorthand (the <target dev='...'/> sub-element, such as "xvda"). Valid names can be found by calling virDomainGetXMLDesc() and inspecting elements within //domain/devices/disk.

dom
pointer to domain object
disk
path to the block device, or device shorthand
params
Pointer to blkio parameter objects
nparams
Number of blkio parameters (this value can be the same or less than the number of parameters supported)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetGuestVcpus

int	virDomainSetGuestVcpus		(virDomainPtr domain,
					 const char * cpumap,
					 int state,
					 unsigned int flags)

Sets state of individual vcpus described by @cpumap via guest agent. Other vcpus are not modified.

This API requires the VM to run. Various hypervisors or guest agent implementation may limit to operate on just 1 vCPU per call.

@cpumap is a list of vCPU numbers. Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2'). The '-' denotes the range and the '^' denotes exclusive. The expression is sequentially evaluated, so "0-15,^8" is identical to "9-14,0-7,15" but not identical to "^8,0-15".

Note that OSes (notably Linux) may require vCPU 0 to stay online to support low-level features a S3 sleep.

domain
pointer to domain object
cpumap
text representation of a bitmap of vcpus to set
state
0 to disable/1 to enable cpus described by @cpumap
flags
currently unused, callers shall pass 0
Returns
0 on success, -1 on error.

virDomainSetInterfaceParameters

int	virDomainSetInterfaceParameters	(virDomainPtr domain,
					 const char * device,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Change a subset or all parameters of interface; currently this includes bandwidth parameters. The value of @flags should be either VIR_DOMAIN_AFFECT_CURRENT, or a bitwise-or of values VIR_DOMAIN_AFFECT_LIVE and VIR_DOMAIN_AFFECT_CONFIG, although hypervisors vary in which flags are supported.

This function may require privileged access to the hypervisor.

domain
pointer to domain object
device
the interface name or mac address
params
pointer to interface parameter objects
nparams
number of interface parameter (this value can be the same or less than the number of parameters supported)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetMaxMemory

int	virDomainSetMaxMemory		(virDomainPtr domain,
					 unsigned long memory)

Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may require privileged access to the hypervisor.

This command is hypervisor-specific for whether active, persistent, or both configurations are changed; for more control, use virDomainSetMemoryFlags().

domain
a domain object or NULL
memory
the memory size in kibibytes (blocks of 1024 bytes)
Returns
0 in case of success and -1 in case of failure.

virDomainSetMemory

int	virDomainSetMemory		(virDomainPtr domain,
					 unsigned long memory)

Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may require privileged access to the hypervisor.

This command is hypervisor-specific for whether active, persistent, or both configurations are changed; for more control, use virDomainSetMemoryFlags().

domain
a domain object or NULL
memory
the memory size in kibibytes (blocks of 1024 bytes)
Returns
0 in case of success and -1 in case of failure.

virDomainSetMemoryFlags

int	virDomainSetMemoryFlags		(virDomainPtr domain,
					 unsigned long memory,
					 unsigned int flags)

Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may require privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and will fail if domain is not active. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed. If VIR_DOMAIN_MEM_MAXIMUM is set, the change affects domain's maximum memory size rather than current memory size. Not all hypervisors can support all flag combinations.

domain
a domain object or NULL
memory
the memory size in kibibytes (blocks of 1024 bytes)
flags
bitwise-OR of virDomainMemoryModFlags
Returns
0 in case of success, -1 in case of failure.

virDomainSetMemoryParameters

int	virDomainSetMemoryParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Change all or a subset of the memory tunables. This function may require privileged access to the hypervisor.

Possible values for all *_limit memory tunables are in range from 0 to VIR_DOMAIN_MEMORY_PARAM_UNLIMITED.

domain
pointer to domain object
params
pointer to memory parameter objects
nparams
number of memory parameter (this value can be the same or less than the number of parameters supported)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetMemoryStatsPeriod

int	virDomainSetMemoryStatsPeriod	(virDomainPtr domain,
					 int period,
					 unsigned int flags)

Dynamically change the domain memory balloon driver statistics collection period. Use 0 to disable and a positive value to enable.

@flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG. Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain and will fail if domain is not active. If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state, and will fail for transient domains. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed.

Not all hypervisors can support all flag combinations.

domain
a domain object or NULL
period
the period in seconds for stats collection
flags
bitwise-OR of virDomainMemoryModFlags
Returns
0 in case of success, -1 in case of failure.

virDomainSetMetadata

int	virDomainSetMetadata		(virDomainPtr domain,
					 int type,
					 const char * metadata,
					 const char * key,
					 const char * uri,
					 unsigned int flags)

Sets the appropriate domain element given by @type to the value of @metadata. A @type of VIR_DOMAIN_METADATA_DESCRIPTION is free-form text; VIR_DOMAIN_METADATA_TITLE is free-form, but no newlines are permitted, and should be short (although the length is not enforced). For these two options @key and @uri are irrelevant and must be set to NULL.

For type VIR_DOMAIN_METADATA_ELEMENT @metadata must be well-formed XML belonging to namespace defined by @uri with local name @key.

Passing NULL for @metadata says to remove that element from the domain XML (passing the empty string leaves the element present).

The resulting metadata will be present in virDomainGetXMLDesc(), as well as quick access through virDomainGetMetadata().

@flags controls whether the live domain, persistent configuration, or both will be modified.

domain
a domain object
type
type of metadata, from virDomainMetadataType
metadata
new metadata text
key
XML namespace key, or NULL
uri
XML namespace URI, or NULL
flags
bitwise-OR of virDomainModificationImpact
Returns
0 on success, -1 in case of failure.

virDomainSetNumaParameters

int	virDomainSetNumaParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Change all or a subset of the numa tunables. This function may require privileged access to the hypervisor.

domain
pointer to domain object
params
pointer to numa parameter objects
nparams
number of numa parameters (this value can be the same or less than the number of parameters supported)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetPerfEvents

int	virDomainSetPerfEvents		(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int nparams,
					 unsigned int flags)

Enable or disable the particular list of Linux perf events you care about. The @params argument should contain any subset of VIR_PERF_EVENT_ macros.

Linux perf events are performance analyzing tool in Linux.

domain
a domain object
params
pointer to perf events parameter object
nparams
number of perf event parameters (this value can be the same less than the number of parameters supported)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetSchedulerParameters

int	virDomainSetSchedulerParameters	(virDomainPtr domain,
					 virTypedParameterPtr params,
					 int nparams)

Change all or a subset or the scheduler parameters. It is hypervisor-specific whether this sets live, persistent, or both settings; for more control, use virDomainSetSchedulerParametersFlags.

domain
pointer to domain object
params
pointer to scheduler parameter objects
nparams
number of scheduler parameter objects (this value can be the same or less than the returned value nparams of virDomainGetSchedulerType)
Returns
-1 in case of error, 0 in case of success.

virDomainSetSchedulerParametersFlags

int	virDomainSetSchedulerParametersFlags	(virDomainPtr domain,
						 virTypedParameterPtr params,
						 int nparams,
						 unsigned int flags)

Change a subset or all scheduler parameters. The value of @flags should be either VIR_DOMAIN_AFFECT_CURRENT, or a bitwise-or of values from VIR_DOMAIN_AFFECT_LIVE and VIR_DOMAIN_AFFECT_CURRENT, although hypervisors vary in which flags are supported.

domain
pointer to domain object
params
pointer to scheduler parameter objects
nparams
number of scheduler parameter objects (this value can be the same or less than the returned value nparams of virDomainGetSchedulerType)
flags
bitwise-OR of virDomainModificationImpact
Returns
-1 in case of error, 0 in case of success.

virDomainSetTime

int	virDomainSetTime		(virDomainPtr dom,
					 long long seconds,
					 unsigned int nseconds,
					 unsigned int flags)

When a domain is suspended or restored from a file the domain's OS has no idea that there was a big gap in the time. Depending on how long the gap was, NTP might not be able to resynchronize the guest.

This API tries to set guest time to the given value. The time to set (@seconds and @nseconds) should be in seconds relative to the Epoch of 1970-01-01 00:00:00 in UTC.

Please note that some hypervisors may require guest agent to be configured and running in order to be able to run this API.

dom
a domain object
seconds
time to set
nseconds
the nanosecond part of @seconds
flags
bitwise-OR of virDomainSetTimeFlags
Returns
0 on success, -1 otherwise.

virDomainSetUserPassword

int	virDomainSetUserPassword	(virDomainPtr dom,
					 const char * user,
					 const char * password,
					 unsigned int flags)

Sets the @user password to the value specified by @password. If @flags contain VIR_DOMAIN_PASSWORD_ENCRYPTED, the password is assumed to be encrypted by the method required by the guest OS.

Please note that some hypervisors may require guest agent to be configured and running in order to be able to run this API.

dom
a domain object
user
the username that will get a new password
password
the password to set
flags
bitwise-OR of virDomainSetUserPasswordFlags
Returns
0 on success, -1 otherwise.

virDomainSetVcpu

int	virDomainSetVcpu		(virDomainPtr domain,
					 const char * vcpumap,
					 int state,
					 unsigned int flags)

Enables/disables individual vcpus described by @vcpumap in the hypervisor.

Various hypervisor implementations may limit to operate on just 1 hotpluggable entity (which may contain multiple vCPUs on certain platforms).

Note that OSes and hypervisors may require vCPU 0 to stay online.

domain
pointer to domain object
vcpumap
text representation of a bitmap of vcpus to set
state
0 to disable/1 to enable cpus described by @vcpumap
flags
bitwise-OR of virDomainModificationImpact
Returns
0 on success, -1 on error.

virDomainSetVcpus

int	virDomainSetVcpus		(virDomainPtr domain,
					 unsigned int nvcpus)

Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrarily limited. This function may require privileged access to the hypervisor.

Note that if this call is executed before the guest has finished booting, the guest may fail to process the change.

This command only changes the runtime configuration of the domain, so can only be called on an active domain. It is hypervisor-dependent whether it also affects persistent configuration; for more control, use virDomainSetVcpusFlags().

domain
pointer to domain object, or NULL for Domain0
nvcpus
the new number of virtual CPUs for this domain
Returns
0 in case of success, -1 in case of failure.

virDomainSetVcpusFlags

int	virDomainSetVcpusFlags		(virDomainPtr domain,
					 unsigned int nvcpus,
					 unsigned int flags)

Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrarily limited. This function may require privileged access to the hypervisor.

@flags may include VIR_DOMAIN_AFFECT_LIVE to affect a running domain (which may fail if domain is not active), or VIR_DOMAIN_AFFECT_CONFIG to affect the next boot via the XML description of the domain. Both flags may be set. If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies persistent setup, while an active domain is hypervisor-dependent on whether just live or both live and persistent state is changed.

Note that if this call is executed before the guest has finished booting, the guest may fail to process the change.

If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then VIR_DOMAIN_AFFECT_LIVE must be clear, and only the maximum virtual CPU limit is altered; generally, this value must be less than or equal to virConnectGetMaxVcpus(). Otherwise, this call affects the current virtual CPU limit, which must be less than or equal to the maximum limit.

If @flags includes VIR_DOMAIN_VCPU_GUEST, then the state of processors is modified inside the guest instead of the hypervisor. This flag can only be used with live guests and is incompatible with VIR_DOMAIN_VCPU_MAXIMUM. The usage of this flag may require a guest agent configured.

Not all hypervisors can support all flag combinations.

domain
pointer to domain object, or NULL for Domain0
nvcpus
the new number of virtual CPUs for this domain, must be at least 1
flags
bitwise-OR of virDomainVcpuFlags
Returns
0 in case of success, -1 in case of failure.

virDomainShutdown

int	virDomainShutdown		(virDomainPtr domain)

Shutdown a domain, the domain object is still usable thereafter, but the domain OS is being stopped. Note that the guest OS may ignore the request. Additionally, the hypervisor may check and support the domain 'on_poweroff' XML setting resulting in a domain that reboots instead of shutting down. For guests that react to a shutdown request, the differences from virDomainDestroy() are that the guests disk storage will be in a stable state rather than having the (virtual) power cord pulled, and this command returns as soon as the shutdown request is issued rather than blocking until the guest is no longer running.

If the domain is transient and has any snapshot metadata (see virDomainSnapshotNum()), then that metadata will automatically be deleted when the domain quits.

domain
a domain object
Returns
0 in case of success and -1 in case of failure.

virDomainShutdownFlags

int	virDomainShutdownFlags		(virDomainPtr domain,
					 unsigned int flags)

Shutdown a domain, the domain object is still usable thereafter but the domain OS is being stopped. Note that the guest OS may ignore the request. Additionally, the hypervisor may check and support the domain 'on_poweroff' XML setting resulting in a domain that reboots instead of shutting down. For guests that react to a shutdown request, the differences from virDomainDestroy() are that the guest's disk storage will be in a stable state rather than having the (virtual) power cord pulled, and this command returns as soon as the shutdown request is issued rather than blocking until the guest is no longer running.

If the domain is transient and has any snapshot metadata (see virDomainSnapshotNum()), then that metadata will automatically be deleted when the domain quits.

If @flags is set to zero, then the hypervisor will choose the method of shutdown it considers best. To have greater control pass one or more of the virDomainShutdownFlagValues. The order in which the hypervisor tries each shutdown method is undefined, and a hypervisor is not required to support all methods.

To use guest agent (VIR_DOMAIN_SHUTDOWN_GUEST_AGENT) the domain XML must have <channel> configured.

domain
a domain object
flags
bitwise-OR of virDomainShutdownFlagValues
Returns
0 in case of success and -1 in case of failure.

virDomainStatsRecordListFree

void	virDomainStatsRecordListFree	(virDomainStatsRecordPtr * stats)

Convenience function to free a list of domain stats returned by virDomainListGetStats and virConnectGetAllDomainStats.

stats
NULL terminated array of virDomainStatsRecords to free

virDomainSuspend

int	virDomainSuspend		(virDomainPtr domain)

Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may require privileged access. Moreover, suspend may not be supported if domain is in some special state like VIR_DOMAIN_PMSUSPENDED.

domain
a domain object
Returns
0 in case of success and -1 in case of failure.

virDomainUndefine

int	virDomainUndefine		(virDomainPtr domain)

Undefine a domain. If the domain is running, it's converted to transient domain, without stopping it. If the domain is inactive, the domain configuration is removed.

If the domain has a managed save image (see virDomainHasManagedSaveImage()), or if it is inactive and has any snapshot metadata (see virDomainSnapshotNum()), then the undefine will fail. See virDomainUndefineFlags() for more control.

domain
pointer to a defined domain
Returns
0 in case of success, -1 in case of error

virDomainUndefineFlags

int	virDomainUndefineFlags		(virDomainPtr domain,
					 unsigned int flags)

Undefine a domain. If the domain is running, it's converted to transient domain, without stopping it. If the domain is inactive, the domain configuration is removed.

If the domain has a managed save image (see virDomainHasManagedSaveImage()), then including VIR_DOMAIN_UNDEFINE_MANAGED_SAVE in @flags will also remove that file, and omitting the flag will cause the undefine process to fail.

If the domain is inactive and has any snapshot metadata (see virDomainSnapshotNum()), then including VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA in @flags will also remove that metadata. Omitting the flag will cause the undefine of an inactive domain to fail. Active snapshots will retain snapshot metadata until the (now-transient) domain halts, regardless of whether this flag is present. On hypervisors where snapshots do not use libvirt metadata, this flag has no effect.

If the domain has any nvram specified, the undefine process will fail unless VIR_DOMAIN_UNDEFINE_KEEP_NVRAM is specified, or if VIR_DOMAIN_UNDEFINE_NVRAM is specified to remove the nvram file.

domain
pointer to a defined domain
flags
bitwise-OR of supported virDomainUndefineFlagsValues
Returns
0 in case of success, -1 in case of error

virDomainUpdateDeviceFlags

int	virDomainUpdateDeviceFlags	(virDomainPtr domain,
					 const char * xml,
					 unsigned int flags)

Change a virtual device on a domain, using the flags parameter to control how the device is changed. VIR_DOMAIN_AFFECT_CURRENT specifies that the device change is made based on current domain state. VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be changed on the active domain instance only and is not added to the persisted domain configuration. VIR_DOMAIN_AFFECT_CONFIG specifies that the device shall be changed on the persisted domain configuration only. Note that the target hypervisor must return an error if unable to satisfy flags. E.g. the hypervisor driver will return failure if LIVE is specified but it only supports modifying the persisted device allocation.

This method is used for actions such changing CDROM/Floppy device media, altering the graphics configuration such as password, reconfiguring the NIC device backend connectivity, etc.

domain
pointer to domain object
xml
pointer to XML description of one device
flags
bitwise-OR of virDomainDeviceModifyFlags
Returns
0 in case of success, -1 in case of failure.