* virDomain:
*
* a virDomain is a private structure representing a domain.
+ *
+ * Since: v0.0.1
+ *
*/
typedef struct _virDomain virDomain;
*
* a virDomainPtr is pointer to a virDomain private structure, this is the
* type used to reference a domain in the API.
+ *
+ * Since: v0.0.1
+ *
*/
typedef virDomain *virDomainPtr;
* virDomainState:
*
* A domain may be in different states at a given point in time
+ *
+ * Since: v0.0.1
+ *
*/
typedef enum {
VIR_DOMAIN_NOSTATE = 0, /* no state */
# endif
} virDomainState;
+/**
+ * virDomainNostateReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_NOSTATE_UNKNOWN = 0,
# endif
} virDomainNostateReason;
+/**
+ * virDomainRunningReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_RUNNING_UNKNOWN = 0,
VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot */
# endif
} virDomainRunningReason;
+/**
+ * virDomainBlockedReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown */
# endif
} virDomainBlockedReason;
+/**
+ * virDomainPausedReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown */
VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request */
# endif
} virDomainPausedReason;
+/**
+ * virDomainShutdownReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown */
VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request */
# endif
} virDomainShutdownReason;
+/**
+ * virDomainShutoffReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown */
VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown */
# endif
} virDomainShutoffReason;
+/**
+ * virDomainCrashedReason:
+ *
+ * Since: v0.9.2
+ *
+ */
typedef enum {
VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason */
VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked */
# endif
} virDomainCrashedReason;
+/**
+ * virDomainPMSuspendedReason:
+ *
+ * Since: v0.9.11
+ *
+ */
typedef enum {
VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0,
# endif
} virDomainPMSuspendedReason;
+/**
+ * virDomainPMSuspendedDiskReason:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0,
* virDomainControlState:
*
* Current state of a control interface to the domain.
+ *
+ * Since: v0.9.3
+ *
*/
typedef enum {
VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands */
* virDomainControlErrorReason:
*
* Reason for the error state.
+ *
+ * Since: v1.2.14
+ *
*/
typedef enum {
VIR_DOMAIN_CONTROL_ERROR_REASON_NONE = 0, /* server didn't provide a
*
* Structure filled in by virDomainGetControlInfo and providing details about
* current state of control interface to a domain.
+ *
+ * Since: v0.9.3
+ *
*/
typedef struct _virDomainControlInfo virDomainControlInfo;
struct _virDomainControlInfo {
* virDomainControlInfoPtr:
*
* Pointer to virDomainControlInfo structure.
+ *
+ * Since: v0.9.3
+ *
*/
typedef virDomainControlInfo *virDomainControlInfoPtr;
* (whether or not it is running).
*
* These enums should not conflict with those of virTypedParameterFlags.
+ *
+ * Since: v0.9.2
+ *
*/
typedef enum {
VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. */
} virDomainModificationImpact;
/**
- * virDomainInfoPtr:
+ * virDomainInfo:
*
* a virDomainInfo is a structure filled by virDomainGetInfo() and extracting
* runtime information for a given active Domain
+ *
+ * Since: v0.0.1
+ *
*/
-
typedef struct _virDomainInfo virDomainInfo;
struct _virDomainInfo {
* virDomainInfoPtr:
*
* a virDomainInfoPtr is a pointer to a virDomainInfo structure.
+ *
+ * Since: v0.0.1
+ *
*/
typedef virDomainInfo *virDomainInfoPtr;
*
* Flags OR'ed together to provide specific behaviour when creating a
* Domain.
+ *
+ * Since: v0.0.1
+ *
*/
typedef enum {
VIR_DOMAIN_NONE = 0, /* Default behavior */
unsigned int flags);
/**
- * virDomainBlockStats:
+ * virDomainBlockStatsStruct:
*
* Block device stats for virDomainBlockStats.
*
* that the hypervisor does not support that statistic.
*
* NB. Here 'long long' means 64 bit integer.
+ *
+ * Since: v0.3.3
+ *
*/
typedef struct _virDomainBlockStats virDomainBlockStatsStruct;
* virDomainBlockStatsPtr:
*
* A pointer to a virDomainBlockStats structure
+ *
+ * Since: v0.3.2
+ *
*/
typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr;
# define VIR_DOMAIN_BLOCK_STATS_ERRS "errs"
/**
- * virDomainInterfaceStats:
+ * virDomainInterfaceStatsStruct:
*
* Network interface stats for virDomainInterfaceStats.
*
* that the hypervisor does not support that statistic.
*
* NB. Here 'long long' means 64 bit integer.
+ *
+ * Since: v0.3.3
+ *
*/
typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct;
* virDomainInterfaceStatsPtr:
*
* A pointer to a virDomainInterfaceStats structure
+ *
+ * Since: v0.3.2
+ *
*/
typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr;
/**
+ * virDomainMemoryStatTags:
+ *
* Memory Statistics Tags:
+ *
+ * Since: v0.7.5
+ *
*/
typedef enum {
/* The total amount of data read from swap space (in kB). */
# endif
} virDomainMemoryStatTags;
+/**
+ * virDomainMemoryStatStruct:
+ *
+ * Since: v0.7.5
+ *
+ */
typedef struct _virDomainMemoryStat virDomainMemoryStatStruct;
struct _virDomainMemoryStat {
unsigned long long val;
};
+/**
+ * virDomainMemoryStatPtr:
+ *
+ * Since: v0.7.5
+ *
+ */
typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr;
-/* Domain core dump flags. */
+/**
+ * virDomainCoreDumpFlags:
+ *
+ * Domain core dump flags.
+ *
+ * Since: v0.7.5
+ *
+ */
typedef enum {
VIR_DUMP_CRASH = (1 << 0), /* crash after dump */
VIR_DUMP_LIVE = (1 << 1), /* live dump */
* virDomainCoreDumpFormat:
*
* Values for specifying different formats of domain core dumps.
+ *
+ * Since: v1.2.3
+ *
*/
typedef enum {
VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format */
# endif
} virDomainCoreDumpFormat;
-/* Domain migration flags. */
+/**
+ * virDomainMigrateFlags:
+ *
+ * Domain migration flags.
+ *
+ * Since: v0.3.2
+ *
+ */
typedef enum {
/* Do not pause the domain during migration. The domain's memory will
* be transferred to the destination host while the domain is running.
unsigned long long cacheSize,
unsigned int flags);
-/* Domain migration speed flags. */
+/**
+ * virDomainMigrateMaxSpeedFlags:
+ *
+ * Domain migration speed flags.
+ *
+ * Since: v5.1.0
+ *
+ */
typedef enum {
/* Set or get maximum speed of post-copy migration. */
VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY = (1 << 0),
virDomainPtr virDomainLookupByUUIDString (virConnectPtr conn,
const char *uuid);
+/**
+ * virDomainShutdownFlagValues:
+ *
+ * Since: v0.9.10
+ *
+ */
typedef enum {
VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice */
VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event */
int virDomainShutdownFlags (virDomainPtr domain,
unsigned int flags);
+/**
+ * virDomainRebootFlagValues:
+ *
+ * Since: v0.9.10
+ *
+ */
typedef enum {
VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice */
VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event */
*
* Flags used to provide specific behaviour to the
* virDomainDestroyFlags() function
+ *
+ * Since: v0.9.4
+ *
*/
typedef enum {
VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! */
/**
* virDomainSaveRestoreFlags:
+ *
* Flags for use in virDomainSaveFlags(), virDomainManagedSave(),
* virDomainRestoreFlags(), and virDomainSaveImageDefineXML(). Not all
* flags apply to all these functions.
+ *
+ * Since: v0.9.4
+ *
*/
typedef enum {
VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution */
virTypedParameterPtr params,
int *nparams, unsigned int flags);
-/* Memory size modification flags. */
+/**
+ * virDomainMemoryModFlags:
+ *
+ * Memory size modification flags.
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
/* See virDomainModificationImpact for these flags. */
VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
* virDomainNumatuneMemMode:
* Representation of the various modes in the <numatune> element of
* a domain.
+ *
+ * Since: v0.9.9
+ *
*/
typedef enum {
VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0,
int virDomainGetMaxVcpus (virDomainPtr domain);
int virDomainGetSecurityLabel (virDomainPtr domain,
virSecurityLabelPtr seclabel);
-
+/**
+ * virDomainGetHostnameFlags:
+ *
+ * Since: v6.1.0
+ *
+ */
typedef enum {
VIR_DOMAIN_GET_HOSTNAME_LEASE = (1 << 0), /* Parse DHCP lease file */
VIR_DOMAIN_GET_HOSTNAME_AGENT = (1 << 1), /* Query qemu guest agent */
int virDomainGetSecurityLabelList (virDomainPtr domain,
virSecurityLabelPtr* seclabels);
+/**
+ * virDomainMetadataType:
+ *
+ * Since: v0.9.10
+ *
+ */
typedef enum {
VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> */
VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> */
/*
* XML domain description
*/
+
/**
* virDomainXMLFlags:
*
* Flags available for virDomainGetXMLDesc
+ *
+ * Since: v0.3.3
+ *
*/
-
typedef enum {
VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too */
VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information */
VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration */
} virDomainXMLFlags;
+/**
+ * virDomainSaveImageXMLFlags:
+ *
+ * Since: v5.1.0
+ *
+ */
typedef enum {
VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too */
} virDomainSaveImageXMLFlags;
* virDomainBlockResizeFlags:
*
* Flags available for virDomainBlockResize().
+ *
+ * Since: v0.9.11
+ *
*/
typedef enum {
VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB */
* * capacity: logical size from qcow2 header
* * allocation: highest qcow extent written for an active domain
* * physical: size of the block device container
+ *
+ * Since: v0.8.1
+ *
*/
typedef struct _virDomainBlockInfo virDomainBlockInfo;
+
+/**
+ * virDomainBlockInfoPtr:
+ *
+ * Since: v0.8.1
+ *
+ */
typedef virDomainBlockInfo *virDomainBlockInfoPtr;
struct _virDomainBlockInfo {
unsigned long long capacity; /* logical size in bytes of the
unsigned int nr_stats,
unsigned int flags);
-/* Memory peeking flags. */
-
+/**
+ * virDomainMemoryFlags:
+ *
+ * Memory peeking flags.
+ *
+ * Since: v0.4.4
+ *
+ */
typedef enum {
VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses */
VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses */
void *buffer,
unsigned int flags);
+/**
+ * virDomainDefineFlags:
+ *
+ * Since: v1.2.12
+ *
+ */
typedef enum {
VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema */
} virDomainDefineFlags;
unsigned int flags);
int virDomainUndefine (virDomainPtr domain);
+/**
+ * virDomainUndefineFlagsValues:
+ *
+ * Since: v0.9.4
+ *
+ */
typedef enum {
VIR_DOMAIN_UNDEFINE_MANAGED_SAVE = (1 << 0), /* Also remove any
managed save */
* Flags used to tune which domains are listed by virConnectListAllDomains().
* Note that these flags come in groups; if all bits from a group are 0,
* then that group is not used to filter results.
+ *
+ * Since: v0.9.13
*/
typedef enum {
VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0,
int autostart);
/**
- * virVcpuInfo: structure for information about a virtual CPU in a domain.
+ * virVcpuState:
+ *
+ * structure for information about a virtual CPU in a domain.
+ *
+ * Since: v0.1.4
+ *
*/
-
typedef enum {
VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline */
VIR_VCPU_RUNNING = 1, /* the virtual CPU is running */
# endif
} virVcpuState;
+/**
+ * virVcpuHostCpuState:
+ *
+ * Since: v6.10.0
+ *
+ */
typedef enum {
VIR_VCPU_INFO_CPU_OFFLINE = -1, /* the vCPU is offline */
VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU information */
} virVcpuHostCpuState;
+/**
+ * virVcpuInfo:
+ *
+ * Since: v0.1.4
+ *
+ */
typedef struct _virVcpuInfo virVcpuInfo;
struct _virVcpuInfo {
unsigned int number; /* virtual CPU number */
unsigned long long cpuTime; /* CPU time used, in nanoseconds */
int cpu; /* real CPU number, or one of the values from virVcpuHostCpuState */
};
+
+/**
+ * virVcpuInfoPtr:
+ *
+ * Since: v0.1.4
+ *
+ */
typedef virVcpuInfo *virVcpuInfoPtr;
-/* Flags for controlling virtual CPU hot-plugging. */
+/**
+ * virDomainVcpuFlags:
+ *
+ * Flags for controlling virtual CPU hot-plugging.
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
/* See virDomainModificationImpact for these flags. */
VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
unsigned int flags);
/**
- * virIOThreadInfo:
+ * virDomainIOThreadInfo:
*
* The data structure for information about all IOThreads in a domain
+ *
+ * Since: v1.2.14
+ *
*/
typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo;
+
+
+/**
+ * virDomainIOThreadInfoPtr:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr;
struct _virDomainIOThreadInfo {
unsigned int iothread_id; /* IOThread ID */
# define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (maplen)]))
+/**
+ * virDomainDeviceModifyFlags:
+ *
+ * Since: v1.0.0
+ *
+ */
typedef enum {
/* See virDomainModificationImpact for these flags. */
VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
int virDomainDetachDeviceAlias(virDomainPtr domain,
const char *alias, unsigned int flags);
+/**
+ * virDomainStatsRecord:
+ *
+ * Since: v1.2.8
+ *
+ */
typedef struct _virDomainStatsRecord virDomainStatsRecord;
+
+/**
+ * virDomainStatsRecordPtr:
+ *
+ * Since: v1.2.8
+ *
+ */
typedef virDomainStatsRecord *virDomainStatsRecordPtr;
struct _virDomainStatsRecord {
virDomainPtr dom;
int nparams;
};
+/**
+ * virDomainStatsTypes:
+ *
+ * Since: v1.2.8
+ *
+ */
typedef enum {
VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state */
VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info */
VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info */
} virDomainStatsTypes;
+/**
+ * virConnectGetAllDomainStatsFlags:
+ *
+ * Since: v1.2.8
+ *
+ */
typedef enum {
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE,
* virDomainBlockJobType:
*
* Describes various possible block jobs.
+ *
+ * Since: v0.9.4
+ *
*/
typedef enum {
/* Placeholder */
* VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC: Request only, do not wait for completion
* VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT: Pivot to new file when ending a copy or
* active commit job
+ *
+ * Since: v0.9.12
+ *
*/
typedef enum {
VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0,
int virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
unsigned int flags);
-/* Flags for use with virDomainGetBlockJobInfo */
+/**
+ * virDomainBlockJobInfoFlags:
+ *
+ * Flags for use with virDomainGetBlockJobInfo
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s
instead of MiB/s */
} virDomainBlockJobInfoFlags;
-/* An iterator for monitoring block job operations */
-typedef unsigned long long virDomainBlockJobCursor;
-
-typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo;
-struct _virDomainBlockJobInfo {
+/**
+ * virDomainBlockJobCursor:
+ *
+ * An iterator for monitoring block job operations
+ *
+ * Since: v0.9.4
+ *
+ */
+typedef unsigned long long virDomainBlockJobCursor;
+
+/**
+ * virDomainBlockJobInfo:
+ *
+ * Since: v0.9.4
+ *
+ */
+typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo;
+struct _virDomainBlockJobInfo {
int type; /* virDomainBlockJobType */
unsigned long bandwidth; /* either bytes/s or MiB/s, according to flags */
virDomainBlockJobCursor cur;
virDomainBlockJobCursor end;
};
+
+/**
+ * virDomainBlockJobInfoPtr:
+ *
+ * Since: v0.9.4
+ *
+ */
typedef virDomainBlockJobInfo *virDomainBlockJobInfoPtr;
int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk,
virDomainBlockJobInfoPtr info,
unsigned int flags);
-/* Flags for use with virDomainBlockJobSetSpeed */
+/**
+ * virDomainBlockJobSetSpeedFlags:
+ *
+ * Flags for use with virDomainBlockJobSetSpeed
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s
instead of MiB/s */
int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk,
unsigned long bandwidth, unsigned int flags);
-/* Flags for use with virDomainBlockPull (values chosen to be a subset
- * of the flags for virDomainBlockRebase) */
+/**
+ * virDomainBlockPullFlags:
+ *
+ * Flags for use with virDomainBlockPull (values chosen to be a subset of the
+ * flags for virDomainBlockRebase)
+ *
+ * Since: v1.2.9
+ *
+ */
typedef enum {
VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s
instead of MiB/s */
* virDomainBlockRebaseFlags:
*
* Flags available for virDomainBlockRebase().
+ *
+ * Since: v0.9.12
+ *
*/
typedef enum {
VIR_DOMAIN_BLOCK_REBASE_SHALLOW = 1 << 0, /* Limit copy to top of source
* virDomainBlockCopyFlags:
*
* Flags available for virDomainBlockCopy().
+ *
+ * Since: v1.2.8
+ *
*/
typedef enum {
/* Limit copy to top of source backing chain */
* virDomainBlockCommitFlags:
*
* Flags available for virDomainBlockCommit().
+ *
+ * Since: v0.10.2
+ *
*/
typedef enum {
VIR_DOMAIN_BLOCK_COMMIT_SHALLOW = 1 << 0, /* NULL base means next backing
* virDomainDiskErrorCode:
*
* Disk I/O error.
+ *
+ * Since: v0.9.10
+ *
*/
typedef enum {
VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error */
/**
* virDomainDiskError:
*
+ * Since: v0.9.10
+ *
*/
typedef struct _virDomainDiskError virDomainDiskError;
+
+/**
+ * virDomainDiskErrorPtr:
+ *
+ * Since: v0.9.10
+ *
+ */
typedef virDomainDiskError *virDomainDiskErrorPtr;
struct _virDomainDiskError {
* virKeycodeSet:
*
* Enum to specify which keycode mapping is in use for virDomainSendKey().
+ *
+ * Since: v0.9.3
+ *
*/
typedef enum {
VIR_KEYCODE_SET_LINUX = 0,
int nkeycodes,
unsigned int flags);
-/*
+/**
+ * virDomainProcessSignal:
+ *
* These just happen to match Linux signal numbers. The numbers
* will be mapped to whatever the SIGNUM is in the guest OS in
* question by the agent delivering the signal. The names are
* Do not rely on all values matching Linux though. It is possible
* this enum might be extended with new signals which have no
* mapping in Linux.
+ *
+ * Since: v1.0.1
+ *
*/
typedef enum {
VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux */
* virDomainEventType:
*
* a virDomainEventType is emitted during domain lifecycle events
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_DEFINED = 0,
* virDomainEventDefinedDetailType:
*
* Details on the cause of a 'defined' lifecycle event
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file */
* virDomainEventUndefinedDetailType:
*
* Details on the cause of an 'undefined' lifecycle event
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file */
* virDomainEventStartedDetailType:
*
* Details on the cause of a 'started' lifecycle event
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot */
* virDomainEventSuspendedDetailType:
*
* Details on the cause of a 'suspended' lifecycle event
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause */
* virDomainEventResumedDetailType:
*
* Details on the cause of a 'resumed' lifecycle event
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause */
* virDomainEventStoppedDetailType:
*
* Details on the cause of a 'stopped' lifecycle event
+ *
+ * Since: v0.5.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown */
* virDomainEventShutdownDetailType:
*
* Details on the cause of a 'shutdown' lifecycle event
+ *
+ * Since: v0.9.8
+ *
*/
typedef enum {
/* Guest finished shutdown sequence */
* virDomainEventPMSuspendedDetailType:
*
* Details on the cause of a 'pmsuspended' lifecycle event
+ *
+ * Since: v0.10.2
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory */
* virDomainEventCrashedDetailType:
*
* Details on the cause of a 'crashed' lifecycle event
+ *
+ * Since: v1.1.1
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked */
* virDomainMemoryFailureRecipientType:
*
* Recipient of a memory failure event.
+ *
+ * Since: v6.9.0
+ *
*/
typedef enum {
/* memory failure at hypersivor memory address space */
* virDomainMemoryFailureActionType:
*
* Action of a memory failure event.
+ *
+ * Since: v6.9.0
+ *
*/
typedef enum {
/* the memory failure could be ignored. This will only be the case for
} virDomainMemoryFailureActionType;
+/**
+ * virDomainMemoryFailureFlags:
+ *
+ * Since: v6.9.0
+ *
+ */
typedef enum {
/* whether a memory failure event is action-required or action-optional
* (e.g. a failure during memory scrub). */
int virDomainIsPersistent(virDomainPtr dom);
int virDomainIsUpdated(virDomainPtr dom);
+/**
+ * virDomainJobType:
+ *
+ * Since: v0.7.7
+ *
+ */
typedef enum {
VIR_DOMAIN_JOB_NONE = 0, /* No job is active */
VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time */
# endif
} virDomainJobType;
+/**
+ * virDomainJobInfo:
+ *
+ * Since: v0.7.7
+ *
+ */
typedef struct _virDomainJobInfo virDomainJobInfo;
+
+/**
+ * virDomainJobInfoPtr:
+ *
+ * Since: v0.7.7
+ *
+ */
typedef virDomainJobInfo *virDomainJobInfoPtr;
struct _virDomainJobInfo {
/* One of virDomainJobType */
*
* Flags OR'ed together to provide specific behavior when querying domain
* job statistics.
+ *
+ * Since: v1.2.9
+ *
*/
typedef enum {
VIR_DOMAIN_JOB_STATS_COMPLETED = 1 << 0, /* return stats of a recently
unsigned int flags);
int virDomainAbortJob(virDomainPtr dom);
+/**
+ * virDomainJobOperation:
+ *
+ * Since: v3.3.0
+ *
+ */
typedef enum {
VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0,
VIR_DOMAIN_JOB_OPERATION_START = 1,
* virDomainEventWatchdogAction:
*
* The action that is to be taken due to the watchdog device firing
+ *
+ * Since: v0.8.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored */
* virDomainEventIOErrorAction:
*
* The action that is to be taken due to an IO error occurring
+ *
+ * Since: v0.8.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored */
* virDomainEventGraphicsPhase:
*
* The phase of the graphics client connection
+ *
+ * Since: v0.8.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established */
* virDomainEventGraphicsAddressType:
*
* The type of address for the connection
+ *
+ * Since: v0.8.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address */
/**
- * virDomainEventGraphicsAddress:
+ * _virDomainEventGraphicsAddress:
*
* The data structure containing connection address details
*
+ * Since: v1.0.0
+ *
*/
struct _virDomainEventGraphicsAddress {
int family; /* Address family, virDomainEventGraphicsAddressType */
char *node; /* Address of node (eg IP address, or UNIX path) */
char *service; /* Service name/number (eg TCP port, or NULL) */
};
+
+/**
+ * virDomainEventGraphicsAddress:
+ *
+ * Since: v0.8.0
+ *
+ */
typedef struct _virDomainEventGraphicsAddress virDomainEventGraphicsAddress;
+
+/**
+ * virDomainEventGraphicsAddressPtr:
+ *
+ * Since: v0.8.0
+ *
+ */
typedef virDomainEventGraphicsAddress *virDomainEventGraphicsAddressPtr;
/**
- * virDomainEventGraphicsSubjectIdentity:
+ * _virDomainEventGraphicsSubjectIdentity:
*
* The data structure representing a single identity
*
char *type; /* Type of identity */
char *name; /* Identity value */
};
+
+/**
+ * virDomainEventGraphicsSubjectIdentity:
+ *
+ * Since: v0.8.0
+ *
+ */
typedef struct _virDomainEventGraphicsSubjectIdentity virDomainEventGraphicsSubjectIdentity;
+
+/**
+ * virDomainEventGraphicsSubjectIdentityPtr:
+ *
+ * Since: v0.8.0
+ *
+ */
typedef virDomainEventGraphicsSubjectIdentity *virDomainEventGraphicsSubjectIdentityPtr;
*
* A subject will have zero or more identities. The types of
* identity differ according to the authentication scheme
+ *
+ * Since: v0.8.0
+ *
*/
struct _virDomainEventGraphicsSubject {
int nidentity; /* Number of identities in array*/
virDomainEventGraphicsSubjectIdentityPtr identities; /* Array of identities for subject */
};
+
+/**
+ * virDomainEventGraphicsSubject:
+ *
+ * Since: v0.8.0
+ *
+ */
typedef struct _virDomainEventGraphicsSubject virDomainEventGraphicsSubject;
+
+/**
+ * virDomainEventGraphicsSubjectPtr:
+ *
+ * Since: v0.8.0
+ *
+ */
typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr;
*
* Tracks status of a virDomainBlockPull(), virDomainBlockRebase(),
* virDomainBlockCopy(), or virDomainBlockCommit() operation
+ *
+ * Since: v0.9.4
+ *
*/
typedef enum {
VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0,
* virConnectDomainEventDiskChangeReason:
*
* The reason describing why this callback is called
+ *
+ * Since: v0.9.7
+ *
*/
typedef enum {
/* Removable media changed to empty according to startup policy as source
* virDomainEventTrayChangeReason:
*
* The reason describing why the callback was called
+ *
+ * Since: v0.9.11
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0,
void *opaque);
+/**
+ * virConnectDomainEventAgentLifecycleState:
+ *
+ * Since: v1.2.11
+ *
+ */
typedef enum {
VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected */
VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected */
# endif
} virConnectDomainEventAgentLifecycleState;
+/**
+ * virConnectDomainEventAgentLifecycleReason:
+ *
+ * Since: v1.2.11
+ *
+ */
typedef enum {
VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason */
VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start */
* An enumeration of supported eventId parameters for
* virConnectDomainEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
+ *
+ * Since: v0.8.0
+ *
*/
typedef enum {
VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback */
/**
- * virDomainConsoleFlags
+ * virDomainConsoleFlags:
+ *
+ * Since: v0.9.11
*
- * Since 0.9.10
*/
typedef enum {
unsigned int flags);
/**
- * virDomainChannelFlags
+ * virDomainChannelFlags:
*
- * Since 1.0.2
+ * Since: v1.0.2
*/
typedef enum {
VIR_DOMAIN_CHANNEL_FORCE = (1 << 0), /* abort a (possibly) active channel
virStreamPtr st,
unsigned int flags);
+/**
+ * virDomainOpenGraphicsFlags:
+ *
+ * Since: v0.9.7
+ *
+ */
typedef enum {
VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0),
} virDomainOpenGraphicsFlags;
*
* The data structure containing mounted file systems within a guset
*
+ * Since: v1.2.11
+ *
+ *
*/
typedef struct _virDomainFSInfo virDomainFSInfo;
+
+/**
+ * virDomainFSInfoPtr:
+ *
+ * Since: v1.2.11
+ *
+ */
typedef virDomainFSInfo *virDomainFSInfoPtr;
+
struct _virDomainFSInfo {
char *mountpoint; /* path to mount point */
char *name; /* device name in the guest (e.g. "sda1") */
long long *seconds,
unsigned int *nseconds,
unsigned int flags);
-
+/**
+ * virDomainSetTimeFlags:
+ *
+ * Since: v1.2.5
+ *
+ */
typedef enum {
VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC */
} virDomainSetTimeFlags;
* virSchedParameterType:
*
* A scheduler parameter field type. Provided for backwards
- * compatibility; virTypedParameterType is the preferred enum since
- * 0.9.2.
+ * compatibility; virTypedParameterType is the preferred enum
+ *
+ * Since: v0.2.3
+ *
*/
typedef enum {
VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT,
* Provided for backwards compatibility; virTypedParameter is the
* preferred alias.
*
- * Since: v0.9.2
+ * Since: v0.2.3
*/
typedef struct _virTypedParameter virSchedParameter;
* a virSchedParameterPtr is a pointer to a virSchedParameter structure.
* Provided for backwards compatibility; virTypedParameterPtr is the
* preferred alias since 0.9.2.
+ *
+ * Since: v0.2.3
+ *
*/
typedef virSchedParameter *virSchedParameterPtr;
* virBlkioParameterType:
*
* A blkio parameter field type. Provided for backwards
- * compatibility; virTypedParameterType is the preferred enum since
- * 0.9.2.
+ * compatibility; virTypedParameterType is the preferred enum
+ *
+ * Since: v0.9.0
+ *
*/
typedef enum {
VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT,
* Provided for backwards compatibility; virTypedParameter is the
* preferred alias.
*
- * Since: v0.9.2
+ * Since: v0.9.0
*/
typedef struct _virTypedParameter virBlkioParameter;
*
* a virBlkioParameterPtr is a pointer to a virBlkioParameter structure.
* Provided for backwards compatibility; virTypedParameterPtr is the
- * preferred alias since 0.9.2.
+ * preferred alias.
+ *
+ * Since: v0.9.0
+ *
*/
typedef virBlkioParameter *virBlkioParameterPtr;
* virMemoryParameterType:
*
* A memory parameter field type. Provided for backwards
- * compatibility; virTypedParameterType is the preferred enum since
- * 0.9.2.
+ * compatibility; virTypedParameterType is the preferred enum
+ *
+ * Since: v0.8.5
+ *
*/
typedef enum {
VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT,
* Provided for backwards compatibility; virTypedParameter is the
* preferred alias.
*
- * Since: v0.9.2
+ * Since: v0.8.5
*/
typedef struct _virTypedParameter virMemoryParameter;
*
* a virMemoryParameterPtr is a pointer to a virMemoryParameter structure.
* Provided for backwards compatibility; virTypedParameterPtr is the
- * preferred alias since 0.9.2.
+ * preferred alias.
+ *
+ * Since: v0.8.5
+ *
*/
typedef virMemoryParameter *virMemoryParameterPtr;
+/**
+ * virDomainInterfaceAddressesSource:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef enum {
VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file */
VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent */
# endif
} virDomainInterfaceAddressesSource;
+/**
+ * virDomainIPAddress:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef struct _virDomainInterfaceIPAddress virDomainIPAddress;
+
+/**
+ * virDomainIPAddressPtr:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef virDomainIPAddress *virDomainIPAddressPtr;
struct _virDomainInterfaceIPAddress {
int type; /* virIPAddrType */
unsigned int prefix; /* IP address prefix */
};
+/**
+ * virDomainInterface:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef struct _virDomainInterface virDomainInterface;
+
+/**
+ * virDomainInterfacePtr:
+ *
+ * Since: v1.2.14
+ *
+ */
typedef virDomainInterface *virDomainInterfacePtr;
struct _virDomainInterface {
char *name; /* interface name */
void virDomainInterfaceFree(virDomainInterfacePtr iface);
+/**
+ * virDomainSetUserPasswordFlags:
+ *
+ * Since: v1.2.16
+ *
+ */
typedef enum {
VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted */
} virDomainSetUserPasswordFlags;
unsigned long long threshold,
unsigned int flags);
+/**
+ * virDomainLifecycle:
+ *
+ * Since: v3.9.0
+ *
+ */
typedef enum {
VIR_DOMAIN_LIFECYCLE_POWEROFF = 0,
VIR_DOMAIN_LIFECYCLE_REBOOT = 1,
# endif
} virDomainLifecycle;
+/**
+ * virDomainLifecycleAction:
+ *
+ * Since: v3.9.0
+ *
+ */
typedef enum {
VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0,
VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1,
int nparams,
unsigned int flags);
+/**
+ * virDomainGuestInfoTypes:
+ *
+ * Since: v5.7.0
+ *
+ */
typedef enum {
VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users */
VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information */
int *nparams,
unsigned int flags);
+/**
+ * virDomainAgentResponseTimeoutValues:
+ *
+ * Since: v5.10.0
+ *
+ */
typedef enum {
VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2,
VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1,
int timeout,
unsigned int flags);
+/**
+ * virDomainBackupBeginFlags:
+ *
+ * Since: v6.0.0
+ *
+ */
typedef enum {
VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL = (1 << 0), /* reuse separately
provided images */
char ***keys,
unsigned int flags);
+/**
+ * virDomainAuthorizedSSHKeysSetFlags:
+ *
+ * Since: v6.10.0
+ *
+ */
typedef enum {
VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND = (1 << 0), /* don't truncate file, just append */
VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE = (1 << 1), /* remove keys, instead of adding them */
unsigned int nkeys,
unsigned int flags);
+/**
+ * virDomainMessageType:
+ *
+ * Since: v7.1.0
+ *
+ */
typedef enum {
VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0),
VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1),
* virDomainDirtyRateStatus:
*
* Details on the cause of a dirty rate calculation status.
+ *
+ * Since: v7.2.0
+ *
*/
typedef enum {
VIR_DOMAIN_DIRTYRATE_UNSTARTED = 0, /* the dirtyrate calculation has
* Flags OR'ed together to provide specific behaviour when calculating dirty page
* rate for a Domain
*
+ *
+ * Since: v8.1.0
+ *
*/
typedef enum {
VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling */
projects / thirdparty / libvirt.git / commitdiff
