* a virAdmConnect is a private structure representing a connection to
* libvirt daemon.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef struct _virAdmConnect virAdmConnect;
* a virAdmServer is a private structure and client-side representation of
* a remote server object
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef struct _virAdmServer virAdmServer;
* a virAdmClient is a private structure and client-side representation of
* a remote server's client object (as server sees clients connected to it)
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef struct _virAdmClient virAdmClient;
* this is the type used to reference a connection to the daemon
* in the API.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef virAdmConnect *virAdmConnectPtr;
* this is the type used to reference client-side representation of a
* remote server object throughout all the APIs.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef virAdmServer *virAdmServerPtr;
* this is the type used to reference client-side representation of a
* client object throughout all the APIs.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef virAdmClient *virAdmClientPtr;
*
* A callback to be registered, in case a connection was closed.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef void (*virAdmConnectCloseFunc)(virAdmConnectPtr conn,
int reason,
* Macro for the threadpool minWorkers limit: represents the bottom limit to
* number of active workers in threadpool, as VIR_TYPED_PARAM_UINT.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_MIN "minWorkers"
* The value of this limit has to be greater than VIR_THREADPOOL_WORKERS_MIN
* at all times.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_MAX "maxWorkers"
* Macro for the threadpool nPrioWorkers attribute: represents the current number
* of active priority workers in threadpool, as VIR_TYPED_PARAM_UINT.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_PRIORITY "prioWorkers"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_FREE "freeWorkers"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_CURRENT "nWorkers"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_THREADPOOL_JOB_QUEUE_DEPTH "jobQueueDepth"
/**
* virClientTransport:
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef enum {
- VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v2.0.0) */
- VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: v2.0.0) */
- VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: v2.0.0) */
+ VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: 2.0.0) */
+ VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: 2.0.0) */
+ VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: 2.0.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_CLIENT_TRANS_LAST /* (Since: v2.0.0) */
+ VIR_CLIENT_TRANS_LAST /* (Since: 2.0.0) */
# endif
} virClientTransport;
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_READONLY "readonly"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_SOCKET_ADDR "sock_addr"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_SASL_USER_NAME "sasl_user_name"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME "tls_x509_dname"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_USER_ID "unix_user_id"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_USER_NAME "unix_user_name"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_GROUP_ID "unix_group_id"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_GROUP_NAME "unix_group_name"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_PROCESS_ID "unix_process_id"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_CLIENT_INFO_SELINUX_CONTEXT "selinux_context"
* Macro for per-server nclients_max limit: represents the upper limit to
* number of clients connected to the server, as uint.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_MAX "nclients_max"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_CURRENT "nclients"
* to number of clients connected to the server, but not authenticated yet,
* as VIR_TYPED_PARAM_UINT.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_UNAUTH_MAX "nclients_unauth_max"
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_UNAUTH_CURRENT "nclients_unauth"
* Macro providing the version of the library as
* version * 1,000,000 + minor * 1000 + micro
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
# define LIBVIR_VERSION_NUMBER @LIBVIRT_VERSION_NUMBER@
* // some code that only works in 1.1.3 and newer
* #endif
*
- * Since: v1.2.0
+ * Since: 1.2.0
*/
# define LIBVIR_CHECK_VERSION(major, minor, micro) \
((major) * 1000000 + (minor) * 1000 + (micro) <= LIBVIR_VERSION_NUMBER)
* abide by this requirement may lead to application deadlocks
* or crashes.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef void (*virFreeCallback)(void *opaque);
/**
* virConnectCloseReason:
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
typedef enum {
- VIR_CONNECT_CLOSE_REASON_ERROR = 0, /* Misc I/O error (Since: v0.10.0) */
- VIR_CONNECT_CLOSE_REASON_EOF = 1, /* End-of-file from server (Since: v0.10.0) */
- VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2, /* Keepalive timer triggered (Since: v0.10.0) */
- VIR_CONNECT_CLOSE_REASON_CLIENT = 3, /* Client requested it (Since: v0.10.0) */
+ VIR_CONNECT_CLOSE_REASON_ERROR = 0, /* Misc I/O error (Since: 0.10.0) */
+ VIR_CONNECT_CLOSE_REASON_EOF = 1, /* End-of-file from server (Since: 0.10.0) */
+ VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2, /* Keepalive timer triggered (Since: 0.10.0) */
+ VIR_CONNECT_CLOSE_REASON_CLIENT = 3, /* Client requested it (Since: 0.10.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_CONNECT_CLOSE_REASON_LAST /* (Since: v0.10.0) */
+ VIR_CONNECT_CLOSE_REASON_LAST /* (Since: 0.10.0) */
# endif
} virConnectCloseReason;
*
* Express the type of a virTypedParameter
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_TYPED_PARAM_INT = 1, /* integer case (Since: v0.9.2) */
- VIR_TYPED_PARAM_UINT = 2, /* unsigned integer case (Since: v0.9.2) */
- VIR_TYPED_PARAM_LLONG = 3, /* long long case (Since: v0.9.2) */
- VIR_TYPED_PARAM_ULLONG = 4, /* unsigned long long case (Since: v0.9.2) */
- VIR_TYPED_PARAM_DOUBLE = 5, /* double case (Since: v0.9.2) */
- VIR_TYPED_PARAM_BOOLEAN = 6, /* boolean(character) case (Since: v0.9.2) */
- VIR_TYPED_PARAM_STRING = 7, /* string case (Since: v0.9.8) */
+ VIR_TYPED_PARAM_INT = 1, /* integer case (Since: 0.9.2) */
+ VIR_TYPED_PARAM_UINT = 2, /* unsigned integer case (Since: 0.9.2) */
+ VIR_TYPED_PARAM_LLONG = 3, /* long long case (Since: 0.9.2) */
+ VIR_TYPED_PARAM_ULLONG = 4, /* unsigned long long case (Since: 0.9.2) */
+ VIR_TYPED_PARAM_DOUBLE = 5, /* double case (Since: 0.9.2) */
+ VIR_TYPED_PARAM_BOOLEAN = 6, /* boolean(character) case (Since: 0.9.2) */
+ VIR_TYPED_PARAM_STRING = 7, /* string case (Since: 0.9.8) */
# ifdef VIR_ENUM_SENTINELS
- VIR_TYPED_PARAM_LAST /* (Since: v0.9.10) */
+ VIR_TYPED_PARAM_LAST /* (Since: 0.9.10) */
# endif
} virTypedParameterType;
*
* These enums should not conflict with those of virDomainModificationImpact.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
typedef enum {
/* 1 << 0 is reserved for virDomainModificationImpact */
* setting the flag can be used to reject servers that cannot
* return typed strings, even if no strings would be returned.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
VIR_TYPED_PARAM_STRING_OKAY = 1 << 2,
*
* Macro providing the field length of virTypedParameter name
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
# define VIR_TYPED_PARAM_FIELD_LENGTH 80
* virMemoryParameter are aliases of this type, for use when
* targeting libvirt earlier than 0.9.2.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef struct _virTypedParameter virTypedParameter;
*
* a pointer to a virTypedParameter structure.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef virTypedParameter *virTypedParameterPtr;
* domain disks have been altered since a point in time, but by itself does
* not allow reverting back to that point in time.
*
- * Since: v5.2.0
+ * Since: 5.2.0
*/
typedef struct _virDomainCheckpoint virDomainCheckpoint;
* private structure, and is the type used to reference a domain
* checkpoint in the API.
*
- * Since: v5.2.0
+ * Since: 5.2.0
*/
typedef virDomainCheckpoint *virDomainCheckpointPtr;
/**
* virDomainCheckpointCreateFlags:
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
typedef enum {
VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE = (1 << 0), /* Restore or alter
- metadata (Since: v5.6.0) */
+ metadata (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_CREATE_QUIESCE = (1 << 1), /* use guest agent to
quiesce all mounted
file systems within
- the domain (Since: v5.6.0) */
+ the domain (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE_VALIDATE = (1 << 2), /* validate disk data state
- when redefining a checkpoint (Since: v6.10.0) */
+ when redefining a checkpoint (Since: 6.10.0) */
} virDomainCheckpointCreateFlags;
/* Create a checkpoint using the current VM state. */
/**
* virDomainCheckpointXMLFlags:
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
typedef enum {
- VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: v5.6.0) */
+ VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN = (1 << 1), /* Suppress <domain>
- subelement (Since: v5.6.0) */
+ subelement (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_XML_SIZE = (1 << 2), /* Include dynamic
- per-<disk> size (Since: v5.6.0) */
+ per-<disk> size (Since: 5.6.0) */
} virDomainCheckpointXMLFlags;
/* Dump the XML of a checkpoint */
* recursive. Remaining bits come in groups; if all bits from a group
* are 0, then that group is not used to filter results.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
typedef enum {
VIR_DOMAIN_CHECKPOINT_LIST_ROOTS = (1 << 0), /* Filter by checkpoints
with no parents, when
- listing a domain (Since: v5.6.0) */
+ listing a domain (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_DESCENDANTS = (1 << 0), /* List all descendants,
not just children, when
- listing a checkpoint (Since: v5.6.0) */
+ listing a checkpoint (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_TOPOLOGICAL = (1 << 1), /* Ensure parents occur
before children in
- the resulting list (Since: v5.6.0) */
+ the resulting list (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_LEAVES = (1 << 2), /* Filter by checkpoints
- with no children (Since: v5.6.0) */
+ with no children (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_NO_LEAVES = (1 << 3), /* Filter by checkpoints
- that have children (Since: v5.6.0) */
+ that have children (Since: 5.6.0) */
} virDomainCheckpointListFlags;
/* Get all checkpoint objects for this domain */
*
* Delete a checkpoint
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
typedef enum {
- VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: v5.6.0) */
- VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: v5.6.0) */
- VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v5.6.0) */
+ VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: 5.6.0) */
+ VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: 5.6.0) */
+ VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: 5.6.0) */
} virDomainCheckpointDeleteFlags;
int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint,
* time, with the intent that the guest can be reverted back to that
* state at a later time.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef struct _virDomainSnapshot virDomainSnapshot;
* A virDomainSnapshotPtr is pointer to a virDomainSnapshot private structure,
* and is the type used to reference a domain snapshot in the API.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef virDomainSnapshot *virDomainSnapshotPtr;
/**
* virDomainSnapshotCreateFlags:
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE = (1 << 0), /* Restore or alter
- metadata (Since: v0.9.5) */
+ metadata (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT = (1 << 1), /* With redefine, make
- snapshot current (Since: v0.9.5) */
+ snapshot current (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA = (1 << 2), /* Make snapshot without
- remembering it (Since: v0.9.5) */
+ remembering it (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_HALT = (1 << 3), /* Stop running guest
- after snapshot (Since: v0.9.5) */
+ after snapshot (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY = (1 << 4), /* disk snapshot, not
- full system (Since: v0.9.5) */
+ full system (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT = (1 << 5), /* reuse any existing
- external files (Since: v0.9.10) */
+ external files (Since: 0.9.10) */
VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE = (1 << 6), /* use guest agent to
quiesce all mounted
file systems within
- the domain (Since: v0.9.10) */
+ the domain (Since: 0.9.10) */
VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC = (1 << 7), /* atomically avoid
- partial changes (Since: v0.9.11) */
+ partial changes (Since: 0.9.11) */
VIR_DOMAIN_SNAPSHOT_CREATE_LIVE = (1 << 8), /* create the snapshot
while the guest is
- running (Since: v1.0.1) */
+ running (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_CREATE_VALIDATE = (1 << 9), /* validate the XML
- against the schema (Since: v5.6.0) */
+ against the schema (Since: 5.6.0) */
} virDomainSnapshotCreateFlags;
/* Take a snapshot of the current VM state */
/**
* virDomainSnapshotXMLFlags:
*
- * Since: v5.1.0
+ * Since: 5.1.0
*/
typedef enum {
- VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */
+ VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: 5.1.0) */
} virDomainSnapshotXMLFlags;
/* Dump the XML of a snapshot */
* recursive. Remaining bits come in groups; if all bits from a group are
* 0, then that group is not used to filter results.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_LIST_ROOTS = (1 << 0), /* Filter by snapshots
with no parents, when
- listing a domain (Since: v0.9.5) */
+ listing a domain (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS = (1 << 0), /* List all descendants,
not just children, when
- listing a snapshot (Since: v0.9.7) */
+ listing a snapshot (Since: 0.9.7) */
VIR_DOMAIN_SNAPSHOT_LIST_LEAVES = (1 << 2), /* Filter by snapshots
- with no children (Since: v0.9.7) */
+ with no children (Since: 0.9.7) */
VIR_DOMAIN_SNAPSHOT_LIST_NO_LEAVES = (1 << 3), /* Filter by snapshots
- that have children (Since: v0.9.13) */
+ that have children (Since: 0.9.13) */
VIR_DOMAIN_SNAPSHOT_LIST_METADATA = (1 << 1), /* Filter by snapshots
- which have metadata (Since: v0.9.5) */
+ which have metadata (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_LIST_NO_METADATA = (1 << 4), /* Filter by snapshots
- with no metadata (Since: v0.9.13) */
+ with no metadata (Since: 0.9.13) */
VIR_DOMAIN_SNAPSHOT_LIST_INACTIVE = (1 << 5), /* Filter by snapshots
taken while guest was
- shut off (Since: v1.0.1) */
+ shut off (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_ACTIVE = (1 << 6), /* Filter by snapshots
taken while guest was
active, and with
- memory state (Since: v1.0.1) */
+ memory state (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_DISK_ONLY = (1 << 7), /* Filter by snapshots
taken while guest was
active, but without
- memory state (Since: v1.0.1) */
+ memory state (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_INTERNAL = (1 << 8), /* Filter by snapshots
stored internal to
- disk images (Since: v1.0.1) */
+ disk images (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_EXTERNAL = (1 << 9), /* Filter by snapshots
that use files external
- to disk images (Since: v1.0.1) */
+ to disk images (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_TOPOLOGICAL = (1 << 10), /* Ensure parents occur
before children in
- the resulting list (Since: v5.2.0) */
+ the resulting list (Since: 5.2.0) */
} virDomainSnapshotListFlags;
/* Return the number of snapshots for this domain */
/**
* virDomainSnapshotRevertFlags:
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
typedef enum {
- VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: v0.9.5) */
- VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: v0.9.5) */
- VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: v0.9.7) */
- VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */
+ VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: 0.9.5) */
+ VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: 0.9.5) */
+ VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: 0.9.7) */
+ VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: 8.1.0) */
} virDomainSnapshotRevertFlags;
/* Revert the domain to a point-in-time snapshot. The
*
* Delete a snapshot
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef enum {
- VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: v0.8.0) */
- VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: v0.9.5) */
- VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v0.9.5) */
+ VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: 0.8.0) */
+ VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: 0.9.5) */
+ VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: 0.9.5) */
} virDomainSnapshotDeleteFlags;
int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
*
* a virDomain is a private structure representing a domain.
*
- * Since: v0.0.1
+ * Since: 0.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
+ * Since: 0.0.1
*/
typedef virDomain *virDomainPtr;
*
* A domain may be in different states at a given point in time
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
typedef enum {
- VIR_DOMAIN_NOSTATE = 0, /* no state (Since: v0.0.1) */
- VIR_DOMAIN_RUNNING = 1, /* the domain is running (Since: v0.0.1) */
- VIR_DOMAIN_BLOCKED = 2, /* the domain is blocked on resource (Since: v0.0.1) */
- VIR_DOMAIN_PAUSED = 3, /* the domain is paused by user (Since: v0.0.1) */
- VIR_DOMAIN_SHUTDOWN= 4, /* the domain is being shut down (Since: v0.0.1) */
- VIR_DOMAIN_SHUTOFF = 5, /* the domain is shut off (Since: v0.0.1) */
- VIR_DOMAIN_CRASHED = 6, /* the domain is crashed (Since: v0.0.2) */
+ VIR_DOMAIN_NOSTATE = 0, /* no state (Since: 0.0.1) */
+ VIR_DOMAIN_RUNNING = 1, /* the domain is running (Since: 0.0.1) */
+ VIR_DOMAIN_BLOCKED = 2, /* the domain is blocked on resource (Since: 0.0.1) */
+ VIR_DOMAIN_PAUSED = 3, /* the domain is paused by user (Since: 0.0.1) */
+ VIR_DOMAIN_SHUTDOWN= 4, /* the domain is being shut down (Since: 0.0.1) */
+ VIR_DOMAIN_SHUTOFF = 5, /* the domain is shut off (Since: 0.0.1) */
+ VIR_DOMAIN_CRASHED = 6, /* the domain is crashed (Since: 0.0.2) */
VIR_DOMAIN_PMSUSPENDED = 7, /* the domain is suspended by guest
- power management (Since: v0.9.11) */
+ power management (Since: 0.9.11) */
# ifdef VIR_ENUM_SENTINELS
VIR_DOMAIN_LAST
* added to the libvirt API. It reflects the last state supported
* by this version of the libvirt API.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# endif
} virDomainState;
/**
* virDomainNostateReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_NOSTATE_UNKNOWN = 0, /* (Since: v0.9.2) */
+ VIR_DOMAIN_NOSTATE_UNKNOWN = 0, /* (Since: 0.9.2) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_NOSTATE_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_NOSTATE_LAST /* (Since: 0.9.10) */
# endif
} virDomainNostateReason;
/**
* virDomainRunningReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_RUNNING_UNKNOWN = 0, /* (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_MIGRATED = 2, /* migrated from another host (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_RESTORED = 3, /* restored from a state file (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4, /* restored from snapshot (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_UNPAUSED = 5, /* returned from paused state (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6, /* returned from migration (Since: v0.9.2) */
- VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7, /* returned from failed save process (Since: v0.9.2) */
+ VIR_DOMAIN_RUNNING_UNKNOWN = 0, /* (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_BOOTED = 1, /* normal startup from boot (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_MIGRATED = 2, /* migrated from another host (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_RESTORED = 3, /* restored from a state file (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_FROM_SNAPSHOT = 4, /* restored from snapshot (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_UNPAUSED = 5, /* returned from paused state (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_MIGRATION_CANCELED = 6, /* returned from migration (Since: 0.9.2) */
+ VIR_DOMAIN_RUNNING_SAVE_CANCELED = 7, /* returned from failed save process (Since: 0.9.2) */
VIR_DOMAIN_RUNNING_WAKEUP = 8, /* returned from pmsuspended due to
- wakeup event (Since: v0.9.11) */
- VIR_DOMAIN_RUNNING_CRASHED = 9, /* resumed from crashed (Since: v1.1.1) */
- VIR_DOMAIN_RUNNING_POSTCOPY = 10, /* running in post-copy migration mode (Since: v1.3.3) */
+ wakeup event (Since: 0.9.11) */
+ VIR_DOMAIN_RUNNING_CRASHED = 9, /* resumed from crashed (Since: 1.1.1) */
+ VIR_DOMAIN_RUNNING_POSTCOPY = 10, /* running in post-copy migration mode (Since: 1.3.3) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_RUNNING_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_RUNNING_LAST /* (Since: 0.9.10) */
# endif
} virDomainRunningReason;
/**
* virDomainBlockedReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */
+ VIR_DOMAIN_BLOCKED_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_BLOCKED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_BLOCKED_LAST /* (Since: 0.9.10) */
# endif
} virDomainBlockedReason;
/**
* virDomainPausedReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_MIGRATION = 2, /* paused for offline migration (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_SAVE = 3, /* paused for save (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_DUMP = 4, /* paused for offline core dump (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_IOERROR = 5, /* paused due to a disk I/O error (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_WATCHDOG = 6, /* paused due to a watchdog event (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7, /* paused after restoring from snapshot (Since: v0.9.2) */
- VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8, /* paused during shutdown process (Since: v0.9.5) */
- VIR_DOMAIN_PAUSED_SNAPSHOT = 9, /* paused while creating a snapshot (Since: v1.0.1) */
- VIR_DOMAIN_PAUSED_CRASHED = 10, /* paused due to a guest crash (Since: v1.1.1) */
- VIR_DOMAIN_PAUSED_STARTING_UP = 11, /* the domain is being started (Since: v1.2.14) */
- VIR_DOMAIN_PAUSED_POSTCOPY = 12, /* paused for post-copy migration (Since: v1.3.3) */
- VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13, /* paused after failed post-copy (Since: v1.3.3) */
+ VIR_DOMAIN_PAUSED_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_USER = 1, /* paused on user request (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_MIGRATION = 2, /* paused for offline migration (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_SAVE = 3, /* paused for save (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_DUMP = 4, /* paused for offline core dump (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_IOERROR = 5, /* paused due to a disk I/O error (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_WATCHDOG = 6, /* paused due to a watchdog event (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_FROM_SNAPSHOT = 7, /* paused after restoring from snapshot (Since: 0.9.2) */
+ VIR_DOMAIN_PAUSED_SHUTTING_DOWN = 8, /* paused during shutdown process (Since: 0.9.5) */
+ VIR_DOMAIN_PAUSED_SNAPSHOT = 9, /* paused while creating a snapshot (Since: 1.0.1) */
+ VIR_DOMAIN_PAUSED_CRASHED = 10, /* paused due to a guest crash (Since: 1.1.1) */
+ VIR_DOMAIN_PAUSED_STARTING_UP = 11, /* the domain is being started (Since: 1.2.14) */
+ VIR_DOMAIN_PAUSED_POSTCOPY = 12, /* paused for post-copy migration (Since: 1.3.3) */
+ VIR_DOMAIN_PAUSED_POSTCOPY_FAILED = 13, /* paused after failed post-copy (Since: 1.3.3) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_PAUSED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_PAUSED_LAST /* (Since: 0.9.10) */
# endif
} virDomainPausedReason;
/**
* virDomainShutdownReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */
- VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request (Since: v0.9.2) */
+ VIR_DOMAIN_SHUTDOWN_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTDOWN_USER = 1, /* shutting down on user request (Since: 0.9.2) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_SHUTDOWN_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_SHUTDOWN_LAST /* (Since: 0.9.10) */
# endif
} virDomainShutdownReason;
/**
* virDomainShutoffReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown (Since: v0.9.2) */
- VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown (Since: v0.9.2) */
- VIR_DOMAIN_SHUTOFF_DESTROYED = 2, /* forced poweroff (Since: v0.9.2) */
- VIR_DOMAIN_SHUTOFF_CRASHED = 3, /* domain crashed (Since: v0.9.2) */
- VIR_DOMAIN_SHUTOFF_MIGRATED = 4, /* migrated to another host (Since: v0.9.2) */
- VIR_DOMAIN_SHUTOFF_SAVED = 5, /* saved to a file (Since: v0.9.2) */
- VIR_DOMAIN_SHUTOFF_FAILED = 6, /* domain failed to start (Since: v0.9.2) */
+ VIR_DOMAIN_SHUTOFF_UNKNOWN = 0, /* the reason is unknown (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTOFF_SHUTDOWN = 1, /* normal shutdown (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTOFF_DESTROYED = 2, /* forced poweroff (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTOFF_CRASHED = 3, /* domain crashed (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTOFF_MIGRATED = 4, /* migrated to another host (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTOFF_SAVED = 5, /* saved to a file (Since: 0.9.2) */
+ VIR_DOMAIN_SHUTOFF_FAILED = 6, /* domain failed to start (Since: 0.9.2) */
VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT = 7, /* restored from a snapshot which was
- * taken while domain was shutoff (Since: v0.9.2) */
+ * taken while domain was shutoff (Since: 0.9.2) */
VIR_DOMAIN_SHUTOFF_DAEMON = 8, /* daemon decides to kill domain
- during reconnection processing (Since: v4.10.0) */
+ during reconnection processing (Since: 4.10.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_SHUTOFF_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_SHUTOFF_LAST /* (Since: 0.9.10) */
# endif
} virDomainShutoffReason;
/**
* virDomainCrashedReason:
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason (Since: v0.9.2) */
- VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked (Since: v1.1.1) */
+ VIR_DOMAIN_CRASHED_UNKNOWN = 0, /* crashed for unknown reason (Since: 0.9.2) */
+ VIR_DOMAIN_CRASHED_PANICKED = 1, /* domain panicked (Since: 1.1.1) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_CRASHED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_CRASHED_LAST /* (Since: 0.9.10) */
# endif
} virDomainCrashedReason;
/**
* virDomainPMSuspendedReason:
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef enum {
- VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, /* (Since: v0.9.11) */
+ VIR_DOMAIN_PMSUSPENDED_UNKNOWN = 0, /* (Since: 0.9.11) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_PMSUSPENDED_LAST /* (Since: v0.9.11) */
+ VIR_DOMAIN_PMSUSPENDED_LAST /* (Since: 0.9.11) */
# endif
} virDomainPMSuspendedReason;
/**
* virDomainPMSuspendedDiskReason:
*
- * Since: v1.0.0
+ * Since: 1.0.0
*/
typedef enum {
- VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, /* (Since: v1.0.0) */
+ VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN = 0, /* (Since: 1.0.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_PMSUSPENDED_DISK_LAST /* (Since: v1.0.0) */
+ VIR_DOMAIN_PMSUSPENDED_DISK_LAST /* (Since: 1.0.0) */
# endif
} virDomainPMSuspendedDiskReason;
*
* Current state of a control interface to the domain.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef enum {
- VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands (Since: v0.9.3) */
+ VIR_DOMAIN_CONTROL_OK = 0, /* operational, ready to accept commands (Since: 0.9.3) */
VIR_DOMAIN_CONTROL_JOB = 1, /* background job is running (can be
monitored by virDomainGetJobInfo); only
- limited set of commands may be allowed (Since: v0.9.3) */
- VIR_DOMAIN_CONTROL_OCCUPIED = 2, /* occupied by a running command (Since: v0.9.3) */
+ limited set of commands may be allowed (Since: 0.9.3) */
+ VIR_DOMAIN_CONTROL_OCCUPIED = 2, /* occupied by a running command (Since: 0.9.3) */
VIR_DOMAIN_CONTROL_ERROR = 3, /* unusable, domain cannot be fully
operated, possible reason is provided
- in the details field (Since: v0.9.3) */
+ in the details field (Since: 0.9.3) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_CONTROL_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_CONTROL_LAST /* (Since: 0.9.10) */
# endif
} virDomainControlState;
*
* Reason for the error state.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef enum {
VIR_DOMAIN_CONTROL_ERROR_REASON_NONE = 0, /* server didn't provide a
- reason (Since: v1.2.14) */
+ reason (Since: 1.2.14) */
VIR_DOMAIN_CONTROL_ERROR_REASON_UNKNOWN = 1, /* unknown reason for the
- error (Since: v1.2.14) */
+ error (Since: 1.2.14) */
VIR_DOMAIN_CONTROL_ERROR_REASON_MONITOR = 2, /* monitor connection is
- broken (Since: v1.2.14) */
+ broken (Since: 1.2.14) */
VIR_DOMAIN_CONTROL_ERROR_REASON_INTERNAL = 3, /* error caused due to
- internal failure in libvirt (Since: v1.2.14)
+ internal failure in libvirt (Since: 1.2.14)
*/
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_CONTROL_ERROR_REASON_LAST /* (Since: v1.2.14) */
+ VIR_DOMAIN_CONTROL_ERROR_REASON_LAST /* (Since: 1.2.14) */
# endif
} virDomainControlErrorReason;
* Structure filled in by virDomainGetControlInfo and providing details about
* current state of control interface to a domain.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef struct _virDomainControlInfo virDomainControlInfo;
struct _virDomainControlInfo {
*
* Pointer to virDomainControlInfo structure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef virDomainControlInfo *virDomainControlInfoPtr;
*
* These enums should not conflict with those of virTypedParameterFlags.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
typedef enum {
- VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. (Since: v0.9.2) */
- VIR_DOMAIN_AFFECT_LIVE = 1 << 0, /* Affect running domain state. (Since: v0.9.2) */
- VIR_DOMAIN_AFFECT_CONFIG = 1 << 1, /* Affect persistent domain state. (Since: v0.9.2) */
+ VIR_DOMAIN_AFFECT_CURRENT = 0, /* Affect current domain state. (Since: 0.9.2) */
+ VIR_DOMAIN_AFFECT_LIVE = 1 << 0, /* Affect running domain state. (Since: 0.9.2) */
+ VIR_DOMAIN_AFFECT_CONFIG = 1 << 1, /* Affect persistent domain state. (Since: 0.9.2) */
/* 1 << 2 is reserved for virTypedParameterFlags */
} virDomainModificationImpact;
* a virDomainInfo is a structure filled by virDomainGetInfo() and extracting
* runtime information for a given active Domain
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
typedef struct _virDomainInfo virDomainInfo;
*
* a virDomainInfoPtr is a pointer to a virDomainInfo structure.
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
typedef virDomainInfo *virDomainInfoPtr;
* Flags OR'ed together to provide specific behaviour when creating a
* Domain.
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
typedef enum {
- VIR_DOMAIN_NONE = 0, /* Default behavior (Since: v0.0.1) */
- VIR_DOMAIN_START_PAUSED = 1 << 0, /* Launch guest in paused state (Since: v0.8.2) */
- VIR_DOMAIN_START_AUTODESTROY = 1 << 1, /* Automatically kill guest when virConnectPtr is closed (Since: v0.9.3) */
- VIR_DOMAIN_START_BYPASS_CACHE = 1 << 2, /* Avoid file system cache pollution (Since: v0.9.4) */
- VIR_DOMAIN_START_FORCE_BOOT = 1 << 3, /* Boot, discarding any managed save (Since: v0.9.5) */
- VIR_DOMAIN_START_VALIDATE = 1 << 4, /* Validate the XML document against schema (Since: v1.2.12) */
- VIR_DOMAIN_START_RESET_NVRAM = 1 << 5, /* Re-initialize NVRAM from template (Since: v8.1.0) */
+ VIR_DOMAIN_NONE = 0, /* Default behavior (Since: 0.0.1) */
+ VIR_DOMAIN_START_PAUSED = 1 << 0, /* Launch guest in paused state (Since: 0.8.2) */
+ VIR_DOMAIN_START_AUTODESTROY = 1 << 1, /* Automatically kill guest when virConnectPtr is closed (Since: 0.9.3) */
+ VIR_DOMAIN_START_BYPASS_CACHE = 1 << 2, /* Avoid file system cache pollution (Since: 0.9.4) */
+ VIR_DOMAIN_START_FORCE_BOOT = 1 << 3, /* Boot, discarding any managed save (Since: 0.9.5) */
+ VIR_DOMAIN_START_VALIDATE = 1 << 4, /* Validate the XML document against schema (Since: 1.2.12) */
+ VIR_DOMAIN_START_RESET_NVRAM = 1 << 5, /* Re-initialize NVRAM from template (Since: 8.1.0) */
} virDomainCreateFlags;
* Macro represents proportional weight of the scheduler used on the
* host cpu, when using the posix scheduler, as a ullong.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_CPU_SHARES "cpu_shares"
* Macro represents the enforcement period for a quota, in microseconds,
* for whole domain, when using the posix scheduler, as a ullong.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
# define VIR_DOMAIN_SCHEDULER_GLOBAL_PERIOD "global_period"
* Macro represents the maximum bandwidth to be used within a period for
* whole domain, when using the posix scheduler, as an llong.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
# define VIR_DOMAIN_SCHEDULER_GLOBAL_QUOTA "global_quota"
* Macro represents the enforcement period for a quota, in microseconds,
* for vcpus only, when using the posix scheduler, as a ullong.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD "vcpu_period"
* Macro represents the maximum bandwidth to be used within a period for
* vcpus only, when using the posix scheduler, as an llong.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA "vcpu_quota"
* when using the posix scheduler, for all emulator activity not tied to
* vcpus, as a ullong.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
# define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD "emulator_period"
* all emulator activity not tied to vcpus, when using the posix scheduler,
* as an llong.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
# define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA "emulator_quota"
* Macro represents the enforcement period for a quota, in microseconds,
* for IOThreads only, when using the posix scheduler, as a ullong.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
# define VIR_DOMAIN_SCHEDULER_IOTHREAD_PERIOD "iothread_period"
* Macro represents the maximum bandwidth to be used within a period for
* IOThreads only, when using the posix scheduler, as an llong.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
# define VIR_DOMAIN_SCHEDULER_IOTHREAD_QUOTA "iothread_quota"
* Macro represents the relative weight, when using the credit
* scheduler, as a uint.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_WEIGHT "weight"
* Macro represents the maximum scheduler cap, when using the credit
* scheduler, as a uint.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_CAP "cap"
* Macro represents the scheduler reservation value, when using the
* allocation scheduler, as an llong.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_RESERVATION "reservation"
* Macro represents the scheduler limit value, when using the
* allocation scheduler, as an llong.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_LIMIT "limit"
* Macro represents the scheduler shares value, when using the
* allocation scheduler, as an int.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# define VIR_DOMAIN_SCHEDULER_SHARES "shares"
*
* NB. Here 'long long' means 64 bit integer.
*
- * Since: v0.3.3
+ * Since: 0.3.3
*/
typedef struct _virDomainBlockStats virDomainBlockStatsStruct;
*
* A pointer to a virDomainBlockStats structure
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
typedef virDomainBlockStatsStruct *virDomainBlockStatsPtr;
* Macro providing the field length of parameter names when using
* virDomainBlockStatsFlags().
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
* Macro represents the total number of read bytes of the
* block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_READ_BYTES "rd_bytes"
* Macro represents the total read requests of the
* block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_READ_REQ "rd_operations"
* Macro represents the total time spend on cache reads in
* nano-seconds of the block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES "rd_total_times"
* Macro represents the total number of write bytes of the
* block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES "wr_bytes"
* Macro represents the total write requests of the
* block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ "wr_operations"
* Macro represents the total time spend on cache writes in
* nano-seconds of the block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES "wr_total_times"
* Macro represents the total flush requests of the
* block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ "flush_operations"
* Macro represents the total time spend on cache flushing in
* nano-seconds of the block device, as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES "flush_total_times"
*
* In Xen this returns the mysterious 'oo_req', as an llong.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_DOMAIN_BLOCK_STATS_ERRS "errs"
*
* NB. Here 'long long' means 64 bit integer.
*
- * Since: v0.3.3
+ * Since: 0.3.3
*/
typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct;
*
* A pointer to a virDomainInterfaceStats structure
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
typedef virDomainInterfaceStatsStruct *virDomainInterfaceStatsPtr;
*
* Memory Statistics Tags:
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
typedef enum {
- /* The total amount of data read from swap space (in kB). (Since: v0.7.5) */
+ /* The total amount of data read from swap space (in kB). (Since: 0.7.5) */
VIR_DOMAIN_MEMORY_STAT_SWAP_IN = 0,
- /* The total amount of memory written out to swap space (in kB). (Since: v0.7.5) */
+ /* The total amount of memory written out to swap space (in kB). (Since: 0.7.5) */
VIR_DOMAIN_MEMORY_STAT_SWAP_OUT = 1,
/*
* 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.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT = 2,
/*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT = 3,
* is available but used for reclaimable caches should NOT be reported as
* free. This value is expressed in kB.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
VIR_DOMAIN_MEMORY_STAT_UNUSED = 4,
* balloon driver is in use or if the guest OS does not initialize all
* assigned pages. This value is expressed in kB.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
VIR_DOMAIN_MEMORY_STAT_AVAILABLE = 5,
/*
* Current balloon value (in KB).
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON = 6,
/* Resident Set Size of the process running the domain. This value
* is in kB
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
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
*
- * Since: v2.1.0
+ * Since: 2.1.0
*/
VIR_DOMAIN_MEMORY_STAT_USABLE = 8,
/*
* Timestamp of the last update of statistics, in seconds.
*
- * Since: v2.1.0
+ * Since: 2.1.0
*/
VIR_DOMAIN_MEMORY_STAT_LAST_UPDATE = 9,
* additional I/O (in kB). Typically these pages are used for caching files
* from disk.
*
- * Since: v4.6.0
+ * Since: 4.6.0
*/
VIR_DOMAIN_MEMORY_STAT_DISK_CACHES = 10,
* The number of successful huge page allocations from inside the domain via
* virtio balloon.
*
- * Since: v5.4.0
+ * Since: 5.4.0
*/
VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGALLOC = 11,
* The number of failed huge page allocations from inside the domain via
* virtio balloon.
*
- * Since: v5.4.0
+ * Since: 5.4.0
*/
VIR_DOMAIN_MEMORY_STAT_HUGETLB_PGFAIL = 12,
* The number of statistics supported by this version of the interface.
* To add new statistics, add them to the enum and increase this value.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
VIR_DOMAIN_MEMORY_STAT_NR = 13,
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR /* (Since: v0.9.10) */
+ VIR_DOMAIN_MEMORY_STAT_LAST = VIR_DOMAIN_MEMORY_STAT_NR /* (Since: 0.9.10) */
# endif
} virDomainMemoryStatTags;
/**
* virDomainMemoryStatStruct:
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
typedef struct _virDomainMemoryStat virDomainMemoryStatStruct;
/**
* virDomainMemoryStatPtr:
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr;
*
* Domain core dump flags.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
typedef enum {
- VIR_DUMP_CRASH = (1 << 0), /* crash after dump (Since: v0.7.5) */
- VIR_DUMP_LIVE = (1 << 1), /* live dump (Since: v0.7.5) */
- VIR_DUMP_BYPASS_CACHE = (1 << 2), /* avoid file system cache pollution (Since: v0.9.4) */
- VIR_DUMP_RESET = (1 << 3), /* reset domain after dump finishes (Since: v0.9.7) */
- VIR_DUMP_MEMORY_ONLY = (1 << 4), /* use dump-guest-memory (Since: v0.9.13) */
+ VIR_DUMP_CRASH = (1 << 0), /* crash after dump (Since: 0.7.5) */
+ VIR_DUMP_LIVE = (1 << 1), /* live dump (Since: 0.7.5) */
+ VIR_DUMP_BYPASS_CACHE = (1 << 2), /* avoid file system cache pollution (Since: 0.9.4) */
+ VIR_DUMP_RESET = (1 << 3), /* reset domain after dump finishes (Since: 0.9.7) */
+ VIR_DUMP_MEMORY_ONLY = (1 << 4), /* use dump-guest-memory (Since: 0.9.13) */
} virDomainCoreDumpFlags;
/**
*
* Values for specifying different formats of domain core dumps.
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
typedef enum {
- VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format (Since: v1.2.3) */
+ VIR_DOMAIN_CORE_DUMP_FORMAT_RAW, /* dump guest memory in raw format (Since: 1.2.3) */
VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_ZLIB, /* kdump-compressed format, with
- * zlib compression (Since: v1.2.3) */
+ * zlib compression (Since: 1.2.3) */
VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_LZO, /* kdump-compressed format, with
- * lzo compression (Since: v1.2.3) */
+ * lzo compression (Since: 1.2.3) */
VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_SNAPPY, /* kdump-compressed format, with
- * snappy compression (Since: v1.2.3) */
- VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump format (Since: v7.4.0) */
+ * snappy compression (Since: 1.2.3) */
+ VIR_DOMAIN_CORE_DUMP_FORMAT_WIN_DMP, /* Windows full crashdump format (Since: 7.4.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_DOMAIN_CORE_DUMP_FORMAT_LAST
/*
* added to the libvirt API. It reflects the last format supported
* by this version of the libvirt API.
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
# endif
} virDomainCoreDumpFormat;
*
* Domain migration flags.
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
typedef enum {
/* Do not pause the domain during migration. The domain's memory will
* faster then it can be transferred. The domain can be manually paused
* anytime during migration using virDomainSuspend.
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
VIR_MIGRATE_LIVE = (1 << 0),
* libvirtd controls the migration by calling the destination daemon
* directly.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
VIR_MIGRATE_PEER2PEER = (1 << 1),
* Note the less-common spelling that we're stuck with:
* VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
VIR_MIGRATE_TUNNELLED = (1 << 2),
* VIR_MIGRATE_UNDEFINE_SOURCE is not used, it will end up persistent on
* both hosts.
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
VIR_MIGRATE_PERSIST_DEST = (1 << 3),
/* Undefine the domain on the source host once migration successfully
* finishes.
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
VIR_MIGRATE_UNDEFINE_SOURCE = (1 << 4),
* the virDomainPtr returned by the migration API) has to be called
* explicitly to resume domain's virtual CPUs.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
VIR_MIGRATE_PAUSED = (1 << 5),
*
* This flag and VIR_MIGRATE_NON_SHARED_INC are mutually exclusive.
*
- * Since: v0.8.2
+ * Since: 0.8.2
*/
VIR_MIGRATE_NON_SHARED_DISK = (1 << 6),
*
* This flag and VIR_MIGRATE_NON_SHARED_DISK are mutually exclusive.
*
- * Since: v0.8.2
+ * Since: 0.8.2
*/
VIR_MIGRATE_NON_SHARED_INC = (1 << 7),
* Explicitly setting this flag will cause migration to fail if either the
* source or the destination does not support it.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
VIR_MIGRATE_CHANGE_PROTECTION = (1 << 8),
* is unsafe unless the disk images are stored on coherent clustered
* filesystem, such as GFS2 or GPFS.
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
VIR_MIGRATE_UNSAFE = (1 << 9),
* Offline migration may not copy disk storage or any other file based
* storage (such as UEFI variables).
*
- * Since: v1.0.1
+ * Since: 1.0.1
*/
VIR_MIGRATE_OFFLINE = (1 << 10),
* if this parameter is omitted. Individual compression methods can be
* tuned via their specific VIR_MIGRATE_PARAM_COMPRESSION_* parameters.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
VIR_MIGRATE_COMPRESSED = (1 << 11),
/* Cancel migration if a soft error (such as I/O error) happens during
* migration.
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
VIR_MIGRATE_ABORT_ON_ERROR = (1 << 12),
* memory to the destination host. VIR_MIGRATE_PARAM_AUTO_CONVERGE_*
* parameters can be used to tune the algorithm.
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
VIR_MIGRATE_AUTO_CONVERGE = (1 << 13),
* domain and the host itself since the host's kernel may run out of
* memory.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
VIR_MIGRATE_RDMA_PIN_ALL = (1 << 14),
* virDomainMigrateStartPostCopy needs to be called to switch it into the
* post-copy mode. See virDomainMigrateStartPostCopy for more details.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
VIR_MIGRATE_POSTCOPY = (1 << 15),
* perform the migration. If incorrectly configured on either source or
* destination, the migration will fail.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
VIR_MIGRATE_TLS = (1 << 16),
* connections. See VIR_MIGRATE_PARAM_PARALLEL_* parameters for
* configuring the parallel migration.
*
- * Since: v5.2.0
+ * Since: 5.2.0
*/
VIR_MIGRATE_PARALLEL = (1 << 17),
* Requires one of VIR_MIGRATE_NON_SHARED_DISK, VIR_MIGRATE_NON_SHARED_INC
* to be present as well.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
VIR_MIGRATE_NON_SHARED_SYNCHRONOUS_WRITES = (1 << 18),
*
* This field may not be used when VIR_MIGRATE_TUNNELLED flag is set.
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
# define VIR_MIGRATE_PARAM_URI "migrate_uri"
* the domain name the same. This field is only allowed to be used with
* hypervisors that support domain renaming during migration.
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
# define VIR_MIGRATE_PARAM_DEST_NAME "destination_name"
* field with hypervisors that do not support changing domain configuration
* during migration will result in a failure.
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
# define VIR_MIGRATE_PARAM_DEST_XML "destination_xml"
* Using this field with hypervisors that do not support changing domain
* configuration during migration will result in a failure.
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
# define VIR_MIGRATE_PARAM_PERSIST_XML "persistent_xml"
* 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.
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
# define VIR_MIGRATE_PARAM_BANDWIDTH "bandwidth"
* be used for post-copy phase of a migration as VIR_TYPED_PARAM_ULLONG. If set
* to 0 or omitted, post-copy migration speed will not be limited.
*
- * Since: v5.1.0
+ * Since: 5.1.0
*/
# define VIR_MIGRATE_PARAM_BANDWIDTH_POSTCOPY "bandwidth.postcopy"
*
* spice://target.host.com:1234/?tlsPort=4567
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
# define VIR_MIGRATE_PARAM_GRAPHICS_URI "graphics_uri"
* destination). Some hypervisors do not support this feature and will return
* an error if this field is used.
*
- * Since: v1.1.4
+ * Since: 1.1.4
*/
# define VIR_MIGRATE_PARAM_LISTEN_ADDRESS "listen_address"
* the block devices to be migrated. At the moment this is only supported
* by the QEMU driver but not for the tunnelled migration.
*
- * Since: v1.2.17
+ * Since: 1.2.17
*/
# define VIR_MIGRATE_PARAM_MIGRATE_DISKS "migrate_disks"
* omitted, libvirt will choose a suitable default. At the moment this is only
* supported by the QEMU driver.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
# define VIR_MIGRATE_PARAM_DISKS_PORT "disks_port"
* management application makes sure that socket created with this name on the
* destination will be reachable from the source under the same exact path.
*
- * Since: v6.8.0
+ * Since: 6.8.0
*/
# define VIR_MIGRATE_PARAM_DISKS_URI "disks_uri"
* The parameter may be specified multiple times if more than one method
* should be used.
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION "compression"
* 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.
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_MT_LEVEL "compression.mt.level"
* virDomainMigrate* params field: the number of compression threads for
* multithread compression as VIR_TYPED_PARAM_INT.
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_MT_THREADS "compression.mt.threads"
* virDomainMigrate* params field: the number of decompression threads for
* multithread compression as VIR_TYPED_PARAM_INT.
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_MT_DTHREADS "compression.mt.dthreads"
* virDomainMigrate* params field: the size of page cache for xbzrle
* compression as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
# define VIR_MIGRATE_PARAM_COMPRESSION_XBZRLE_CACHE "compression.xbzrle.cache"
* throttled to when auto-convergence decides migration is not converging.
* As VIR_TYPED_PARAM_INT.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INITIAL "auto_converge.initial"
* the current rate is not enough to ensure convergence of the migration.
* As VIR_TYPED_PARAM_INT.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_MIGRATE_PARAM_AUTO_CONVERGE_INCREMENT "auto_converge.increment"
* virDomainMigrate* params field: number of connections used during parallel
* migration. As VIR_TYPED_PARAM_INT.
*
- * Since: v5.2.0
+ * Since: 5.2.0
*/
# define VIR_MIGRATE_PARAM_PARALLEL_CONNECTIONS "parallel.connections"
* this parameter can be used to pass this expected hostname when starting
* the migration.
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
# define VIR_MIGRATE_PARAM_TLS_DESTINATION "tls.destination"
*
* Domain migration speed flags.
*
- * Since: v5.1.0
+ * Since: 5.1.0
*/
typedef enum {
- /* Set or get maximum speed of post-copy migration. (Since: v5.1.0) */
+ /* Set or get maximum speed of post-copy migration. (Since: 5.1.0) */
VIR_DOMAIN_MIGRATE_MAX_SPEED_POSTCOPY = (1 << 0),
} virDomainMigrateMaxSpeedFlags;
/**
* virDomainShutdownFlagValues:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice (Since: v0.9.10) */
- VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v0.9.10) */
- VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: v0.9.10) */
- VIR_DOMAIN_SHUTDOWN_INITCTL = (1 << 2), /* Use initctl (Since: v1.0.1) */
- VIR_DOMAIN_SHUTDOWN_SIGNAL = (1 << 3), /* Send a signal (Since: v1.0.1) */
- VIR_DOMAIN_SHUTDOWN_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: v1.2.5) */
+ VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice (Since: 0.9.10) */
+ VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: 0.9.10) */
+ VIR_DOMAIN_SHUTDOWN_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: 0.9.10) */
+ VIR_DOMAIN_SHUTDOWN_INITCTL = (1 << 2), /* Use initctl (Since: 1.0.1) */
+ VIR_DOMAIN_SHUTDOWN_SIGNAL = (1 << 3), /* Send a signal (Since: 1.0.1) */
+ VIR_DOMAIN_SHUTDOWN_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: 1.2.5) */
} virDomainShutdownFlagValues;
int virDomainShutdown (virDomainPtr domain);
/**
* virDomainRebootFlagValues:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice (Since: v0.9.10) */
- VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: v0.9.10) */
- VIR_DOMAIN_REBOOT_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: v0.9.10) */
- VIR_DOMAIN_REBOOT_INITCTL = (1 << 2), /* Use initctl (Since: v1.0.1) */
- VIR_DOMAIN_REBOOT_SIGNAL = (1 << 3), /* Send a signal (Since: v1.0.1) */
- VIR_DOMAIN_REBOOT_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: v1.2.5) */
+ VIR_DOMAIN_REBOOT_DEFAULT = 0, /* hypervisor choice (Since: 0.9.10) */
+ VIR_DOMAIN_REBOOT_ACPI_POWER_BTN = (1 << 0), /* Send ACPI event (Since: 0.9.10) */
+ VIR_DOMAIN_REBOOT_GUEST_AGENT = (1 << 1), /* Use guest agent (Since: 0.9.10) */
+ VIR_DOMAIN_REBOOT_INITCTL = (1 << 2), /* Use initctl (Since: 1.0.1) */
+ VIR_DOMAIN_REBOOT_SIGNAL = (1 << 3), /* Send a signal (Since: 1.0.1) */
+ VIR_DOMAIN_REBOOT_PARAVIRT = (1 << 4), /* Use paravirt guest control (Since: 1.2.5) */
} virDomainRebootFlagValues;
int virDomainReboot (virDomainPtr domain,
* Flags used to provide specific behaviour to the
* virDomainDestroyFlags() function
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef enum {
- VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! (Since: v0.9.10) */
- VIR_DOMAIN_DESTROY_GRACEFUL = 1 << 0, /* only SIGTERM, no SIGKILL (Since: v0.9.10) */
- VIR_DOMAIN_DESTROY_REMOVE_LOGS = 1 << 1, /* remove VM logs on destroy (Since: v8.3.0) */
+ VIR_DOMAIN_DESTROY_DEFAULT = 0, /* Default behavior - could lead to data loss!! (Since: 0.9.10) */
+ VIR_DOMAIN_DESTROY_GRACEFUL = 1 << 0, /* only SIGTERM, no SIGKILL (Since: 0.9.10) */
+ VIR_DOMAIN_DESTROY_REMOVE_LOGS = 1 << 1, /* remove VM logs on destroy (Since: 8.3.0) */
} virDomainDestroyFlagsValues;
int virDomainDestroyFlags (virDomainPtr domain,
* virDomainRestoreFlags(), and virDomainSaveImageDefineXML(). Not all
* flags apply to all these functions.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef enum {
- VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution (Since: v0.9.4) */
- VIR_DOMAIN_SAVE_RUNNING = 1 << 1, /* Favor running over paused (Since: v0.9.5) */
- VIR_DOMAIN_SAVE_PAUSED = 1 << 2, /* Favor paused over running (Since: v0.9.5) */
- VIR_DOMAIN_SAVE_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */
+ VIR_DOMAIN_SAVE_BYPASS_CACHE = 1 << 0, /* Avoid file system cache pollution (Since: 0.9.4) */
+ VIR_DOMAIN_SAVE_RUNNING = 1 << 1, /* Favor running over paused (Since: 0.9.5) */
+ VIR_DOMAIN_SAVE_PAUSED = 1 << 2, /* Favor paused over running (Since: 0.9.5) */
+ VIR_DOMAIN_SAVE_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: 8.1.0) */
} virDomainSaveRestoreFlags;
int virDomainSave (virDomainPtr domain,
* cpu usage (sum of both vcpu and hypervisor usage) in nanoseconds,
* as a ullong
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
# define VIR_DOMAIN_CPU_STATS_CPUTIME "cpu_time"
* VIR_DOMAIN_CPU_STATS_USERTIME:
* cpu time charged to user instructions in nanoseconds, as a ullong
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
# define VIR_DOMAIN_CPU_STATS_USERTIME "user_time"
* VIR_DOMAIN_CPU_STATS_SYSTEMTIME:
* cpu time charged to system instructions in nanoseconds, as a ullong
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
# define VIR_DOMAIN_CPU_STATS_SYSTEMTIME "system_time"
* vcpu usage in nanoseconds (cpu_time excluding hypervisor time),
* as a ullong
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
# define VIR_DOMAIN_CPU_STATS_VCPUTIME "vcpu_time"
* Macro for the Blkio tunable weight: it represents the io weight
* the guest can use, as a uint.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
# define VIR_DOMAIN_BLKIO_WEIGHT "weight"
* per-device weight, as a string. The string is parsed as a
* series of /path/to/device,weight elements, separated by ','.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT "device_weight"
* string is parsed as a series of /path/to/device, read_iops elements,
* separated by ','.
*
- * Since: v1.2.2
+ * Since: 1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS "device_read_iops_sec"
* string is parsed as a series of /path/to/device, write_iops elements,
* separated by ','.
*
- * Since: v1.2.2
+ * Since: 1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS "device_write_iops_sec"
* string is parsed as a series of /path/to/device, read_bps elements,
* separated by ','.
*
- * Since: v1.2.2
+ * Since: 1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS "device_read_bytes_sec"
* string is parsed as a series of /path/to/device, write_bps elements,
* separated by ','.
*
- * Since: v1.2.2
+ * Since: 1.2.2
*/
# define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS "device_write_bytes_sec"
*
* Macro providing the virMemoryParameter value that indicates "unlimited"
*
- * Since: v0.8.8
+ * Since: 0.8.8
*/
# define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED 9007199254740991LL /* = INT64_MAX >> 10 */
* Macro for the memory tunable hard_limit: it represents the maximum memory
* the guest can use, as a ullong.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
# define VIR_DOMAIN_MEMORY_HARD_LIMIT "hard_limit"
* Macro for the memory tunable soft_limit: it represents the memory upper
* limit enforced during memory contention, as a ullong.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
# define VIR_DOMAIN_MEMORY_SOFT_LIMIT "soft_limit"
* Macro for the memory tunable min_guarantee: it represents the minimum
* memory guaranteed to be reserved for the guest, as a ullong.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
# define VIR_DOMAIN_MEMORY_MIN_GUARANTEE "min_guarantee"
* plus memory the guest can use, as a ullong. This limit has to be more than
* VIR_DOMAIN_MEMORY_HARD_LIMIT.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
# define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT "swap_hard_limit"
*
* Memory size modification flags.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
typedef enum {
- VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.1) */
- VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.9.0) */
- VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.9.0) */
+ VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: 0.9.1) */
+ VIR_DOMAIN_MEM_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: 0.9.0) */
+ VIR_DOMAIN_MEM_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: 0.9.0) */
- VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current (Since: v0.9.1) */
+ VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current (Since: 0.9.1) */
} virDomainMemoryModFlags;
* Representation of the various modes in the <numatune> element of
* a domain.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
typedef enum {
- VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, /* (Since: v0.9.9) */
- VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1, /* (Since: v0.9.9) */
- VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2, /* (Since: v0.9.9) */
- VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE = 3, /* (Since: v7.3.0) */
+ VIR_DOMAIN_NUMATUNE_MEM_STRICT = 0, /* (Since: 0.9.9) */
+ VIR_DOMAIN_NUMATUNE_MEM_PREFERRED = 1, /* (Since: 0.9.9) */
+ VIR_DOMAIN_NUMATUNE_MEM_INTERLEAVE = 2, /* (Since: 0.9.9) */
+ VIR_DOMAIN_NUMATUNE_MEM_RESTRICTIVE = 3, /* (Since: 7.3.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_NUMATUNE_MEM_LAST /* This constant is subject to change (Since: v0.9.9) */
+ VIR_DOMAIN_NUMATUNE_MEM_LAST /* This constant is subject to change (Since: 0.9.9) */
# endif
} virDomainNumatuneMemMode;
* Macro for typed parameter name that lists the numa nodeset of a
* domain, as a string.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_NUMA_NODESET "numa_nodeset"
* Macro for typed parameter name that lists the numa mode of a domain,
* as an int containing a virDomainNumatuneMemMode value.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_NUMA_MODE "numa_mode"
/**
* virDomainGetHostnameFlags:
*
- * Since: v6.1.0
+ * Since: 6.1.0
*/
typedef enum {
- VIR_DOMAIN_GET_HOSTNAME_LEASE = (1 << 0), /* Parse DHCP lease file (Since: v6.1.0) */
- VIR_DOMAIN_GET_HOSTNAME_AGENT = (1 << 1), /* Query qemu guest agent (Since: v6.1.0) */
+ VIR_DOMAIN_GET_HOSTNAME_LEASE = (1 << 0), /* Parse DHCP lease file (Since: 6.1.0) */
+ VIR_DOMAIN_GET_HOSTNAME_AGENT = (1 << 1), /* Query qemu guest agent (Since: 6.1.0) */
} virDomainGetHostnameFlags;
char * virDomainGetHostname (virDomainPtr domain,
/**
* virDomainMetadataType:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> (Since: v0.9.10) */
- VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> (Since: v0.9.10) */
- VIR_DOMAIN_METADATA_ELEMENT = 2, /* Operate on <metadata> (Since: v0.9.10) */
+ VIR_DOMAIN_METADATA_DESCRIPTION = 0, /* Operate on <description> (Since: 0.9.10) */
+ VIR_DOMAIN_METADATA_TITLE = 1, /* Operate on <title> (Since: 0.9.10) */
+ VIR_DOMAIN_METADATA_ELEMENT = 2, /* Operate on <metadata> (Since: 0.9.10) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_METADATA_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_METADATA_LAST /* (Since: 0.9.10) */
# endif
} virDomainMetadataType;
*
* Flags available for virDomainGetXMLDesc
*
- * Since: v0.3.3
+ * Since: 0.3.3
*/
typedef enum {
- VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too (Since: v0.3.3) */
- VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information (Since: v0.3.3) */
- VIR_DOMAIN_XML_UPDATE_CPU = (1 << 2), /* update guest CPU requirements according to host CPU (Since: v0.8.0) */
- VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration (Since: v1.0.0) */
+ VIR_DOMAIN_XML_SECURE = (1 << 0), /* dump security sensitive information too (Since: 0.3.3) */
+ VIR_DOMAIN_XML_INACTIVE = (1 << 1), /* dump inactive domain information (Since: 0.3.3) */
+ VIR_DOMAIN_XML_UPDATE_CPU = (1 << 2), /* update guest CPU requirements according to host CPU (Since: 0.8.0) */
+ VIR_DOMAIN_XML_MIGRATABLE = (1 << 3), /* dump XML suitable for migration (Since: 1.0.0) */
} virDomainXMLFlags;
/**
* virDomainSaveImageXMLFlags:
*
- * Since: v5.1.0
+ * Since: 5.1.0
*/
typedef enum {
- VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */
+ VIR_DOMAIN_SAVE_IMAGE_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: 5.1.0) */
} virDomainSaveImageXMLFlags;
char * virDomainGetXMLDesc (virDomainPtr domain,
*
* Macro represents the inbound average of NIC bandwidth, as a uint.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE "inbound.average"
*
* Macro represents the inbound peak of NIC bandwidth, as a uint.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_IN_PEAK "inbound.peak"
*
* Macro represents the inbound burst of NIC bandwidth, as a uint.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_IN_BURST "inbound.burst"
*
* Macro represents the inbound floor of NIC bandwidth, as a uint.
*
- * Since: v1.2.19
+ * Since: 1.2.19
*/
# define VIR_DOMAIN_BANDWIDTH_IN_FLOOR "inbound.floor"
*
* Macro represents the outbound average of NIC bandwidth, as a uint.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE "outbound.average"
*
* Macro represents the outbound peak of NIC bandwidth, as a uint.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_OUT_PEAK "outbound.peak"
*
* Macro represents the outbound burst of NIC bandwidth, as a uint.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
# define VIR_DOMAIN_BANDWIDTH_OUT_BURST "outbound.burst"
*
* Flags available for virDomainBlockResize().
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef enum {
- VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB (Since: v0.9.11) */
+ VIR_DOMAIN_BLOCK_RESIZE_BYTES = 1 << 0, /* size in bytes instead of KiB (Since: 0.9.11) */
} virDomainBlockResizeFlags;
int virDomainBlockResize (virDomainPtr dom,
* * allocation: highest qcow extent written for an active domain
* * physical: size of the block device container
*
- * Since: v0.8.1
+ * Since: 0.8.1
*/
typedef struct _virDomainBlockInfo virDomainBlockInfo;
/**
* virDomainBlockInfoPtr:
*
- * Since: v0.8.1
+ * Since: 0.8.1
*/
typedef virDomainBlockInfo *virDomainBlockInfoPtr;
struct _virDomainBlockInfo {
*
* Memory peeking flags.
*
- * Since: v0.4.4
+ * Since: 0.4.4
*/
typedef enum {
- VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses (Since: v0.4.4) */
- VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses (Since: v0.7.0) */
+ VIR_MEMORY_VIRTUAL = 1 << 0, /* addresses are virtual addresses (Since: 0.4.4) */
+ VIR_MEMORY_PHYSICAL = 1 << 1, /* addresses are physical addresses (Since: 0.7.0) */
} virDomainMemoryFlags;
int virDomainMemoryPeek (virDomainPtr dom,
/**
* virDomainDefineFlags:
*
- * Since: v1.2.12
+ * Since: 1.2.12
*/
typedef enum {
- VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema (Since: v1.2.12) */
+ VIR_DOMAIN_DEFINE_VALIDATE = (1 << 0), /* Validate the XML document against schema (Since: 1.2.12) */
} virDomainDefineFlags;
/*
/**
* virDomainUndefineFlagsValues:
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef enum {
VIR_DOMAIN_UNDEFINE_MANAGED_SAVE = (1 << 0), /* Also remove any
- managed save (Since: v0.9.4) */
+ managed save (Since: 0.9.4) */
VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA = (1 << 1), /* If last use of domain,
then also remove any
- snapshot metadata (Since: v0.9.5) */
+ snapshot metadata (Since: 0.9.5) */
VIR_DOMAIN_UNDEFINE_NVRAM = (1 << 2), /* Also remove any
- nvram file (Since: v1.2.9) */
- VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = (1 << 3), /* Keep nvram file (Since: v2.3.0) */
+ nvram file (Since: 1.2.9) */
+ VIR_DOMAIN_UNDEFINE_KEEP_NVRAM = (1 << 3), /* Keep nvram file (Since: 2.3.0) */
VIR_DOMAIN_UNDEFINE_CHECKPOINTS_METADATA = (1 << 4), /* If last use of domain,
then also remove any
- checkpoint metadata (Since: v5.6.0) */
+ checkpoint metadata (Since: 5.6.0) */
} virDomainUndefineFlagsValues;
* 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
+ * Since: 0.9.13
*/
typedef enum {
- VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_INACTIVE = 1 << 1, /* (Since: v0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1 << 0, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_INACTIVE = 1 << 1, /* (Since: 0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 1 << 2, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 1 << 3, /* (Since: v0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 1 << 2, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 1 << 3, /* (Since: 0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_RUNNING = 1 << 4, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_PAUSED = 1 << 5, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 1 << 6, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_OTHER = 1 << 7, /* (Since: v0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_RUNNING = 1 << 4, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_PAUSED = 1 << 5, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 1 << 6, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_OTHER = 1 << 7, /* (Since: 0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 1 << 8, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 1 << 9, /* (Since: v0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 1 << 8, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 1 << 9, /* (Since: 0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1 << 10, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 1 << 11, /* (Since: v0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1 << 10, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 1 << 11, /* (Since: 0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 1 << 12, /* (Since: v0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 1 << 13, /* (Since: v0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 1 << 12, /* (Since: 0.9.13) */
+ VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 1 << 13, /* (Since: 0.9.13) */
- VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT = 1 << 14, /* (Since: v5.6.0) */
- VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT = 1 << 15, /* (Since: v5.6.0) */
+ VIR_CONNECT_LIST_DOMAINS_HAS_CHECKPOINT = 1 << 14, /* (Since: 5.6.0) */
+ VIR_CONNECT_LIST_DOMAINS_NO_CHECKPOINT = 1 << 15, /* (Since: 5.6.0) */
} virConnectListAllDomainsFlags;
int virConnectListAllDomains (virConnectPtr conn,
*
* structure for information about a virtual CPU in a domain.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
typedef enum {
- VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline (Since: v0.1.4) */
- VIR_VCPU_RUNNING = 1, /* the virtual CPU is running (Since: v0.1.4) */
- VIR_VCPU_BLOCKED = 2, /* the virtual CPU is blocked on resource (Since: v0.1.4) */
+ VIR_VCPU_OFFLINE = 0, /* the virtual CPU is offline (Since: 0.1.4) */
+ VIR_VCPU_RUNNING = 1, /* the virtual CPU is running (Since: 0.1.4) */
+ VIR_VCPU_BLOCKED = 2, /* the virtual CPU is blocked on resource (Since: 0.1.4) */
# ifdef VIR_ENUM_SENTINELS
- VIR_VCPU_LAST /* (Since: v0.9.10) */
+ VIR_VCPU_LAST /* (Since: 0.9.10) */
# endif
} virVcpuState;
/**
* virVcpuHostCpuState:
*
- * Since: v6.10.0
+ * Since: 6.10.0
*/
typedef enum {
- VIR_VCPU_INFO_CPU_OFFLINE = -1, /* the vCPU is offline (Since: v6.10.0) */
- VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU information (Since: v6.10.0) */
+ VIR_VCPU_INFO_CPU_OFFLINE = -1, /* the vCPU is offline (Since: 6.10.0) */
+ VIR_VCPU_INFO_CPU_UNAVAILABLE = -2, /* the hypervisor does not expose real CPU information (Since: 6.10.0) */
} virVcpuHostCpuState;
/**
* virVcpuInfo:
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
typedef struct _virVcpuInfo virVcpuInfo;
struct _virVcpuInfo {
/**
* virVcpuInfoPtr:
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
typedef virVcpuInfo *virVcpuInfoPtr;
*
* Flags for controlling virtual CPU hot-plugging.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
typedef enum {
- VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.4) */
- VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.8.5) */
- VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.8.5) */
+ VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: 0.9.4) */
+ VIR_DOMAIN_VCPU_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: 0.8.5) */
+ VIR_DOMAIN_VCPU_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: 0.8.5) */
- VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count (Since: v0.8.5) */
- VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest (Since: v1.1.0) */
- VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable (Since: v2.4.0) */
+ VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count (Since: 0.8.5) */
+ VIR_DOMAIN_VCPU_GUEST = (1 << 3), /* Modify state of the cpu in the guest (Since: 1.1.0) */
+ VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable (Since: 2.4.0) */
} virDomainVcpuFlags;
int virDomainSetVcpus (virDomainPtr domain,
*
* The data structure for information about all IOThreads in a domain
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo;
/**
* virDomainIOThreadInfoPtr:
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr;
struct _virDomainIOThreadInfo {
* small will not provide enough cycles for the guest to process data.
* The polling interval is not available for statistical purposes.
*
- * Since: v4.10.0
+ * Since: 4.10.0
*/
# define VIR_DOMAIN_IOTHREAD_POLL_MAX_NS "poll_max_ns"
* of 0 (zero) allows the hypervisor to choose its own value. The algorithm
* to use for adjustment is hypervisor specific.
*
- * Since: v4.10.0
+ * Since: 4.10.0
*/
# define VIR_DOMAIN_IOTHREAD_POLL_GROW "poll_grow"
* choose its own value. The algorithm to use for adjustment is hypervisor
* specific.
*
- * Since: v4.10.0
+ * Since: 4.10.0
*/
# define VIR_DOMAIN_IOTHREAD_POLL_SHRINK "poll_shrink"
* This macro is to be used in conjunction with virDomainPinVcpu() API.
* It sets the bit (CPU usable) of the related cpu in cpumap.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_USE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] |= (1 << ((cpu) % 8)))
* This macro is to be used in conjunction with virDomainPinVcpu() API.
* It resets the bit (CPU not usable) of the related cpu in cpumap.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_UNUSE_CPU(cpumap, cpu) ((cpumap)[(cpu) / 8] &= ~(1 << ((cpu) % 8)))
* This macro can be used in conjunction with virNodeGetCPUMap() API.
* It returns non-zero if the bit of the related CPU is set.
*
- * Since: v1.0.0
+ * Since: 1.0.0
*/
# define VIR_CPU_USED(cpumap, cpu) ((cpumap)[(cpu) / 8] & (1 << ((cpu) % 8)))
* It returns the length (in bytes) required to store the complete
* CPU map between a single virtual & all physical CPUs of a domain.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_CPU_MAPLEN(cpu) (((cpu) + 7) / 8)
* VIR_CPU_USABLE macro returns a non-zero value (true) if the cpu
* is usable by the vcpu, and 0 otherwise.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_CPU_USABLE(cpumaps, maplen, vcpu, cpu) \
VIR_CPU_USED(VIR_GET_CPUMAP(cpumaps, maplen, vcpu), cpu)
* the specified vcpu from cpumaps array and copies it into cpumap to be used
* later by virDomainPinVcpu() API.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_COPY_CPUMAP(cpumaps, maplen, vcpu, cpumap) \
memcpy(cpumap, VIR_GET_CPUMAP(cpumaps, maplen, vcpu), maplen)
* virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the
* cpumap of the specified vcpu from cpumaps array.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_GET_CPUMAP(cpumaps, maplen, vcpu) (&((cpumaps)[(vcpu) * (maplen)]))
/**
* virDomainDeviceModifyFlags:
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
typedef enum {
- VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.7.7) */
- VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.7.7) */
- VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.7.7) */
+ VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: 0.7.7) */
+ VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: 0.7.7) */
+ VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: 0.7.7) */
- VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device (ex. force eject a cdrom) (Since: v0.8.6) */
+ VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device (ex. force eject a cdrom) (Since: 0.8.6) */
} virDomainDeviceModifyFlags;
int virDomainAttachDevice(virDomainPtr domain, const char *xml);
/**
* virDomainStatsRecord:
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
typedef struct _virDomainStatsRecord virDomainStatsRecord;
/**
* virDomainStatsRecordPtr:
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
typedef virDomainStatsRecord *virDomainStatsRecordPtr;
struct _virDomainStatsRecord {
/**
* virDomainStatsTypes:
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
typedef enum {
- VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state (Since: v1.2.8) */
- VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info (Since: v1.2.9) */
- VIR_DOMAIN_STATS_BALLOON = (1 << 2), /* return domain balloon info (Since: v1.2.9) */
- VIR_DOMAIN_STATS_VCPU = (1 << 3), /* return domain virtual CPU info (Since: v1.2.9) */
- VIR_DOMAIN_STATS_INTERFACE = (1 << 4), /* return domain interfaces info (Since: v1.2.9) */
- VIR_DOMAIN_STATS_BLOCK = (1 << 5), /* return domain block info (Since: v1.2.9) */
- VIR_DOMAIN_STATS_PERF = (1 << 6), /* return domain perf event info (Since: v1.3.3) */
- VIR_DOMAIN_STATS_IOTHREAD = (1 << 7), /* return iothread poll info (Since: v4.10.0) */
- VIR_DOMAIN_STATS_MEMORY = (1 << 8), /* return domain memory info (Since: v6.0.0) */
- VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info (Since: v7.2.0) */
+ VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state (Since: 1.2.8) */
+ VIR_DOMAIN_STATS_CPU_TOTAL = (1 << 1), /* return domain CPU info (Since: 1.2.9) */
+ VIR_DOMAIN_STATS_BALLOON = (1 << 2), /* return domain balloon info (Since: 1.2.9) */
+ VIR_DOMAIN_STATS_VCPU = (1 << 3), /* return domain virtual CPU info (Since: 1.2.9) */
+ VIR_DOMAIN_STATS_INTERFACE = (1 << 4), /* return domain interfaces info (Since: 1.2.9) */
+ VIR_DOMAIN_STATS_BLOCK = (1 << 5), /* return domain block info (Since: 1.2.9) */
+ VIR_DOMAIN_STATS_PERF = (1 << 6), /* return domain perf event info (Since: 1.3.3) */
+ VIR_DOMAIN_STATS_IOTHREAD = (1 << 7), /* return iothread poll info (Since: 4.10.0) */
+ VIR_DOMAIN_STATS_MEMORY = (1 << 8), /* return domain memory info (Since: 6.0.0) */
+ VIR_DOMAIN_STATS_DIRTYRATE = (1 << 9), /* return domain dirty rate info (Since: 7.2.0) */
} virDomainStatsTypes;
/**
* virConnectGetAllDomainStatsFlags:
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
typedef enum {
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE, /* (Since: v1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE, /* (Since: v1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE, /* (Since: 1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE, /* (Since: 1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT, /* (Since: v1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT, /* (Since: v1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT, /* (Since: 1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT, /* (Since: 1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING, /* (Since: v1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED, /* (Since: v1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF, /* (Since: v1.2.8) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER, /* (Since: v1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING, /* (Since: 1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED, /* (Since: 1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF, /* (Since: 1.2.8) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER, /* (Since: 1.2.8) */
VIR_CONNECT_GET_ALL_DOMAINS_STATS_NOWAIT = 1 << 29, /* report statistics that can be obtained
- immediately without any blocking (Since: v4.5.0) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING = 1 << 30, /* include backing chain for block stats (Since: v1.2.12) */
- VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats (Since: v1.2.8) */
+ immediately without any blocking (Since: 4.5.0) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING = 1 << 30, /* include backing chain for block stats (Since: 1.2.12) */
+ VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats (Since: 1.2.8) */
} virConnectGetAllDomainStatsFlags;
int virConnectGetAllDomainStats(virConnectPtr conn,
* applications running on the platform. It corresponds to the
* "perf.cmt" field in the *Stats APIs.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
# define VIR_PERF_PARAM_CMT "cmt"
* from one level of cache to another. It corresponds to the
* "perf.mbmt" field in the *Stats APIs.
*
- * Since: v1.3.5
+ * Since: 1.3.5
*/
# define VIR_PERF_PARAM_MBMT "mbmt"
* through the memory controller on the socket. It corresponds to
* the "perf.mbml" field in the *Stats APIs.
*
- * Since: v1.3.5
+ * Since: 1.3.5
*/
# define VIR_PERF_PARAM_MBML "mbml"
* applications running on the platform. It corresponds to the
* "perf.cache_misses" field in the *Stats APIs.
*
- * Since: v2.3.0
+ * Since: 2.3.0
*/
# define VIR_PERF_PARAM_CACHE_MISSES "cache_misses"
* by applications running on the platform. It corresponds to the
* "perf.cache_references" field in the *Stats APIs.
*
- * Since: v2.3.0
+ * Since: 2.3.0
*/
# define VIR_PERF_PARAM_CACHE_REFERENCES "cache_references"
* by applications running on the platform. It corresponds to the
* "perf.instructions" field in the *Stats APIs.
*
- * Since: v2.3.0
+ * Since: 2.3.0
*/
# define VIR_PERF_PARAM_INSTRUCTIONS "instructions"
* how many cpu cycles one instruction needs.
* It corresponds to the "perf.cpu_cycles" field in the *Stats APIs.
*
- * Since: v2.3.0
+ * Since: 2.3.0
*/
# define VIR_PERF_PARAM_CPU_CYCLES "cpu_cycles"
* by applications running on the platform. It corresponds to the
* "perf.branch_instructions" field in the *Stats APIs.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_PERF_PARAM_BRANCH_INSTRUCTIONS "branch_instructions"
* by applications running on the platform. It corresponds to the
* "perf.branch_misses" field in the *Stats APIs.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_PERF_PARAM_BRANCH_MISSES "branch_misses"
* by applications running on the platform. It corresponds to the
* "perf.bus_cycles" field in the *Stats APIs.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_PERF_PARAM_BUS_CYCLES "bus_cycles"
* running on the platform. It corresponds to the
* "perf.stalled_cycles_frontend" field in the *Stats APIs.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_PERF_PARAM_STALLED_CYCLES_FRONTEND "stalled_cycles_frontend"
* running on the platform. It corresponds to the
* "perf.stalled_cycles_backend" field in the *Stats APIs.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_PERF_PARAM_STALLED_CYCLES_BACKEND "stalled_cycles_backend"
* running on the platform. It corresponds to the
* "perf.ref_cpu_cycles" field in the *Stats APIs.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_PERF_PARAM_REF_CPU_CYCLES "ref_cpu_cycles"
* corresponds to the "perf.cpu_clock" field in the *Stats
* APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_CPU_CLOCK "cpu_clock"
* corresponds to the "perf.task_clock" field in the *Stats
* APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_TASK_CLOCK "task_clock"
* faults by applications running on the platform. It corresponds
* to the "perf.page_faults" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_PAGE_FAULTS "page_faults"
* switches by applications running on the platform. It corresponds
* to the "perf.context_switches" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_CONTEXT_SWITCHES "context_switches"
* migrations by applications running on the platform. It corresponds
* to the "perf.cpu_migrations" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_CPU_MIGRATIONS "cpu_migrations"
* faults by applications running on the platform. It corresponds
* to the "perf.page_faults_min" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_PAGE_FAULTS_MIN "page_faults_min"
* faults by applications running on the platform. It corresponds
* to the "perf.page_faults_maj" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_PAGE_FAULTS_MAJ "page_faults_maj"
* faults by applications running on the platform. It corresponds
* to the "perf.alignment_faults" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_ALIGNMENT_FAULTS "alignment_faults"
* faults by applications running on the platform. It corresponds
* to the "perf.emulation_faults" field in the *Stats APIs.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
# define VIR_PERF_PARAM_EMULATION_FAULTS "emulation_faults"
*
* Describes various possible block jobs.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef enum {
- /* Placeholder (Since: v0.9.4) */
+ /* Placeholder (Since: 0.9.4) */
VIR_DOMAIN_BLOCK_JOB_TYPE_UNKNOWN = 0,
/* Block Pull (virDomainBlockPull, or virDomainBlockRebase without
* flags), job ends on completion
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
VIR_DOMAIN_BLOCK_JOB_TYPE_PULL = 1,
/* Block Copy (virDomainBlockCopy, or virDomainBlockRebase with
* flags), job exists as long as mirroring is active
*
- * Since: v0.9.12
+ * Since: 0.9.12
*/
VIR_DOMAIN_BLOCK_JOB_TYPE_COPY = 2,
/* Block Commit (virDomainBlockCommit without flags), job ends on
* completion
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
VIR_DOMAIN_BLOCK_JOB_TYPE_COMMIT = 3,
/* Active Block Commit (virDomainBlockCommit with flags), job
* exists as long as sync is active
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
VIR_DOMAIN_BLOCK_JOB_TYPE_ACTIVE_COMMIT = 4,
/* Backup (virDomainBackupBegin)
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
VIR_DOMAIN_BLOCK_JOB_TYPE_BACKUP = 5,
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_BLOCK_JOB_TYPE_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_BLOCK_JOB_TYPE_LAST /* (Since: 0.9.10) */
# endif
} virDomainBlockJobType;
* VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT: Pivot to new file when ending a copy or
* active commit job
*
- * Since: v0.9.12
+ * Since: 0.9.12
*/
typedef enum {
- VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, /* (Since: v0.9.12) */
- VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 1 << 1, /* (Since: v0.9.12) */
+ VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1 << 0, /* (Since: 0.9.12) */
+ VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 1 << 1, /* (Since: 0.9.12) */
} virDomainBlockJobAbortFlags;
int virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
*
* Flags for use with virDomainGetBlockJobInfo
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
typedef enum {
VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s
- instead of MiB/s (Since: v1.2.9) */
+ instead of MiB/s (Since: 1.2.9) */
} virDomainBlockJobInfoFlags;
/**
*
* An iterator for monitoring block job operations
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef unsigned long long virDomainBlockJobCursor;
/**
* virDomainBlockJobInfo:
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef struct _virDomainBlockJobInfo virDomainBlockJobInfo;
struct _virDomainBlockJobInfo {
/**
* virDomainBlockJobInfoPtr:
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef virDomainBlockJobInfo *virDomainBlockJobInfoPtr;
*
* Flags for use with virDomainBlockJobSetSpeed
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
typedef enum {
VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES = 1 << 0, /* bandwidth in bytes/s
- instead of MiB/s (Since: v1.2.9) */
+ instead of MiB/s (Since: 1.2.9) */
} virDomainBlockJobSetSpeedFlags;
int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk,
* Flags for use with virDomainBlockPull (values chosen to be a subset of the
* flags for virDomainBlockRebase)
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
typedef enum {
VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s
- instead of MiB/s (Since: v1.2.9) */
+ instead of MiB/s (Since: 1.2.9) */
} virDomainBlockPullFlags;
int virDomainBlockPull(virDomainPtr dom, const char *disk,
*
* Flags available for virDomainBlockRebase().
*
- * Since: v0.9.12
+ * Since: 0.9.12
*/
typedef enum {
VIR_DOMAIN_BLOCK_REBASE_SHALLOW = 1 << 0, /* Limit copy to top of source
- backing chain (Since: v0.9.12) */
+ backing chain (Since: 0.9.12) */
VIR_DOMAIN_BLOCK_REBASE_REUSE_EXT = 1 << 1, /* Reuse existing external
- file for a copy (Since: v0.9.12) */
- VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 1 << 2, /* Make destination file raw (Since: v0.9.12) */
- VIR_DOMAIN_BLOCK_REBASE_COPY = 1 << 3, /* Start a copy job (Since: v0.9.12) */
+ file for a copy (Since: 0.9.12) */
+ VIR_DOMAIN_BLOCK_REBASE_COPY_RAW = 1 << 2, /* Make destination file raw (Since: 0.9.12) */
+ VIR_DOMAIN_BLOCK_REBASE_COPY = 1 << 3, /* Start a copy job (Since: 0.9.12) */
VIR_DOMAIN_BLOCK_REBASE_RELATIVE = 1 << 4, /* Keep backing chain
referenced using relative
- names (Since: v1.2.7) */
+ names (Since: 1.2.7) */
VIR_DOMAIN_BLOCK_REBASE_COPY_DEV = 1 << 5, /* Treat destination as block
- device instead of file (Since: v1.2.9) */
+ device instead of file (Since: 1.2.9) */
VIR_DOMAIN_BLOCK_REBASE_BANDWIDTH_BYTES = 1 << 6, /* bandwidth in bytes/s
- instead of MiB/s (Since: v1.2.9) */
+ instead of MiB/s (Since: 1.2.9) */
} virDomainBlockRebaseFlags;
int virDomainBlockRebase(virDomainPtr dom, const char *disk,
*
* Flags available for virDomainBlockCopy().
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
typedef enum {
- /* Limit copy to top of source backing chain (Since: v1.2.8) */
+ /* Limit copy to top of source backing chain (Since: 1.2.8) */
VIR_DOMAIN_BLOCK_COPY_SHALLOW = 1 << 0,
- /* Reuse existing external file for a copy (Since: v1.2.8) */
+ /* Reuse existing external file for a copy (Since: 1.2.8) */
VIR_DOMAIN_BLOCK_COPY_REUSE_EXT = 1 << 1,
- /* Don't force usage of recoverable job for the copy operation (Since: v3.5.0) */
+ /* Don't force usage of recoverable job for the copy operation (Since: 3.5.0) */
VIR_DOMAIN_BLOCK_COPY_TRANSIENT_JOB = 1 << 2,
/* Force the copy job to synchronously propagate guest writes into
* the destination image, so that the copy is guaranteed to converge
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
VIR_DOMAIN_BLOCK_COPY_SYNCHRONOUS_WRITES = 1 << 3,
} virDomainBlockCopyFlags;
* virDomainBlockJobSetSpeed(). The actual speed can be determined
* with virDomainGetBlockJobInfo().
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
# define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH "bandwidth"
* range. Specifying 0 is the same as omitting this parameter, to
* request the hypervisor default.
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
# define VIR_DOMAIN_BLOCK_COPY_GRANULARITY "granularity"
* as an unsigned long long. Specifying 0 is the same as omitting this
* parameter, to request the hypervisor default.
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
# define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE "buf-size"
*
* Flags available for virDomainBlockCommit().
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
VIR_DOMAIN_BLOCK_COMMIT_SHALLOW = 1 << 0, /* NULL base means next backing
- file, not whole chain (Since: v0.10.2) */
+ file, not whole chain (Since: 0.10.2) */
VIR_DOMAIN_BLOCK_COMMIT_DELETE = 1 << 1, /* Delete any files that are now
invalid after their contents
- have been committed (Since: v0.10.2) */
+ have been committed (Since: 0.10.2) */
VIR_DOMAIN_BLOCK_COMMIT_ACTIVE = 1 << 2, /* Allow a two-phase commit when
- top is the active layer (Since: v1.2.6) */
+ top is the active layer (Since: 1.2.6) */
VIR_DOMAIN_BLOCK_COMMIT_RELATIVE = 1 << 3, /* keep the backing chain
referenced using relative
- names (Since: v1.2.7) */
+ names (Since: 1.2.7) */
VIR_DOMAIN_BLOCK_COMMIT_BANDWIDTH_BYTES = 1 << 4, /* bandwidth in bytes/s
- instead of MiB/s (Since: v1.2.9) */
+ instead of MiB/s (Since: 1.2.9) */
} virDomainBlockCommitFlags;
int virDomainBlockCommit(virDomainPtr dom, const char *disk, const char *base,
* Macro for the BlockIoTune tunable weight: it represents the total
* bytes per second permitted through a block device, as a ullong.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC "total_bytes_sec"
* Macro for the BlockIoTune tunable weight: it represents the read
* bytes per second permitted through a block device, as a ullong.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC "read_bytes_sec"
* Macro for the BlockIoTune tunable weight: it represents the write
* bytes per second permitted through a block device, as a ullong.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC "write_bytes_sec"
* Macro for the BlockIoTune tunable weight: it represents the total
* I/O operations per second permitted through a block device, as a ullong.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC "total_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.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC "read_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.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC "write_iops_sec"
* Macro for the BlockIoTune tunable weight: it represents the maximum total
* bytes per second permitted through a block device, as a ullong.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX "total_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.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX "read_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.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX "write_bytes_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.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX "total_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.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX "read_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.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX "write_iops_sec_max"
* Macro for the BlockIoTune tunable weight: it represents the duration in
* seconds for the burst allowed by total_bytes_sec_max, as a ullong.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC_MAX_LENGTH "total_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.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC_MAX_LENGTH "read_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.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC_MAX_LENGTH "write_bytes_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.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC_MAX_LENGTH "total_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.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC_MAX_LENGTH "read_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.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC_MAX_LENGTH "write_iops_sec_max_length"
* Macro for the BlockIoTune tunable weight: it represents the size
* I/O operations per second permitted through a block device, as a ullong.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_SIZE_IOPS_SEC "size_iops_sec"
* 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.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_DOMAIN_BLOCK_IOTUNE_GROUP_NAME "group_name"
*
* Disk I/O error.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error (Since: v0.9.10) */
- VIR_DOMAIN_DISK_ERROR_UNSPEC = 1, /* unspecified I/O error (Since: v0.9.10) */
- VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2, /* no space left on the device (Since: v0.9.10) */
+ VIR_DOMAIN_DISK_ERROR_NONE = 0, /* no error (Since: 0.9.10) */
+ VIR_DOMAIN_DISK_ERROR_UNSPEC = 1, /* unspecified I/O error (Since: 0.9.10) */
+ VIR_DOMAIN_DISK_ERROR_NO_SPACE = 2, /* no space left on the device (Since: 0.9.10) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_DISK_ERROR_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_DISK_ERROR_LAST /* (Since: 0.9.10) */
# endif
} virDomainDiskErrorCode;
/**
* virDomainDiskError:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef struct _virDomainDiskError virDomainDiskError;
/**
* virDomainDiskErrorPtr:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef virDomainDiskError *virDomainDiskErrorPtr;
*
* Enum to specify which keycode mapping is in use for virDomainSendKey().
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef enum {
- VIR_KEYCODE_SET_LINUX = 0, /* (Since: v0.9.3) */
- VIR_KEYCODE_SET_XT = 1, /* (Since: v0.9.3) */
- VIR_KEYCODE_SET_ATSET1 = 2, /* (Since: v0.9.3) */
- VIR_KEYCODE_SET_ATSET2 = 3, /* (Since: v0.9.3) */
- VIR_KEYCODE_SET_ATSET3 = 4, /* (Since: v0.9.3) */
- VIR_KEYCODE_SET_OSX = 5, /* (Since: v0.9.4) */
- VIR_KEYCODE_SET_XT_KBD = 6, /* (Since: v0.9.4) */
- VIR_KEYCODE_SET_USB = 7, /* (Since: v0.9.4) */
- VIR_KEYCODE_SET_WIN32 = 8, /* (Since: v0.9.4) */
- VIR_KEYCODE_SET_QNUM = 9, /* (Since: v4.2.0) */
+ VIR_KEYCODE_SET_LINUX = 0, /* (Since: 0.9.3) */
+ VIR_KEYCODE_SET_XT = 1, /* (Since: 0.9.3) */
+ VIR_KEYCODE_SET_ATSET1 = 2, /* (Since: 0.9.3) */
+ VIR_KEYCODE_SET_ATSET2 = 3, /* (Since: 0.9.3) */
+ VIR_KEYCODE_SET_ATSET3 = 4, /* (Since: 0.9.3) */
+ VIR_KEYCODE_SET_OSX = 5, /* (Since: 0.9.4) */
+ VIR_KEYCODE_SET_XT_KBD = 6, /* (Since: 0.9.4) */
+ VIR_KEYCODE_SET_USB = 7, /* (Since: 0.9.4) */
+ VIR_KEYCODE_SET_WIN32 = 8, /* (Since: 0.9.4) */
+ VIR_KEYCODE_SET_QNUM = 9, /* (Since: 4.2.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_KEYCODE_SET_LAST
* added to the libvirt API. It reflects the last keycode set supported
* by this version of the libvirt API.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
# endif
} virKeycodeSet;
*
* Compatibility alias for VIR_KEYCODE_SET_QNUM, which replaced it since 4.2.0.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
# define VIR_KEYCODE_SET_RFB VIR_KEYCODE_SET_QNUM
*
* Maximum number of keycodes that can be sent in one virDomainSendKey() call.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_DOMAIN_SEND_KEY_MAX_KEYS 16
* this enum might be extended with new signals which have no
* mapping in Linux.
*
- * Since: v1.0.1
+ * Since: 1.0.1
*/
typedef enum {
- VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1, /* SIGHUP (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_INT = 2, /* SIGINT (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3, /* SIGQUIT (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4, /* SIGILL (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5, /* SIGTRAP (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6, /* SIGABRT (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7, /* SIGBUS (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8, /* SIGFPE (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9, /* SIGKILL (Since: v1.0.1) */
-
- VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10, /* SIGUSR1 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11, /* SIGSEGV (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12, /* SIGUSR2 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13, /* SIGPIPE (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14, /* SIGALRM (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15, /* SIGTERM (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16, /* Not in POSIX (SIGSTKFLT on Linux (Since: v1.0.1) )*/
- VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17, /* SIGCHLD (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18, /* SIGCONT (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19, /* SIGSTOP (Since: v1.0.1) */
-
- VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20, /* SIGTSTP (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21, /* SIGTTIN (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22, /* SIGTTOU (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_URG = 23, /* SIGURG (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24, /* SIGXCPU (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25, /* SIGXFSZ (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26, /* SIGVTALRM (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27, /* SIGPROF (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28, /* Not in POSIX (SIGWINCH on Linux) (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29, /* SIGPOLL (also known as SIGIO on Linux) (Since: v1.0.1) */
-
- VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30, /* Not in POSIX (SIGPWR on Linux) (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31, /* SIGSYS (also known as SIGUNUSED on Linux) (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32, /* SIGRTMIN (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33, /* SIGRTMIN + 1 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34, /* SIGRTMIN + 2 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35, /* SIGRTMIN + 3 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36, /* SIGRTMIN + 4 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37, /* SIGRTMIN + 5 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38, /* SIGRTMIN + 6 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39, /* SIGRTMIN + 7 (Since: v1.0.1) */
-
- VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40, /* SIGRTMIN + 8 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41, /* SIGRTMIN + 9 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42, /* SIGRTMIN + 10 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43, /* SIGRTMIN + 11 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44, /* SIGRTMIN + 12 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45, /* SIGRTMIN + 13 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46, /* SIGRTMIN + 14 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47, /* SIGRTMIN + 15 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48, /* SIGRTMIN + 16 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49, /* SIGRTMIN + 17 (Since: v1.0.1) */
-
- VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50, /* SIGRTMIN + 18 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51, /* SIGRTMIN + 19 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52, /* SIGRTMIN + 20 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53, /* SIGRTMIN + 21 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54, /* SIGRTMIN + 22 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55, /* SIGRTMIN + 23 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56, /* SIGRTMIN + 24 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57, /* SIGRTMIN + 25 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58, /* SIGRTMIN + 26 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59, /* SIGRTMIN + 27 (Since: v1.0.1) */
-
- VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60, /* SIGRTMIN + 28 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61, /* SIGRTMIN + 29 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62, /* SIGRTMIN + 30 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63, /* SIGRTMIN + 31 (Since: v1.0.1) */
- VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64, /* SIGRTMIN + 32 / SIGRTMAX (Since: v1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_NOP = 0, /* No constant in POSIX/Linux (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_HUP = 1, /* SIGHUP (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_INT = 2, /* SIGINT (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_QUIT = 3, /* SIGQUIT (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_ILL = 4, /* SIGILL (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_TRAP = 5, /* SIGTRAP (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_ABRT = 6, /* SIGABRT (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_BUS = 7, /* SIGBUS (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_FPE = 8, /* SIGFPE (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_KILL = 9, /* SIGKILL (Since: 1.0.1) */
+
+ VIR_DOMAIN_PROCESS_SIGNAL_USR1 = 10, /* SIGUSR1 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_SEGV = 11, /* SIGSEGV (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_USR2 = 12, /* SIGUSR2 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_PIPE = 13, /* SIGPIPE (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_ALRM = 14, /* SIGALRM (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_TERM = 15, /* SIGTERM (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_STKFLT = 16, /* Not in POSIX (SIGSTKFLT on Linux (Since: 1.0.1) )*/
+ VIR_DOMAIN_PROCESS_SIGNAL_CHLD = 17, /* SIGCHLD (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_CONT = 18, /* SIGCONT (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_STOP = 19, /* SIGSTOP (Since: 1.0.1) */
+
+ VIR_DOMAIN_PROCESS_SIGNAL_TSTP = 20, /* SIGTSTP (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_TTIN = 21, /* SIGTTIN (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_TTOU = 22, /* SIGTTOU (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_URG = 23, /* SIGURG (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_XCPU = 24, /* SIGXCPU (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_XFSZ = 25, /* SIGXFSZ (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_VTALRM = 26, /* SIGVTALRM (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_PROF = 27, /* SIGPROF (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_WINCH = 28, /* Not in POSIX (SIGWINCH on Linux) (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_POLL = 29, /* SIGPOLL (also known as SIGIO on Linux) (Since: 1.0.1) */
+
+ VIR_DOMAIN_PROCESS_SIGNAL_PWR = 30, /* Not in POSIX (SIGPWR on Linux) (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_SYS = 31, /* SIGSYS (also known as SIGUNUSED on Linux) (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT0 = 32, /* SIGRTMIN (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT1 = 33, /* SIGRTMIN + 1 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT2 = 34, /* SIGRTMIN + 2 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT3 = 35, /* SIGRTMIN + 3 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT4 = 36, /* SIGRTMIN + 4 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT5 = 37, /* SIGRTMIN + 5 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT6 = 38, /* SIGRTMIN + 6 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT7 = 39, /* SIGRTMIN + 7 (Since: 1.0.1) */
+
+ VIR_DOMAIN_PROCESS_SIGNAL_RT8 = 40, /* SIGRTMIN + 8 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT9 = 41, /* SIGRTMIN + 9 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT10 = 42, /* SIGRTMIN + 10 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT11 = 43, /* SIGRTMIN + 11 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT12 = 44, /* SIGRTMIN + 12 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT13 = 45, /* SIGRTMIN + 13 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT14 = 46, /* SIGRTMIN + 14 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT15 = 47, /* SIGRTMIN + 15 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT16 = 48, /* SIGRTMIN + 16 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT17 = 49, /* SIGRTMIN + 17 (Since: 1.0.1) */
+
+ VIR_DOMAIN_PROCESS_SIGNAL_RT18 = 50, /* SIGRTMIN + 18 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT19 = 51, /* SIGRTMIN + 19 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT20 = 52, /* SIGRTMIN + 20 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT21 = 53, /* SIGRTMIN + 21 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT22 = 54, /* SIGRTMIN + 22 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT23 = 55, /* SIGRTMIN + 23 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT24 = 56, /* SIGRTMIN + 24 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT25 = 57, /* SIGRTMIN + 25 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT26 = 58, /* SIGRTMIN + 26 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT27 = 59, /* SIGRTMIN + 27 (Since: 1.0.1) */
+
+ VIR_DOMAIN_PROCESS_SIGNAL_RT28 = 60, /* SIGRTMIN + 28 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT29 = 61, /* SIGRTMIN + 29 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT30 = 62, /* SIGRTMIN + 30 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT31 = 63, /* SIGRTMIN + 31 (Since: 1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_RT32 = 64, /* SIGRTMIN + 32 / SIGRTMAX (Since: 1.0.1) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_PROCESS_SIGNAL_LAST /* (Since: v1.0.1) */
+ VIR_DOMAIN_PROCESS_SIGNAL_LAST /* (Since: 1.0.1) */
# endif
} virDomainProcessSignal;
*
* a virDomainEventType is emitted during domain lifecycle events
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_DEFINED = 0, /* (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_UNDEFINED = 1, /* (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STARTED = 2, /* (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_SUSPENDED = 3, /* (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_RESUMED = 4, /* (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED = 5, /* (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_SHUTDOWN = 6, /* (Since: v0.9.8) */
- VIR_DOMAIN_EVENT_PMSUSPENDED = 7, /* (Since: v0.10.2) */
- VIR_DOMAIN_EVENT_CRASHED = 8, /* (Since: v1.1.1) */
+ VIR_DOMAIN_EVENT_DEFINED = 0, /* (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_UNDEFINED = 1, /* (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STARTED = 2, /* (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_SUSPENDED = 3, /* (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_RESUMED = 4, /* (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED = 5, /* (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_SHUTDOWN = 6, /* (Since: 0.9.8) */
+ VIR_DOMAIN_EVENT_PMSUSPENDED = 7, /* (Since: 0.10.2) */
+ VIR_DOMAIN_EVENT_CRASHED = 8, /* (Since: 1.1.1) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventType;
*
* Details on the cause of a 'defined' lifecycle event
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1, /* Changed config file (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_DEFINED_RENAMED = 2, /* Domain was renamed (Since: v1.2.19) */
- VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3, /* Config was restored from a snapshot (Since: v1.3.3) */
+ VIR_DOMAIN_EVENT_DEFINED_ADDED = 0, /* Newly created config file (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_DEFINED_UPDATED = 1, /* Changed config file (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_DEFINED_RENAMED = 2, /* Domain was renamed (Since: 1.2.19) */
+ VIR_DOMAIN_EVENT_DEFINED_FROM_SNAPSHOT = 3, /* Config was restored from a snapshot (Since: 1.3.3) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_DEFINED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_DEFINED_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventDefinedDetailType;
*
* Details on the cause of an 'undefined' lifecycle event
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1, /* Domain was renamed (Since: v1.2.19) */
+ VIR_DOMAIN_EVENT_UNDEFINED_REMOVED = 0, /* Deleted the config file (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_UNDEFINED_RENAMED = 1, /* Domain was renamed (Since: 1.2.19) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_UNDEFINED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_UNDEFINED_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventUndefinedDetailType;
*
* Details on the cause of a 'started' lifecycle event
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1, /* Incoming migration from another host (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STARTED_RESTORED = 2, /* Restored from a state file (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3, /* Restored from snapshot (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4, /* Started due to wakeup event (Since: v0.9.11) */
+ VIR_DOMAIN_EVENT_STARTED_BOOTED = 0, /* Normal startup from boot (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STARTED_MIGRATED = 1, /* Incoming migration from another host (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STARTED_RESTORED = 2, /* Restored from a state file (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT = 3, /* Restored from snapshot (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_STARTED_WAKEUP = 4, /* Started due to wakeup event (Since: 0.9.11) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_STARTED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_STARTED_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventStartedDetailType;
*
* Details on the cause of a 'suspended' lifecycle event
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1, /* Suspended for offline migration (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2, /* Suspended due to a disk I/O error (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3, /* Suspended due to a watchdog firing (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4, /* Restored from paused state file (Since: v0.9.5) */
- VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5, /* Restored from paused snapshot (Since: v0.9.5) */
- VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6, /* suspended after failure during libvirt API call (Since: v1.0.1) */
- VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7, /* suspended for post-copy migration (Since: v1.3.3) */
- VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8, /* suspended after failed post-copy (Since: v1.3.3) */
+ VIR_DOMAIN_EVENT_SUSPENDED_PAUSED = 0, /* Normal suspend due to admin pause (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED = 1, /* Suspended for offline migration (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_SUSPENDED_IOERROR = 2, /* Suspended due to a disk I/O error (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG = 3, /* Suspended due to a watchdog firing (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_SUSPENDED_RESTORED = 4, /* Restored from paused state file (Since: 0.9.5) */
+ VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT = 5, /* Restored from paused snapshot (Since: 0.9.5) */
+ VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR = 6, /* suspended after failure during libvirt API call (Since: 1.0.1) */
+ VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY = 7, /* suspended for post-copy migration (Since: 1.3.3) */
+ VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED = 8, /* suspended after failed post-copy (Since: 1.3.3) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_SUSPENDED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_SUSPENDED_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventSuspendedDetailType;
*
* Details on the cause of a 'resumed' lifecycle event
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1, /* Resumed for completion of migration (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2, /* Resumed from snapshot (Since: v0.9.5) */
+ VIR_DOMAIN_EVENT_RESUMED_UNPAUSED = 0, /* Normal resume due to admin unpause (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_RESUMED_MIGRATED = 1, /* Resumed for completion of migration (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT = 2, /* Resumed from snapshot (Since: 0.9.5) */
VIR_DOMAIN_EVENT_RESUMED_POSTCOPY = 3, /* Resumed, but migration is still
- running in post-copy mode (Since: v1.3.3) */
+ running in post-copy mode (Since: 1.3.3) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_RESUMED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_RESUMED_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventResumedDetailType;
*
* Details on the cause of a 'stopped' lifecycle event
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1, /* Forced poweroff from host (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2, /* Guest crashed (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3, /* Migrated off to another host (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED_SAVED = 4, /* Saved to a state file (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED_FAILED = 5, /* Host emulator/mgmt failed (Since: v0.5.0) */
- VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6, /* offline snapshot loaded (Since: v0.8.0) */
+ VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN = 0, /* Normal shutdown (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED_DESTROYED = 1, /* Forced poweroff from host (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED_CRASHED = 2, /* Guest crashed (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED_MIGRATED = 3, /* Migrated off to another host (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED_SAVED = 4, /* Saved to a state file (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED_FAILED = 5, /* Host emulator/mgmt failed (Since: 0.5.0) */
+ VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT = 6, /* offline snapshot loaded (Since: 0.8.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_STOPPED_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_STOPPED_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventStoppedDetailType;
*
* Details on the cause of a 'shutdown' lifecycle event
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
typedef enum {
- /* Guest finished shutdown sequence (Since: v0.9.8) */
+ /* Guest finished shutdown sequence (Since: 0.9.8) */
VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED = 0,
/* Domain finished shutting down after request from the guest itself
- * (e.g. hardware-specific action) (Since: v3.4.0) */
+ * (e.g. hardware-specific action) (Since: 3.4.0) */
VIR_DOMAIN_EVENT_SHUTDOWN_GUEST = 1,
/* Domain finished shutting down after request from the host (e.g. killed by
* a signal)
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
VIR_DOMAIN_EVENT_SHUTDOWN_HOST = 2,
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_SHUTDOWN_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_SHUTDOWN_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventShutdownDetailType;
*
* Details on the cause of a 'pmsuspended' lifecycle event
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory (Since: v0.10.2) */
- VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1, /* Guest was PM suspended to disk (Since: v1.0.0) */
+ VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY = 0, /* Guest was PM suspended to memory (Since: 0.10.2) */
+ VIR_DOMAIN_EVENT_PMSUSPENDED_DISK = 1, /* Guest was PM suspended to disk (Since: 1.0.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_PMSUSPENDED_LAST /* (Since: v0.10.2) */
+ VIR_DOMAIN_EVENT_PMSUSPENDED_LAST /* (Since: 0.10.2) */
# endif
} virDomainEventPMSuspendedDetailType;
*
* Details on the cause of a 'crashed' lifecycle event
*
- * Since: v1.1.1
+ * Since: 1.1.1
*/
typedef enum {
- VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked (Since: v1.1.1) */
- VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED = 1, /* Guest was crashloaded (Since: v6.1.0) */
+ VIR_DOMAIN_EVENT_CRASHED_PANICKED = 0, /* Guest was panicked (Since: 1.1.1) */
+ VIR_DOMAIN_EVENT_CRASHED_CRASHLOADED = 1, /* Guest was crashloaded (Since: 6.1.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_CRASHED_LAST /* (Since: v1.1.1) */
+ VIR_DOMAIN_EVENT_CRASHED_LAST /* (Since: 1.1.1) */
# endif
} virDomainEventCrashedDetailType;
*
* Recipient of a memory failure event.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
typedef enum {
- /* memory failure at hypersivor memory address space (Since: v6.9.0) */
+ /* memory failure at hypersivor memory address space (Since: 6.9.0) */
VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_HYPERVISOR = 0,
- /* memory failure at guest memory address space (Since: v6.9.0) */
+ /* memory failure at guest memory address space (Since: 6.9.0) */
VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_GUEST = 1,
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST /* (Since: v6.9.0) */
+ VIR_DOMAIN_EVENT_MEMORY_FAILURE_RECIPIENT_LAST /* (Since: 6.9.0) */
# endif
} virDomainMemoryFailureRecipientType;
*
* Action of a memory failure event.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
typedef enum {
/* the memory failure could be ignored. This will only be the case for
* action-optional failures.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_IGNORE = 0,
* mechanism, and hypervisor could inject the MCE into the guest
* successfully.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_INJECT = 1,
/* the failure is unrecoverable. This occurs for action-required failures
* if the recipient is the hypervisor; hypervisor will exit.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_FATAL = 2,
/* the failure is unrecoverable but confined to the guest. This occurs if
* the recipient is a guest which is not ready to handle memory failures.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_RESET = 3,
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST /* (Since: v6.9.0) */
+ VIR_DOMAIN_EVENT_MEMORY_FAILURE_ACTION_LAST /* (Since: 6.9.0) */
# endif
} virDomainMemoryFailureActionType;
/**
* virDomainMemoryFailureFlags:
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
typedef enum {
/* whether a memory failure event is action-required or action-optional
- * (e.g. a failure during memory scrub). (Since: v6.9.0) */
+ * (e.g. a failure during memory scrub). (Since: 6.9.0) */
VIR_DOMAIN_MEMORY_FAILURE_ACTION_REQUIRED = (1 << 0),
/* whether the failure occurred while the previous failure was still in
* progress.
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
VIR_DOMAIN_MEMORY_FAILURE_RECURSIVE = (1 << 1),
} virDomainMemoryFailureFlags;
*
* Returns 0 (the return value is currently ignored)
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef int (*virConnectDomainEventCallback)(virConnectPtr conn,
virDomainPtr dom,
/**
* virDomainJobType:
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
typedef enum {
- VIR_DOMAIN_JOB_NONE = 0, /* No job is active (Since: v0.7.7) */
- VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time (Since: v0.7.7) */
- VIR_DOMAIN_JOB_UNBOUNDED = 2, /* Job without a finite completion time (Since: v0.7.7) */
- VIR_DOMAIN_JOB_COMPLETED = 3, /* Job has finished, but isn't cleaned up (Since: v0.7.7) */
- VIR_DOMAIN_JOB_FAILED = 4, /* Job hit error, but isn't cleaned up (Since: v0.7.7) */
- VIR_DOMAIN_JOB_CANCELLED = 5, /* Job was aborted, but isn't cleaned up (Since: v0.7.7) */
+ VIR_DOMAIN_JOB_NONE = 0, /* No job is active (Since: 0.7.7) */
+ VIR_DOMAIN_JOB_BOUNDED = 1, /* Job with a finite completion time (Since: 0.7.7) */
+ VIR_DOMAIN_JOB_UNBOUNDED = 2, /* Job without a finite completion time (Since: 0.7.7) */
+ VIR_DOMAIN_JOB_COMPLETED = 3, /* Job has finished, but isn't cleaned up (Since: 0.7.7) */
+ VIR_DOMAIN_JOB_FAILED = 4, /* Job hit error, but isn't cleaned up (Since: 0.7.7) */
+ VIR_DOMAIN_JOB_CANCELLED = 5, /* Job was aborted, but isn't cleaned up (Since: 0.7.7) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_JOB_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_JOB_LAST /* (Since: 0.9.10) */
# endif
} virDomainJobType;
/**
* virDomainJobInfo:
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
typedef struct _virDomainJobInfo virDomainJobInfo;
/**
* virDomainJobInfoPtr:
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
typedef virDomainJobInfo *virDomainJobInfoPtr;
struct _virDomainJobInfo {
* Flags OR'ed together to provide specific behavior when querying domain
* job statistics.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
typedef enum {
VIR_DOMAIN_JOB_STATS_COMPLETED = 1 << 0, /* return stats of a recently
- * completed job (Since: v1.2.9) */
+ * completed job (Since: 1.2.9) */
VIR_DOMAIN_JOB_STATS_KEEP_COMPLETED = 1 << 1, /* don't remove completed
- stats when reading them (Since: v6.0.0) */
+ stats when reading them (Since: 6.0.0) */
} virDomainGetJobStatsFlags;
int virDomainGetJobInfo(virDomainPtr dom,
/**
* virDomainJobOperation:
*
- * Since: v3.3.0
+ * Since: 3.3.0
*/
typedef enum {
- VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_START = 1, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_SAVE = 2, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_RESTORE = 3, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN = 4, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT = 5, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_SNAPSHOT = 6, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT = 7, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_DUMP = 8, /* (Since: v3.3.0) */
- VIR_DOMAIN_JOB_OPERATION_BACKUP = 9, /* (Since: v6.0.0) */
+ VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_START = 1, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_SAVE = 2, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_RESTORE = 3, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_MIGRATION_IN = 4, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_MIGRATION_OUT = 5, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_SNAPSHOT = 6, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_SNAPSHOT_REVERT = 7, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_DUMP = 8, /* (Since: 3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_BACKUP = 9, /* (Since: 6.0.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_JOB_OPERATION_LAST /* (Since: v3.3.0) */
+ VIR_DOMAIN_JOB_OPERATION_LAST /* (Since: 3.3.0) */
# endif
} virDomainJobOperation;
* VIR_TYPED_PARAM_INT. The values correspond to the items in
* virDomainJobOperation enum.
*
- * Since: v3.3.0
+ * Since: 3.3.0
*/
# define VIR_DOMAIN_JOB_OPERATION "operation"
*
* This field corresponds to timeElapsed field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_TIME_ELAPSED "time_elapsed"
* flow from the source host to the destination host,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.15
+ * Since: 1.2.15
*/
# define VIR_DOMAIN_JOB_TIME_ELAPSED_NET "time_elapsed_net"
*
* This field corresponds to timeRemaining field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_TIME_REMAINING "time_remaining"
* between the time guest CPUs were paused and the time they were resumed
* is reported for completed migration.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DOWNTIME "downtime"
* the time required to transfer control flow from the source host to the
* destination host, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.15
+ * Since: 1.2.15
*/
# define VIR_DOMAIN_JOB_DOWNTIME_NET "downtime_net"
* the migration in the 'setup' phase before the iterations begin, as
* VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_JOB_SETUP_TIME "setup_time"
*
* This field corresponds to dataTotal field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DATA_TOTAL "data_total"
*
* This field corresponds to dataProcessed field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DATA_PROCESSED "data_processed"
*
* This field corresponds to dataRemaining field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DATA_REMAINING "data_remaining"
*
* This field corresponds to memTotal field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_TOTAL "memory_total"
*
* This field corresponds to memProcessed field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_PROCESSED "memory_processed"
*
* This field corresponds to memRemaining field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_REMAINING "memory_remaining"
* The most common example of such pages are zero pages, i.e., pages filled
* with zero bytes.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_CONSTANT "memory_constant"
* byte and which could not be compressed) transferred since the beginning
* of the migration job, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_NORMAL "memory_normal"
*
* See VIR_DOMAIN_JOB_MEMORY_NORMAL for more details.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES "memory_normal_bytes"
* virDomainGetJobStats field: network throughput used while migrating
* memory in Bytes per second, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_JOB_MEMORY_BPS "memory_bps"
* per second, as VIR_TYPED_PARAM_ULLONG. This statistics makes sense only
* when live migration is running.
*
- * Since: v1.3.1
+ * Since: 1.3.1
*/
# define VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE "memory_dirty_rate"
* VIR_DOMAIN_JOB_MEMORY_DIRTY_RATE or VIR_DOMAIN_JOB_COMPRESSION_PAGES
* to bytes.
*
- * Since: v3.9.0
+ * Since: 3.9.0
*/
# define VIR_DOMAIN_JOB_MEMORY_PAGE_SIZE "memory_page_size"
* every time a new iteration is started to transfer memory pages dirtied
* since the last iteration.
*
- * Since: v1.3.1
+ * Since: 1.3.1
*/
# define VIR_DOMAIN_JOB_MEMORY_ITERATION "memory_iteration"
* This counter is incremented whenever the migrated domain tries to access
* a memory page which has not been transferred from the source host yet.
*
- * Since: v5.0.0
+ * Since: 5.0.0
*/
# define VIR_DOMAIN_JOB_MEMORY_POSTCOPY_REQS "memory_postcopy_requests"
*
* This field corresponds to fileTotal field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DISK_TOTAL "disk_total"
*
* This field corresponds to fileProcessed field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DISK_PROCESSED "disk_processed"
*
* This field corresponds to fileRemaining field in virDomainJobInfo.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_DISK_REMAINING "disk_remaining"
* virDomainGetJobStats field: network throughput used while migrating
* disks in Bytes per second, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_JOB_DISK_BPS "disk_bps"
* compressing repeatedly transferred memory pages during live migration,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_CACHE "compression_cache"
* virDomainGetJobStats field: number of compressed bytes transferred
* since the beginning of migration, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_BYTES "compression_bytes"
* virDomainGetJobStats field: number of compressed pages transferred
* since the beginning of migration, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_PAGES "compression_pages"
* were not found in compression cache and thus could not be compressed,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES "compression_cache_misses"
* the result of compression was larger than the original page as a whole,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
# define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW "compression_overflow"
* to when auto-convergence decided migration was not converging, as
* VIR_TYPED_PARAM_INT.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_DOMAIN_JOB_AUTO_CONVERGE_THROTTLE "auto_converge_throttle"
* virDomainGetJobStats field: Present only in statistics for a completed job.
* Successful completion of the job as VIR_TYPED_PARAM_BOOLEAN.
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
# define VIR_DOMAIN_JOB_SUCCESS "success"
* virDomainGetJobStats field: Present only in statistics for a completed job.
* Optional error message for a failed job.
*
- * Since: v6.3.0
+ * Since: 6.3.0
*/
# define VIR_DOMAIN_JOB_ERRMSG "errmsg"
* virDomainGetJobStats field: current usage of temporary disk space for the
* job in bytes as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
# define VIR_DOMAIN_JOB_DISK_TEMP_USED "disk_temp_used"
* virDomainGetJobStats field: possible total temporary disk space for the
* job in bytes as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
# define VIR_DOMAIN_JOB_DISK_TEMP_TOTAL "disk_temp_total"
* passed in a different parameter position; use VIR_DOMAIN_EVENT_CALLBACK()
* when registering an appropriate handler.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef void (*virConnectDomainEventGenericCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_RTC_CHANGE with virConnectDomainEventRegisterAny()
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef void (*virConnectDomainEventRTCChangeCallback)(virConnectPtr conn,
virDomainPtr dom,
*
* The action that is to be taken due to the watchdog device firing
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_WATCHDOG_RESET, /* Guest CPUs are reset (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF, /* Guest is forcibly powered off (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN, /* Guest is requested to gracefully shutdown (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logged (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt into guest (Since: v1.2.17) */
+ VIR_DOMAIN_EVENT_WATCHDOG_NONE = 0, /* No action, watchdog ignored (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_WATCHDOG_PAUSE, /* Guest CPUs are paused (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_WATCHDOG_RESET, /* Guest CPUs are reset (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_WATCHDOG_POWEROFF, /* Guest is forcibly powered off (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_WATCHDOG_SHUTDOWN, /* Guest is requested to gracefully shutdown (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_WATCHDOG_DEBUG, /* No action, a debug message logged (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_WATCHDOG_INJECTNMI,/* Inject a non-maskable interrupt into guest (Since: 1.2.17) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_WATCHDOG_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_WATCHDOG_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventWatchdogAction;
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_WATCHDOG with virConnectDomainEventRegisterAny()
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef void (*virConnectDomainEventWatchdogCallback)(virConnectPtr conn,
virDomainPtr dom,
*
* The action that is to be taken due to an IO error occurring
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_IO_ERROR_PAUSE, /* Guest CPUs are paused (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_IO_ERROR_REPORT, /* IO error reported to guest OS (Since: v0.8.0) */
+ VIR_DOMAIN_EVENT_IO_ERROR_NONE = 0, /* No action, IO error ignored (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_IO_ERROR_PAUSE, /* Guest CPUs are paused (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_IO_ERROR_REPORT, /* IO error reported to guest OS (Since: 0.8.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_IO_ERROR_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_IO_ERROR_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventIOErrorAction;
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_IO_ERROR with virConnectDomainEventRegisterAny()
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn,
virDomainPtr dom,
* Otherwise, @reason will be "", although future strings may be added
* if determination of other error types becomes possible.
*
- * Since: v0.8.1
+ * Since: 0.8.1
*/
typedef void (*virConnectDomainEventIOErrorReasonCallback)(virConnectPtr conn,
virDomainPtr dom,
*
* The phase of the graphics client connection
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup completed (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection (Since: v0.8.0) */
+ VIR_DOMAIN_EVENT_GRAPHICS_CONNECT = 0, /* Initial socket connection established (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_GRAPHICS_INITIALIZE, /* Authentication & setup completed (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_GRAPHICS_DISCONNECT, /* Final socket disconnection (Since: 0.8.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_GRAPHICS_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_GRAPHICS_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventGraphicsPhase;
*
* The type of address for the connection
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6, /* IPv6 address (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX, /* UNIX socket path (Since: v0.9.7) */
+ VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4, /* IPv4 address (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6, /* IPv6 address (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX, /* UNIX socket path (Since: 0.9.7) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST /* (Since: 0.9.10) */
# endif
} virDomainEventGraphicsAddressType;
*
* The data structure containing connection address details
*
- * Since: v1.0.0
+ * Since: 1.0.0
*/
struct _virDomainEventGraphicsAddress {
int family; /* Address family, virDomainEventGraphicsAddressType */
/**
* virDomainEventGraphicsAddress:
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef struct _virDomainEventGraphicsAddress virDomainEventGraphicsAddress;
/**
* virDomainEventGraphicsAddressPtr:
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef virDomainEventGraphicsAddress *virDomainEventGraphicsAddressPtr;
/**
* virDomainEventGraphicsSubjectIdentity:
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef struct _virDomainEventGraphicsSubjectIdentity virDomainEventGraphicsSubjectIdentity;
/**
* virDomainEventGraphicsSubjectIdentityPtr:
*
- * Since: v0.8.0
+ * Since: 0.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
+ * Since: 0.8.0
*/
struct _virDomainEventGraphicsSubject {
int nidentity; /* Number of identities in array*/
/**
* virDomainEventGraphicsSubject:
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef struct _virDomainEventGraphicsSubject virDomainEventGraphicsSubject;
/**
* virDomainEventGraphicsSubjectPtr:
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr;
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_GRAPHICS with virConnectDomainEventRegisterAny()
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef void (*virConnectDomainEventGraphicsCallback)(virConnectPtr conn,
virDomainPtr dom,
* Tracks status of a virDomainBlockPull(), virDomainBlockRebase(),
* virDomainBlockCopy(), or virDomainBlockCommit() operation
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef enum {
- VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, /* (Since: v0.9.4) */
- VIR_DOMAIN_BLOCK_JOB_FAILED = 1, /* (Since: v0.9.4) */
- VIR_DOMAIN_BLOCK_JOB_CANCELED = 2, /* (Since: v0.9.12) */
- VIR_DOMAIN_BLOCK_JOB_READY = 3, /* (Since: v1.0.0) */
+ VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0, /* (Since: 0.9.4) */
+ VIR_DOMAIN_BLOCK_JOB_FAILED = 1, /* (Since: 0.9.4) */
+ VIR_DOMAIN_BLOCK_JOB_CANCELED = 2, /* (Since: 0.9.12) */
+ VIR_DOMAIN_BLOCK_JOB_READY = 3, /* (Since: 1.0.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_BLOCK_JOB_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_BLOCK_JOB_LAST /* (Since: 0.9.10) */
# endif
} virConnectDomainEventBlockJobStatus;
* then @disk will contain the device target shorthand (the <target
* dev='...'/> sub-element, such as "vda").
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
typedef void (*virConnectDomainEventBlockJobCallback)(virConnectPtr conn,
virDomainPtr dom,
*
* The reason describing why this callback is called
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
typedef enum {
/* Removable media changed to empty according to startup policy as source
* was missing. oldSrcPath is set, newSrcPath is NULL
*
- * Since: v0.9.7
+ * Since: 0.9.7
* */
VIR_DOMAIN_EVENT_DISK_CHANGE_MISSING_ON_START = 0,
/* Disk was dropped from domain as source file was missing.
* oldSrcPath is set, newSrcPath is NULL
*
- * Since: v1.1.2
+ * Since: 1.1.2
* */
VIR_DOMAIN_EVENT_DISK_DROP_MISSING_ON_START = 1,
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_DISK_CHANGE_LAST /* (Since: v0.9.10) */
+ VIR_DOMAIN_EVENT_DISK_CHANGE_LAST /* (Since: 0.9.10) */
# endif
} virConnectDomainEventDiskChangeReason;
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_DISK_CHANGE with virConnectDomainEventRegisterAny()
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
typedef void (*virConnectDomainEventDiskChangeCallback)(virConnectPtr conn,
virDomainPtr dom,
*
* The reason describing why the callback was called
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef enum {
- VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, /* (Since: v0.9.11) */
- VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, /* (Since: v0.9.11) */
+ VIR_DOMAIN_EVENT_TRAY_CHANGE_OPEN = 0, /* (Since: 0.9.11) */
+ VIR_DOMAIN_EVENT_TRAY_CHANGE_CLOSE, /* (Since: 0.9.11) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST /* (Since: v0.9.11) */
+ VIR_DOMAIN_EVENT_TRAY_CHANGE_LAST /* (Since: 0.9.11) */
# endif
} virDomainEventTrayChangeReason;
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_TRAY_CHANGE with virConnectDomainEventRegisterAny()
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef void (*virConnectDomainEventTrayChangeCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_PMWAKEUP with virConnectDomainEventRegisterAny()
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef void (*virConnectDomainEventPMWakeupCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_PMSUSPEND with virConnectDomainEventRegisterAny()
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef void (*virConnectDomainEventPMSuspendCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE with virConnectDomainEventRegisterAny()
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
typedef void (*virConnectDomainEventBalloonChangeCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK with virConnectDomainEventRegisterAny()
*
- * Since: v1.0.0
+ * Since: 1.0.0
*/
typedef void (*virConnectDomainEventPMSuspendDiskCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED with virConnectDomainEventRegisterAny()
*
- * Since: v1.1.1
+ * Since: 1.1.1
*/
typedef void (*virConnectDomainEventDeviceRemovedCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_DEVICE_ADDED with virConnectDomainEventRegisterAny()
*
- * Since: v1.2.15
+ * Since: 1.2.15
*/
typedef void (*virConnectDomainEventDeviceAddedCallback)(virConnectPtr conn,
virDomainPtr dom,
* VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED with
* virConnectDomainEventRegisterAny().
*
- * Since: v1.3.4
+ * Since: 1.3.4
*/
typedef void (*virConnectDomainEventDeviceRemovalFailedCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_METADATA_CHANGE with virConnectDomainEventRegisterAny().
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
typedef void (*virConnectDomainEventMetadataChangeCallback)(virConnectPtr conn,
virDomainPtr dom,
* VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION with
* virConnectDomainEventRegisterAny().
*
- * Since: v1.3.2
+ * Since: 1.3.2
*/
typedef void (*virConnectDomainEventMigrationIterationCallback)(virConnectPtr conn,
virDomainPtr dom,
* VIR_DOMAIN_EVENT_ID_JOB_COMPLETED with
* virConnectDomainEventRegisterAny().
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
typedef void (*virConnectDomainEventJobCompletedCallback)(virConnectPtr conn,
virDomainPtr dom,
* appended to the parameter name, for example "cputune.vcpupin1",
* as VIR_TYPED_PARAM_STRING.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN "cputune.vcpupin%u"
* Macro represents formatted pinning for emulator process,
* as VIR_TYPED_PARAM_STRING.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN "cputune.emulatorpin"
* appended to the parameter name, for example "cputune.iothreadpin1",
* as VIR_TYPED_PARAM_STRING.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
# define VIR_DOMAIN_TUNABLE_CPU_IOTHREADSPIN "cputune.iothreadpin%u"
* Macro represents proportional weight of the scheduler used on the
* host cpu, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES "cputune.cpu_shares"
* Macro represents the enforcement period for a quota, in microseconds,
* for whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
# define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_PERIOD "cputune.global_period"
* Macro represents the maximum bandwidth to be used within a period for
* whole domain, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
# define VIR_DOMAIN_TUNABLE_CPU_GLOBAL_QUOTA "cputune.global_quota"
* Macro represents the enforcement period for a quota, in microseconds,
* for vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD "cputune.vcpu_period"
* Macro represents the maximum bandwidth to be used within a period for
* vcpus only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA "cputune.vcpu_quota"
* when using the posix scheduler, for all emulator activity not tied to
* vcpus, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD "cputune.emulator_period"
* all emulator activity not tied to vcpus, when using the posix scheduler,
* as an VIR_TYPED_PARAM_LLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA "cputune.emulator_quota"
* Macro represents the enforcement period for a quota, in microseconds, for
* iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
# define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_PERIOD "cputune.iothread_period"
* Macro represents the maximum bandwidth to be used within a period for
* iothreads only, when using the posix scheduler, as VIR_TYPED_PARAM_LLONG.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
# define VIR_DOMAIN_TUNABLE_CPU_IOTHREAD_QUOTA "cputune.iothread_quota"
* Macro represents the name of guest disk for which the values are updated,
* as VIR_TYPED_PARAM_STRING.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_DISK "blkdeviotune.disk"
* Macro represents the total throughput limit in bytes per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC "blkdeviotune.total_bytes_sec"
* Macro represents the read throughput limit in bytes per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC "blkdeviotune.read_bytes_sec"
* Macro represents the write throughput limit in bytes per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC "blkdeviotune.write_bytes_sec"
* Macro represents the total I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC "blkdeviotune.total_iops_sec"
* Macro represents the read I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC "blkdeviotune.read_iops_sec"
* Macro represents the write I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC "blkdeviotune.write_iops_sec"
* Macro represents the total throughput limit during bursts in
* maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX "blkdeviotune.total_bytes_sec_max"
* Macro represents the read throughput limit during bursts in
* maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX "blkdeviotune.read_bytes_sec_max"
* Macro represents the write throughput limit during bursts in
* maximum bytes per second, as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX "blkdeviotune.write_bytes_sec_max"
* Macro represents the total maximum I/O operations per second during bursts,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX "blkdeviotune.total_iops_sec_max"
* Macro represents the read maximum I/O operations per second during bursts,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX "blkdeviotune.read_iops_sec_max"
* Macro represents the write maximum I/O operations per second during bursts,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX "blkdeviotune.write_iops_sec_max"
* Macro represents the size maximum I/O operations per second,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_SIZE_IOPS_SEC "blkdeviotune.size_iops_sec"
* Macro represents the group name to be used,
* as VIR_TYPED_PARAM_STRING.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_GROUP_NAME "blkdeviotune.group_name"
* for the blkdeviotune.total_bytes_sec_max,
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC_MAX_LENGTH "blkdeviotune.total_bytes_sec_max_length"
* for the blkdeviotune.read_bytes_sec_max
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC_MAX_LENGTH "blkdeviotune.read_bytes_sec_max_length"
* for the blkdeviotune.write_bytes_sec_max
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC_MAX_LENGTH "blkdeviotune.write_bytes_sec_max_length"
* for the blkdeviotune.total_iops_sec_max
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC_MAX_LENGTH "blkdeviotune.total_iops_sec_max_length"
* for the blkdeviotune.read_iops_sec_max
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC_MAX_LENGTH "blkdeviotune.read_iops_sec_max_length"
* for the blkdeviotune.write_iops_sec_max
* as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v2.4.0
+ * Since: 2.4.0
*/
# define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC_MAX_LENGTH "blkdeviotune.write_iops_sec_max_length"
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_TUNABLE with virConnectDomainEventRegisterAny()
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
typedef void (*virConnectDomainEventTunableCallback)(virConnectPtr conn,
virDomainPtr dom,
/**
* virConnectDomainEventAgentLifecycleState:
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
typedef enum {
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected (Since: v1.2.11) */
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected (Since: v1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_CONNECTED = 1, /* agent connected (Since: 1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_DISCONNECTED = 2, /* agent disconnected (Since: 1.2.11) */
# ifdef VIR_ENUM_SENTINELS
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST /* (Since: v1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_STATE_LAST /* (Since: 1.2.11) */
# endif
} virConnectDomainEventAgentLifecycleState;
/**
* virConnectDomainEventAgentLifecycleReason:
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
typedef enum {
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason (Since: v1.2.11) */
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start (Since: v1.2.11) */
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL = 2, /* channel state changed (Since: v1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_UNKNOWN = 0, /* unknown state change reason (Since: 1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_DOMAIN_STARTED = 1, /* state changed due to domain start (Since: 1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_CHANNEL = 2, /* channel state changed (Since: 1.2.11) */
# ifdef VIR_ENUM_SENTINELS
- VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST /* (Since: v1.2.11) */
+ VIR_CONNECT_DOMAIN_EVENT_AGENT_LIFECYCLE_REASON_LAST /* (Since: 1.2.11) */
# endif
} virConnectDomainEventAgentLifecycleReason;
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE with virConnectDomainEventRegisterAny()
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
typedef void (*virConnectDomainEventAgentLifecycleCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD with virConnectDomainEventRegisterAny()
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
typedef void (*virConnectDomainEventBlockThresholdCallback)(virConnectPtr conn,
virDomainPtr dom,
* The callback signature to use when registering for an event of type
* VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE with virConnectDomainEventRegisterAny()
*
- * Since: v6.9.0
+ * Since: 6.9.0
*/
typedef void (*virConnectDomainEventMemoryFailureCallback)(virConnectPtr conn,
virDomainPtr dom,
* VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE with
* virConnectDomainEventRegisterAny().
*
- * Since: v7.9.0
+ * Since: 7.9.0
*/
typedef void (*virConnectDomainEventMemoryDeviceSizeChangeCallback)(virConnectPtr conn,
virDomainPtr dom,
* Used to cast the event specific callback into the generic one
* for use for virConnectDomainEventRegisterAny()
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
# define VIR_DOMAIN_EVENT_CALLBACK(cb) ((virConnectDomainEventGenericCallback)(cb))
* virConnectDomainEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef enum {
- VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_ID_REBOOT = 1, /* virConnectDomainEventGenericCallback (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2, /* virConnectDomainEventRTCChangeCallback (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_ID_WATCHDOG = 3, /* virConnectDomainEventWatchdogCallback (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_ID_IO_ERROR = 4, /* virConnectDomainEventIOErrorCallback (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_ID_GRAPHICS = 5, /* virConnectDomainEventGraphicsCallback (Since: v0.8.0) */
- VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6, /* virConnectDomainEventIOErrorReasonCallback (Since: v0.8.1) */
- VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7, /* virConnectDomainEventGenericCallback (Since: v0.9.2) */
- VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8, /* virConnectDomainEventBlockJobCallback (Since: v0.9.4) */
- VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9, /* virConnectDomainEventDiskChangeCallback (Since: v0.9.7) */
- VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10, /* virConnectDomainEventTrayChangeCallback (Since: v0.9.11) */
- VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11, /* virConnectDomainEventPMWakeupCallback (Since: v0.9.11) */
- VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12, /* virConnectDomainEventPMSuspendCallback (Since: v0.9.11) */
- VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13, /* virConnectDomainEventBalloonChangeCallback (Since: v0.10.0) */
- VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14, /* virConnectDomainEventPMSuspendDiskCallback (Since: v1.0.0) */
- VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15, /* virConnectDomainEventDeviceRemovedCallback (Since: v1.1.1) */
- VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16, /* virConnectDomainEventBlockJobCallback (Since: v1.2.6) */
- VIR_DOMAIN_EVENT_ID_TUNABLE = 17, /* virConnectDomainEventTunableCallback (Since: v1.2.9) */
- VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE = 18,/* virConnectDomainEventAgentLifecycleCallback (Since: v1.2.11) */
- VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19, /* virConnectDomainEventDeviceAddedCallback (Since: v1.2.15) */
- VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20, /* virConnectDomainEventMigrationIterationCallback (Since: v1.3.2) */
- VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21, /* virConnectDomainEventJobCompletedCallback (Since: v1.3.3) */
- VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22, /* virConnectDomainEventDeviceRemovalFailedCallback (Since: v1.3.4) */
- VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23, /* virConnectDomainEventMetadataChangeCallback (Since: v3.0.0) */
- VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD = 24, /* virConnectDomainEventBlockThresholdCallback (Since: v3.2.0) */
- VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE = 25, /* virConnectDomainEventMemoryFailureCallback (Since: v6.9.0) */
- VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE = 26, /* virConnectDomainEventMemoryDeviceSizeChangeCallback (Since: v7.9.0) */
+ VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0, /* virConnectDomainEventCallback (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_ID_REBOOT = 1, /* virConnectDomainEventGenericCallback (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2, /* virConnectDomainEventRTCChangeCallback (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_ID_WATCHDOG = 3, /* virConnectDomainEventWatchdogCallback (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_ID_IO_ERROR = 4, /* virConnectDomainEventIOErrorCallback (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_ID_GRAPHICS = 5, /* virConnectDomainEventGraphicsCallback (Since: 0.8.0) */
+ VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6, /* virConnectDomainEventIOErrorReasonCallback (Since: 0.8.1) */
+ VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7, /* virConnectDomainEventGenericCallback (Since: 0.9.2) */
+ VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8, /* virConnectDomainEventBlockJobCallback (Since: 0.9.4) */
+ VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9, /* virConnectDomainEventDiskChangeCallback (Since: 0.9.7) */
+ VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10, /* virConnectDomainEventTrayChangeCallback (Since: 0.9.11) */
+ VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11, /* virConnectDomainEventPMWakeupCallback (Since: 0.9.11) */
+ VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12, /* virConnectDomainEventPMSuspendCallback (Since: 0.9.11) */
+ VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13, /* virConnectDomainEventBalloonChangeCallback (Since: 0.10.0) */
+ VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14, /* virConnectDomainEventPMSuspendDiskCallback (Since: 1.0.0) */
+ VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED = 15, /* virConnectDomainEventDeviceRemovedCallback (Since: 1.1.1) */
+ VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 = 16, /* virConnectDomainEventBlockJobCallback (Since: 1.2.6) */
+ VIR_DOMAIN_EVENT_ID_TUNABLE = 17, /* virConnectDomainEventTunableCallback (Since: 1.2.9) */
+ VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE = 18,/* virConnectDomainEventAgentLifecycleCallback (Since: 1.2.11) */
+ VIR_DOMAIN_EVENT_ID_DEVICE_ADDED = 19, /* virConnectDomainEventDeviceAddedCallback (Since: 1.2.15) */
+ VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION = 20, /* virConnectDomainEventMigrationIterationCallback (Since: 1.3.2) */
+ VIR_DOMAIN_EVENT_ID_JOB_COMPLETED = 21, /* virConnectDomainEventJobCompletedCallback (Since: 1.3.3) */
+ VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED = 22, /* virConnectDomainEventDeviceRemovalFailedCallback (Since: 1.3.4) */
+ VIR_DOMAIN_EVENT_ID_METADATA_CHANGE = 23, /* virConnectDomainEventMetadataChangeCallback (Since: 3.0.0) */
+ VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD = 24, /* virConnectDomainEventBlockThresholdCallback (Since: 3.2.0) */
+ VIR_DOMAIN_EVENT_ID_MEMORY_FAILURE = 25, /* virConnectDomainEventMemoryFailureCallback (Since: 6.9.0) */
+ VIR_DOMAIN_EVENT_ID_MEMORY_DEVICE_SIZE_CHANGE = 26, /* virConnectDomainEventMemoryDeviceSizeChangeCallback (Since: 7.9.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_DOMAIN_EVENT_ID_LAST
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
# endif
} virDomainEventID;
/**
* virDomainConsoleFlags:
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
typedef enum {
VIR_DOMAIN_CONSOLE_FORCE = (1 << 0), /* abort a (possibly) active console
connection to force a new
- connection (Since: v0.9.11) */
+ connection (Since: 0.9.11) */
VIR_DOMAIN_CONSOLE_SAFE = (1 << 1), /* check if the console driver supports
- safe console operations (Since: v0.9.11) */
+ safe console operations (Since: 0.9.11) */
} virDomainConsoleFlags;
int virDomainOpenConsole(virDomainPtr dom,
/**
* virDomainChannelFlags:
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
typedef enum {
VIR_DOMAIN_CHANNEL_FORCE = (1 << 0), /* abort a (possibly) active channel
connection to force a new
- connection (Since: v1.0.2) */
+ connection (Since: 1.0.2) */
} virDomainChannelFlags;
int virDomainOpenChannel(virDomainPtr dom,
/**
* virDomainOpenGraphicsFlags:
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
typedef enum {
- VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), /* (Since: v0.9.7) */
+ VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH = (1 << 0), /* (Since: 0.9.7) */
} virDomainOpenGraphicsFlags;
int virDomainOpenGraphics(virDomainPtr dom,
*
* The data structure containing mounted file systems within a guset
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
typedef struct _virDomainFSInfo virDomainFSInfo;
/**
* virDomainFSInfoPtr:
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
typedef virDomainFSInfo *virDomainFSInfoPtr;
/**
* virDomainSetTimeFlags:
*
- * Since: v1.2.5
+ * Since: 1.2.5
*/
typedef enum {
- VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC (Since: v1.2.5) */
+ VIR_DOMAIN_TIME_SYNC = (1 << 0), /* Re-sync domain time from domain's RTC (Since: 1.2.5) */
} virDomainSetTimeFlags;
int virDomainSetTime(virDomainPtr dom,
* A scheduler parameter field type. Provided for backwards
* compatibility; virTypedParameterType is the preferred enum
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
typedef enum {
- VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.2.3) */
- VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.2.3) */
- VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.2.3) */
- VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.2.3) */
- VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.2.3) */
- VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.2.3) */
+ VIR_DOMAIN_SCHED_FIELD_INT = VIR_TYPED_PARAM_INT, /* (Since: 0.2.3) */
+ VIR_DOMAIN_SCHED_FIELD_UINT = VIR_TYPED_PARAM_UINT, /* (Since: 0.2.3) */
+ VIR_DOMAIN_SCHED_FIELD_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: 0.2.3) */
+ VIR_DOMAIN_SCHED_FIELD_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: 0.2.3) */
+ VIR_DOMAIN_SCHED_FIELD_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: 0.2.3) */
+ VIR_DOMAIN_SCHED_FIELD_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: 0.2.3) */
} virSchedParameterType;
/**
* for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the
* preferred value
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
# define VIR_DOMAIN_SCHED_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
/**
* _virSchedParameter:
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
# define _virSchedParameter _virTypedParameter
* Provided for backwards compatibility; virTypedParameter is the
* preferred alias.
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
typedef struct _virTypedParameter virSchedParameter;
* Provided for backwards compatibility; virTypedParameterPtr is the
* preferred alias since 0.9.2.
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
typedef virSchedParameter *virSchedParameterPtr;
* A blkio parameter field type. Provided for backwards
* compatibility; virTypedParameterType is the preferred enum
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
typedef enum {
- VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.9.0) */
- VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.9.0) */
- VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.9.0) */
- VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.9.0) */
- VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.9.0) */
- VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.9.0) */
+ VIR_DOMAIN_BLKIO_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: 0.9.0) */
+ VIR_DOMAIN_BLKIO_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: 0.9.0) */
+ VIR_DOMAIN_BLKIO_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: 0.9.0) */
+ VIR_DOMAIN_BLKIO_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: 0.9.0) */
+ VIR_DOMAIN_BLKIO_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: 0.9.0) */
+ VIR_DOMAIN_BLKIO_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: 0.9.0) */
} virBlkioParameterType;
/**
* for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the
* preferred value.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
# define VIR_DOMAIN_BLKIO_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
/**
* _virBlkioParameter:
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
# define _virBlkioParameter _virTypedParameter
* Provided for backwards compatibility; virTypedParameter is the
* preferred alias.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
typedef struct _virTypedParameter virBlkioParameter;
* Provided for backwards compatibility; virTypedParameterPtr is the
* preferred alias.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
typedef virBlkioParameter *virBlkioParameterPtr;
* A memory parameter field type. Provided for backwards
* compatibility; virTypedParameterType is the preferred enum
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
typedef enum {
- VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: v0.8.5) */
- VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: v0.8.5) */
- VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: v0.8.5) */
- VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: v0.8.5) */
- VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: v0.8.5) */
- VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: v0.8.5) */
+ VIR_DOMAIN_MEMORY_PARAM_INT = VIR_TYPED_PARAM_INT, /* (Since: 0.8.5) */
+ VIR_DOMAIN_MEMORY_PARAM_UINT = VIR_TYPED_PARAM_UINT, /* (Since: 0.8.5) */
+ VIR_DOMAIN_MEMORY_PARAM_LLONG = VIR_TYPED_PARAM_LLONG, /* (Since: 0.8.5) */
+ VIR_DOMAIN_MEMORY_PARAM_ULLONG = VIR_TYPED_PARAM_ULLONG, /* (Since: 0.8.5) */
+ VIR_DOMAIN_MEMORY_PARAM_DOUBLE = VIR_TYPED_PARAM_DOUBLE, /* (Since: 0.8.5) */
+ VIR_DOMAIN_MEMORY_PARAM_BOOLEAN = VIR_TYPED_PARAM_BOOLEAN, /* (Since: 0.8.5) */
} virMemoryParameterType;
/**
* for backwards compatibility; VIR_TYPED_PARAM_FIELD_LENGTH is the
* preferred value.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
# define VIR_DOMAIN_MEMORY_FIELD_LENGTH VIR_TYPED_PARAM_FIELD_LENGTH
/**
* _virMemoryParameter:
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
# define _virMemoryParameter _virTypedParameter
* Provided for backwards compatibility; virTypedParameter is the
* preferred alias.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
typedef struct _virTypedParameter virMemoryParameter;
* Provided for backwards compatibility; virTypedParameterPtr is the
* preferred alias.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
typedef virMemoryParameter *virMemoryParameterPtr;
/**
* virDomainInterfaceAddressesSource:
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef enum {
- VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file (Since: v1.2.14) */
- VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent (Since: v1.2.14) */
- VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP = 2, /* Query ARP tables (Since: v4.2.0) */
+ VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LEASE = 0, /* Parse DHCP lease file (Since: 1.2.14) */
+ VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT = 1, /* Query qemu guest agent (Since: 1.2.14) */
+ VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_ARP = 2, /* Query ARP tables (Since: 4.2.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST /* (Since: v1.2.14) */
+ VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_LAST /* (Since: 1.2.14) */
# endif
} virDomainInterfaceAddressesSource;
/**
* virDomainIPAddress:
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef struct _virDomainInterfaceIPAddress virDomainIPAddress;
/**
* virDomainIPAddressPtr:
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef virDomainIPAddress *virDomainIPAddressPtr;
struct _virDomainInterfaceIPAddress {
/**
* virDomainInterface:
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef struct _virDomainInterface virDomainInterface;
/**
* virDomainInterfacePtr:
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
typedef virDomainInterface *virDomainInterfacePtr;
struct _virDomainInterface {
/**
* virDomainSetUserPasswordFlags:
*
- * Since: v1.2.16
+ * Since: 1.2.16
*/
typedef enum {
- VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted (Since: v1.2.16) */
+ VIR_DOMAIN_PASSWORD_ENCRYPTED = 1 << 0, /* the password is already encrypted (Since: 1.2.16) */
} virDomainSetUserPasswordFlags;
int virDomainSetUserPassword(virDomainPtr dom,
/**
* virDomainLifecycle:
*
- * Since: v3.9.0
+ * Since: 3.9.0
*/
typedef enum {
- VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_REBOOT = 1, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_CRASH = 2, /* (Since: v3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_POWEROFF = 0, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_REBOOT = 1, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_CRASH = 2, /* (Since: 3.9.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_LIFECYCLE_LAST /* (Since: v3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_LAST /* (Since: 3.9.0) */
# endif
} virDomainLifecycle;
/**
* virDomainLifecycleAction:
*
- * Since: v3.9.0
+ * Since: 3.9.0
*/
typedef enum {
- VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME = 2, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE = 3, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY = 4, /* (Since: v3.9.0) */
- VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART = 5, /* (Since: v3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_DESTROY = 0, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_RESTART = 1, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_RESTART_RENAME = 2, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_PRESERVE = 3, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_DESTROY = 4, /* (Since: 3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_COREDUMP_RESTART = 5, /* (Since: 3.9.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_LIFECYCLE_ACTION_LAST /* (Since: v3.9.0) */
+ VIR_DOMAIN_LIFECYCLE_ACTION_LAST /* (Since: 3.9.0) */
# endif
} virDomainLifecycleAction;
* Macro represents the launch measurement of the SEV guest,
* as VIR_TYPED_PARAM_STRING.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_MEASUREMENT "sev-measurement"
* Macro represents the API major version of the SEV host,
* as VIR_TYPED_PARAM_UINT.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MAJOR "sev-api-major"
* Macro represents the API minor version of the SEV guest,
* as VIR_TYPED_PARAM_UINT.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_API_MINOR "sev-api-minor"
* Macro represents the build ID of the SEV host,
* as VIR_TYPED_PARAM_UINT.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_BUILD_ID "sev-build-id"
* Macro represents the policy of the SEV guest,
* as VIR_TYPED_PARAM_UINT.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_POLICY "sev-policy"
* section "6.6 LAUNCH_SECRET" in the SEV API specification for a detailed
* description of the secret header.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_HEADER "sev-secret-header"
* secret. The secret is created by the domain owner after the SEV launch
* measurement is retrieved and verified.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET "sev-secret"
* where the secret will be set, as VIR_TYPED_PARAM_ULLONG. If not specified,
* the address will be determined by the hypervisor.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_DOMAIN_LAUNCH_SECURITY_SEV_SECRET_SET_ADDRESS "sev-secret-set-address"
/**
* virDomainGuestInfoTypes:
*
- * Since: v5.7.0
+ * Since: 5.7.0
*/
typedef enum {
- VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users (Since: v5.7.0) */
- VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information (Since: v5.7.0) */
- VIR_DOMAIN_GUEST_INFO_TIMEZONE = (1 << 2), /* return timezone information (Since: v5.7.0) */
- VIR_DOMAIN_GUEST_INFO_HOSTNAME = (1 << 3), /* return hostname information (Since: v5.7.0) */
- VIR_DOMAIN_GUEST_INFO_FILESYSTEM = (1 << 4), /* return filesystem information (Since: v5.7.0) */
- VIR_DOMAIN_GUEST_INFO_DISKS = (1 << 5), /* return disks information (Since: v7.0.0) */
- VIR_DOMAIN_GUEST_INFO_INTERFACES = (1 << 6), /* return interfaces information (Since: v7.10.0) */
+ VIR_DOMAIN_GUEST_INFO_USERS = (1 << 0), /* return active users (Since: 5.7.0) */
+ VIR_DOMAIN_GUEST_INFO_OS = (1 << 1), /* return OS information (Since: 5.7.0) */
+ VIR_DOMAIN_GUEST_INFO_TIMEZONE = (1 << 2), /* return timezone information (Since: 5.7.0) */
+ VIR_DOMAIN_GUEST_INFO_HOSTNAME = (1 << 3), /* return hostname information (Since: 5.7.0) */
+ VIR_DOMAIN_GUEST_INFO_FILESYSTEM = (1 << 4), /* return filesystem information (Since: 5.7.0) */
+ VIR_DOMAIN_GUEST_INFO_DISKS = (1 << 5), /* return disks information (Since: 7.0.0) */
+ VIR_DOMAIN_GUEST_INFO_INTERFACES = (1 << 6), /* return interfaces information (Since: 7.10.0) */
} virDomainGuestInfoTypes;
int virDomainGetGuestInfo(virDomainPtr domain,
/**
* virDomainAgentResponseTimeoutValues:
*
- * Since: v5.10.0
+ * Since: 5.10.0
*/
typedef enum {
- VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, /* (Since: v5.10.0) */
- VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, /* (Since: v5.10.0) */
- VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT = 0, /* (Since: v5.10.0) */
+ VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK = -2, /* (Since: 5.10.0) */
+ VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT = -1, /* (Since: 5.10.0) */
+ VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT = 0, /* (Since: 5.10.0) */
} virDomainAgentResponseTimeoutValues;
int virDomainAgentSetResponseTimeout(virDomainPtr domain,
/**
* virDomainBackupBeginFlags:
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
typedef enum {
VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL = (1 << 0), /* reuse separately
- provided images (Since: v6.0.0) */
+ provided images (Since: 6.0.0) */
} virDomainBackupBeginFlags;
int virDomainBackupBegin(virDomainPtr domain,
/**
* virDomainAuthorizedSSHKeysSetFlags:
*
- * Since: v6.10.0
+ * Since: 6.10.0
*/
typedef enum {
- VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND = (1 << 0), /* don't truncate file, just append (Since: v6.10.0) */
- VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE = (1 << 1), /* remove keys, instead of adding them (Since: v6.10.0) */
+ VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND = (1 << 0), /* don't truncate file, just append (Since: 6.10.0) */
+ VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE = (1 << 1), /* remove keys, instead of adding them (Since: 6.10.0) */
} virDomainAuthorizedSSHKeysSetFlags;
/**
* virDomainMessageType:
*
- * Since: v7.1.0
+ * Since: 7.1.0
*/
typedef enum {
- VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), /* (Since: v7.1.0) */
- VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), /* (Since: v7.1.0) */
+ VIR_DOMAIN_MESSAGE_DEPRECATION = (1 << 0), /* (Since: 7.1.0) */
+ VIR_DOMAIN_MESSAGE_TAINTING = (1 << 1), /* (Since: 7.1.0) */
} virDomainMessageType;
int virDomainGetMessages(virDomainPtr domain,
*
* Details on the cause of a dirty rate calculation status.
*
- * Since: v7.2.0
+ * Since: 7.2.0
*/
typedef enum {
VIR_DOMAIN_DIRTYRATE_UNSTARTED = 0, /* the dirtyrate calculation has
- not been started (Since: v7.2.0) */
+ not been started (Since: 7.2.0) */
VIR_DOMAIN_DIRTYRATE_MEASURING = 1, /* the dirtyrate calculation is
- measuring (Since: v7.2.0) */
+ measuring (Since: 7.2.0) */
VIR_DOMAIN_DIRTYRATE_MEASURED = 2, /* the dirtyrate calculation is
- completed (Since: v7.2.0) */
+ completed (Since: 7.2.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_DOMAIN_DIRTYRATE_LAST /* (Since: v7.2.0) */
+ VIR_DOMAIN_DIRTYRATE_LAST /* (Since: 7.2.0) */
# endif
} virDomainDirtyRateStatus;
* rate for a Domain
*
*
- * Since: v8.1.0
+ * Since: 8.1.0
*/
typedef enum {
- VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling (Since: v8.1.0) */
- VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP = 1 << 0, /* dirty-bitmap mode (Since: v8.1.0) */
- VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING = 1 << 1, /* dirty-ring mode (Since: v8.1.0) */
+ VIR_DOMAIN_DIRTYRATE_MODE_PAGE_SAMPLING = 0, /* default mode - page-sampling (Since: 8.1.0) */
+ VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_BITMAP = 1 << 0, /* dirty-bitmap mode (Since: 8.1.0) */
+ VIR_DOMAIN_DIRTYRATE_MODE_DIRTY_RING = 1 << 1, /* dirty-ring mode (Since: 8.1.0) */
} virDomainDirtyRateCalcFlags;
int virDomainStartDirtyRateCalc(virDomainPtr domain,
* to libvirt. A client app must translate to, and from POLL events when using
* this construct.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef enum {
- VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: v0.5.0) */
- VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: v0.5.0) */
- VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: v0.5.0) */
- VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: v0.5.0) */
+ VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: 0.5.0) */
+ VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: 0.5.0) */
+ VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: 0.5.0) */
+ VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: 0.5.0) */
} virEventHandleType;
/**
* Callback for receiving file handle events. The callback will
* be invoked once for each event which is pending.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef void (*virEventHandleCallback)(int watch, int fd, int events, void *opaque);
* Returns -1 if the file handle cannot be registered, otherwise a handle
* watch number to be used for updating and unregistering for events
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef int (*virEventAddHandleFunc)(int fd, int event,
virEventHandleCallback cb,
* Part of the EventImpl, this user-provided callback is notified when
* events to listen on change
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef void (*virEventUpdateHandleFunc)(int watch, int event);
*
* Returns -1 if the file handle was not registered, 0 upon success
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef int (*virEventRemoveHandleFunc)(int watch);
*
* callback for receiving timer events
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef void (*virEventTimeoutCallback)(int timer, void *opaque);
*
* Returns a timer value
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef int (*virEventAddTimeoutFunc)(int timeout,
virEventTimeoutCallback cb,
* Part of the EventImpl, this user-defined callback updates an
* event timeout.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef void (*virEventUpdateTimeoutFunc)(int timer, int timeout);
*
* Returns 0 on success, -1 on failure
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef int (*virEventRemoveTimeoutFunc)(int timer);
* a virConnect is a private structure representing a connection to
* the Hypervisor.
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
typedef struct _virConnect virConnect;
* a virConnectPtr is pointer to a virConnect private structure, this is the
* type used to reference a connection to the Hypervisor in the API.
*
- * Since: v0.0.1
+ * Since: 0.0.1
*/
typedef virConnect *virConnectPtr;
* Flags to indicate which system-wide sleep state the host must be
* transitioned to.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
typedef enum {
- VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: v0.9.8) */
- VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: v0.9.8) */
- VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: v0.9.8) */
+ VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: 0.9.8) */
+ VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: 0.9.8) */
+ VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: 0.9.8) */
# ifdef VIR_ENUM_SENTINELS
- VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: v0.9.8) */
+ VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: 0.9.8) */
# endif
} virNodeSuspendTarget;
*
* a virStream is a private structure representing a data stream.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef struct _virStream virStream;
* a virStreamPtr is pointer to a virStream private structure, this is the
* type used to reference a data stream in the API.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef virStream *virStreamPtr;
* Macro providing the maximum length of the virSecurityLabel label string.
* Note that this value is based on that used by Labeled NFS.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
# define VIR_SECURITY_LABEL_BUFLEN (4096 + 1)
* providing the security label and associated attributes for the specified
* domain.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
typedef struct _virSecurityLabel virSecurityLabel;
*
* a virSecurityLabelPtr is a pointer to a virSecurityLabel.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
typedef virSecurityLabel *virSecurityLabelPtr;
*
* Macro providing the maximum length of the virSecurityModel model string.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
# define VIR_SECURITY_MODEL_BUFLEN (256 + 1)
*
* Macro providing the maximum length of the virSecurityModel doi string.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
# define VIR_SECURITY_DOI_BUFLEN (256 + 1)
* providing the per-hypervisor security model and DOI attributes for the
* specified domain.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
typedef struct _virSecurityModel virSecurityModel;
*
* a virSecurityModelPtr is a pointer to a virSecurityModel.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
typedef virSecurityModel *virSecurityModelPtr;
* accurate relection of the system hardware. See the virNodeGetInfo()
* API documentation for further guidance.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef struct _virNodeInfo virNodeInfo;
*
* Macro providing the field length of virNodeCPUStats
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_FIELD_LENGTH 80
*
* Value for specifying request for the total CPU time/utilization
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
typedef enum {
- VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: v0.9.3) */
+ VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: 0.9.3) */
} virNodeGetCPUStatsAllCPUs;
/**
* Macro for the cumulative CPU time which was spent by the kernel,
* since the node booting up (in nanoseconds).
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_KERNEL "kernel"
* The cumulative CPU time which was spent by user processes,
* since the node booting up (in nanoseconds).
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_USER "user"
* The cumulative idle CPU time,
* since the node booting up (in nanoseconds).
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_IDLE "idle"
* The cumulative I/O wait CPU time,
* since the node booting up (in nanoseconds).
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_IOWAIT "iowait"
* The cumulative interrupt CPU time,
* since the node booting up (in nanoseconds).
*
- * Since: v1.2.2
+ * Since: 1.2.2
*/
# define VIR_NODE_CPU_STATS_INTR "intr"
* The usage value is in percent and 100% represents all CPUs of
* the node.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_UTILIZATION "utilization"
* a virNodeCPUStats is a structure filled by virNodeGetCPUStats()
* providing information about the CPU stats of the node.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef struct _virNodeCPUStats virNodeCPUStats;
*
* Macro providing the field length of virNodeMemoryStats
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_FIELD_LENGTH 80
*
* Value for specifying request for the total memory of all cells.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
typedef enum {
- VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: v0.9.3) */
+ VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: 0.9.3) */
} virNodeGetMemoryStatsAllCells;
/**
* Macro for the total memory of specified cell:
* it represents the maximum memory.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_TOTAL "total"
* On Linux, it includes buffer and cached memory, in case of
* VIR_NODE_MEMORY_STATS_ALL_CELLS.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_FREE "free"
* Macro for the buffer memory: On Linux, it is only returned in case of
* VIR_NODE_MEMORY_STATS_ALL_CELLS.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_BUFFERS "buffers"
* Macro for the cached memory: On Linux, it is only returned in case of
* VIR_NODE_MEMORY_STATS_ALL_CELLS.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_CACHED "cached"
* a virNodeMemoryStats is a structure filled by virNodeGetMemoryStats()
* providing information about the memory of the node.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef struct _virNodeMemoryStats virNodeMemoryStats;
* Macro for typed parameter that represents how many present pages
* to scan before the shared memory service goes to sleep.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_TO_SCAN "shm_pages_to_scan"
* Macro for typed parameter that represents how many milliseconds
* the shared memory service should sleep before next scan.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_SLEEP_MILLISECS "shm_sleep_millisecs"
* Macro for typed parameter that represents how many the shared
* memory pages are being used.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_SHARED "shm_pages_shared"
* Macro for typed parameter that represents how many sites are
* sharing the pages i.e. how much saved.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_SHARING "shm_pages_sharing"
* Macro for typed parameter that represents how many pages unique
* but repeatedly checked for merging.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_UNSHARED "shm_pages_unshared"
* Macro for typed parameter that represents how many pages changing
* too fast to be placed in a tree.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_VOLATILE "shm_pages_volatile"
* Macro for typed parameter that represents how many times all
* mergeable areas have been scanned.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_FULL_SCANS "shm_full_scans"
* pages from all nodes can be merged. Other values are reserved
* for future use.
*
- * Since: v1.0.0
+ * Since: 1.0.0
*/
# define VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES "shm_merge_across_nodes"
* This macro is to calculate the total number of CPUs supported
* but not necessary active in the host.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
# define VIR_NODEINFO_MAXCPUS(nodeinfo) ((nodeinfo).nodes*(nodeinfo).sockets*(nodeinfo).cores*(nodeinfo).threads)
*
* a virNodeInfoPtr is a pointer to a virNodeInfo structure.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef virNodeInfo *virNodeInfoPtr;
*
* a virNodeCPUStatsPtr is a pointer to a virNodeCPUStats structure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef virNodeCPUStats *virNodeCPUStatsPtr;
*
* a virNodeMemoryStatsPtr is a pointer to a virNodeMemoryStats structure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
*
* Macro represents the Platform Diffie-Hellman key, as VIR_TYPED_PARAMS_STRING.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
# define VIR_NODE_SEV_PDH "pdh"
* endorsement key (PEK), owner certificate authority (OCD) and chip
* endorsement key (CEK), as VIR_TYPED_PARAMS_STRING.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
# define VIR_NODE_SEV_CERT_CHAIN "cert-chain"
*
* Macro represents the CBit Position used by hypervisor when SEV is enabled.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
# define VIR_NODE_SEV_CBITPOS "cbitpos"
* Macro represents the number of bits we lose in physical address space
* when SEV is enabled in the guest.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
# define VIR_NODE_SEV_REDUCED_PHYS_BITS "reduced-phys-bits"
* Macro represents the number of SEV guests that can
* be run on the host, as a VIR_TYPED_PARAM_UINT.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_NODE_SEV_MAX_GUESTS "max-guests"
* Macro represents the number of SEV-ES guests that can
* be run on the host, as a VIR_TYPED_PARAM_UINT.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
# define VIR_NODE_SEV_MAX_ES_GUESTS "max-es-guests"
*
* Flags when opening a connection to a hypervisor
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: v0.4.1) */
- VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: v0.9.7) */
+ VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: 0.4.1) */
+ VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: 0.9.7) */
} virConnectFlags;
/**
* virConnectCredentialType:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_CRED_USERNAME = 1, /* Identity to act as (Since: v0.4.1) */
- VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: v0.4.1) */
- VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: v0.4.1) */
- VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: v0.4.1) */
- VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: v0.4.1) */
- VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: v0.4.1) */
- VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: v0.4.1) */
- VIR_CRED_REALM = 8, /* Authentication realm (Since: v0.4.1) */
- VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: v0.4.1) */
+ VIR_CRED_USERNAME = 1, /* Identity to act as (Since: 0.4.1) */
+ VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: 0.4.1) */
+ VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: 0.4.1) */
+ VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: 0.4.1) */
+ VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: 0.4.1) */
+ VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: 0.4.1) */
+ VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: 0.4.1) */
+ VIR_CRED_REALM = 8, /* Authentication realm (Since: 0.4.1) */
+ VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: 0.4.1) */
# ifdef VIR_ENUM_SENTINELS
- VIR_CRED_LAST /* More may be added - expect the unexpected (Since: v0.9.10) */
+ VIR_CRED_LAST /* More may be added - expect the unexpected (Since: 0.9.10) */
# endif
} virConnectCredentialType;
/**
* virConnectCredential:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef struct _virConnectCredential virConnectCredential;
/**
* virConnectCredentialPtr:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef virConnectCredential *virConnectCredentialPtr;
*
* Returns 0 if all interactions were filled, or -1 upon error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef int (*virConnectAuthCallbackPtr)(virConnectCredentialPtr cred,
unsigned int ncred,
/**
* virConnectAuth:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef struct _virConnectAuth virConnectAuth;
/**
* virConnectAuthPtr:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef virConnectAuth *virConnectAuthPtr;
* suitable for the application's needs an alternative implementation
* should be provided.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault;
* This macro provides the length of the buffer required
* for virDomainGetUUID()
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
# define VIR_UUID_BUFLEN (16)
* This macro provides the length of the buffer required
* for virDomainGetUUIDString()
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
# define VIR_UUID_STRING_BUFLEN (36+1)
*
* The operating system user name as VIR_TYPED_PARAM_STRING.
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_USER_NAME "user-name"
*
* The UNIX user ID as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_UNIX_USER_ID "unix-user-id"
*
* The operating system group name as VIR_TYPED_PARAM_STRING.
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_GROUP_NAME "group-name"
*
* The UNIX group ID as VIR_TYPED_PARAM_ULLONG.
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_UNIX_GROUP_ID "unix-group-id"
*
* The operating system process ID as VIR_TYPED_PARAM_LLONG.
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_PROCESS_ID "process-id"
* host operating system. On Linux this is usually clock
* ticks (as reported in /proc/$PID/stat field 22).
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_PROCESS_TIME "process-time"
*
* The SASL authenticated username as VIR_TYPED_PARAM_STRING
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_SASL_USER_NAME "sasl-user-name"
*
* The TLS x509 certificate distinguished named as VIR_TYPED_PARAM_STRING
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_X509_DISTINGUISHED_NAME "x509-distinguished-name"
*
* The application's SELinux context as VIR_TYPED_PARAM_STRING.
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_SELINUX_CONTEXT "selinux-context"
* A callback function to be registered, and called when the connection
* is closed.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
typedef void (*virConnectCloseFunc)(virConnectPtr conn,
int reason,
/**
* virCPUCompareResult:
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
typedef enum {
- VIR_CPU_COMPARE_ERROR = -1, /* (Since: v0.7.5) */
- VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: v0.7.5) */
- VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: v0.7.5) */
- VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: v0.7.5) */
+ VIR_CPU_COMPARE_ERROR = -1, /* (Since: 0.7.5) */
+ VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: 0.7.5) */
+ VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: 0.7.5) */
+ VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: 0.7.5) */
# ifdef VIR_ENUM_SENTINELS
- VIR_CPU_COMPARE_LAST /* (Since: v0.9.10) */
+ VIR_CPU_COMPARE_LAST /* (Since: 0.9.10) */
# endif
} virCPUCompareResult;
/**
* virConnectCompareCPUFlags:
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
typedef enum {
VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE = (1 << 0), /* treat incompatible
- CPUs as failure (Since: v1.2.6) */
+ CPUs as failure (Since: 1.2.6) */
VIR_CONNECT_COMPARE_CPU_VALIDATE_XML = (1 << 1), /* validate the xml
- document (Since: v6.9.0) */
+ document (Since: 6.9.0) */
} virConnectCompareCPUFlags;
int virConnectCompareCPU(virConnectPtr conn,
*
* Flags when getting XML description of a computed CPU
*
- * Since: v1.1.2
+ * Since: 1.1.2
*/
typedef enum {
- VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: v1.1.2) */
- VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: v1.2.14) */
+ VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: 1.1.2) */
+ VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: 1.2.14) */
} virConnectBaselineCPUFlags;
char *virConnectBaselineCPU(virConnectPtr conn,
/**
* virNodeAllocPagesFlags:
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
typedef enum {
VIR_NODE_ALLOC_PAGES_ADD = 0, /* Add @pageCounts to the pages pool. This
- can be used only to size up the pool. (Since: v1.2.9) */
+ can be used only to size up the pool. (Since: 1.2.9) */
VIR_NODE_ALLOC_PAGES_SET = (1 << 0), /* Don't add @pageCounts, instead set
passed number of pages. This can be
- used to free allocated pages. (Since: v1.2.9) */
+ used to free allocated pages. (Since: 1.2.9) */
} virNodeAllocPagesFlags;
int virNodeAllocPages(virConnectPtr conn,
*
* a virInterface is a private structure representing a virtual interface.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
typedef struct _virInterface virInterface;
* a virInterfacePtr is pointer to a virInterface private structure, this is the
* type used to reference a virtual interface in the API.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
typedef virInterface *virInterfacePtr;
*
* Flags used to filter the returned interfaces.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: v0.10.2) */
+ VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: 0.10.2) */
} virConnectListAllInterfacesFlags;
int virConnectListAllInterfaces (virConnectPtr conn,
/**
* virInterfaceXMLFlags:
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
typedef enum {
- VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: v0.7.3) */
+ VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: 0.7.3) */
} virInterfaceXMLFlags;
/**
* virInterfaceDefineFlags:
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
typedef enum {
- VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
+ VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virInterfaceDefineFlags;
char * virInterfaceGetXMLDesc (virInterfacePtr iface,
/**
* virNetworkXMLFlags:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: v0.9.10) */
+ VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: 0.9.10) */
} virNetworkXMLFlags;
/**
*
* a virNetwork is a private structure representing a virtual network.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
typedef struct _virNetwork virNetwork;
* a virNetworkPtr is pointer to a virNetwork private structure, this is the
* type used to reference a virtual network in the API.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
typedef virNetwork *virNetworkPtr;
* a virNetworkPort is a private structure representing a virtual network
* port
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
typedef struct _virNetworkPort virNetworkPort;
* a virNetworkPortPtr is pointer to a virNetworkPort private structure,
* this is the type used to reference a virtual network port in the API.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
typedef virNetworkPort *virNetworkPortPtr;
* Flags used to filter the returned networks. Flags in each group
* are exclusive attributes of a network.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */
+ VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: 0.10.2) */
- VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */
+ VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: 0.10.2) */
- VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */
+ VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: 0.10.2) */
} virConnectListAllNetworksFlags;
int virConnectListAllNetworks (virConnectPtr conn,
/**
* virNetworkCreateFlags:
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
typedef enum {
- VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */
+ VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.8.0) */
} virNetworkCreateFlags;
/*
/**
* virNetworkDefineFlags:
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
typedef enum {
- VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
+ VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virNetworkDefineFlags;
/*
* describes which type of update to perform on a <network>
* definition.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: v0.10.2) */
- VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: v0.10.2) */
- VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: v0.10.2) */
- VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: v0.10.2) */
- VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: v0.10.2) */
+ VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: 0.10.2) */
+ VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: 0.10.2) */
+ VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: 0.10.2) */
+ VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: 0.10.2) */
+ VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: 0.10.2) */
# ifdef VIR_ENUM_SENTINELS
- VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: v0.10.2) */
+ VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: 0.10.2) */
# endif
} virNetworkUpdateCommand;
* describes which section of a <network> definition the provided
* xml should be applied to.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: v0.10.2) */
- VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: v0.10.2) */
- VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: v0.10.2) */
+ VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: 0.10.2) */
+ VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: 0.10.2) */
# ifdef VIR_ENUM_SENTINELS
- VIR_NETWORK_SECTION_LAST /* (Since: v0.10.2) */
+ VIR_NETWORK_SECTION_LAST /* (Since: 0.10.2) */
# endif
} virNetworkUpdateSection;
*
* Flags to control options for virNetworkUpdate()
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
VIR_NETWORK_UPDATE_AFFECT_CURRENT = 0, /* affect live if network is active,
- config if it's not active (Since: v0.10.2) */
- VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: v0.10.2) */
- VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: v0.10.2) */
+ config if it's not active (Since: 0.10.2) */
+ VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: 0.10.2) */
+ VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: 0.10.2) */
} virNetworkUpdateFlags;
/*
*
* a virNetworkEventLifecycleType is emitted during network lifecycle events
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
typedef enum {
- VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: v1.2.1) */
- VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: v1.2.1) */
- VIR_NETWORK_EVENT_STARTED = 2, /* (Since: v1.2.1) */
- VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: v1.2.1) */
+ VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: 1.2.1) */
+ VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: 1.2.1) */
+ VIR_NETWORK_EVENT_STARTED = 2, /* (Since: 1.2.1) */
+ VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: 1.2.1) */
# ifdef VIR_ENUM_SENTINELS
- VIR_NETWORK_EVENT_LAST /* (Since: v1.2.1) */
+ VIR_NETWORK_EVENT_LAST /* (Since: 1.2.1) */
# endif
} virNetworkEventLifecycleType;
* The callback signature to use when registering for an event of type
* VIR_NETWORK_EVENT_ID_LIFECYCLE with virConnectNetworkEventRegisterAny()
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn,
virNetworkPtr net,
* Used to cast the event specific callback into the generic one
* for use for virConnectNetworkEventRegisterAny()
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
# define VIR_NETWORK_EVENT_CALLBACK(cb) ((virConnectNetworkEventGenericCallback)(cb))
* virConnectNetworkEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
typedef enum {
- VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: v1.2.1) */
+ VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: 1.2.1) */
# ifdef VIR_ENUM_SENTINELS
VIR_NETWORK_EVENT_ID_LAST
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
# endif
} virNetworkEventID;
/**
* virIPAddrType:
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
typedef enum {
- VIR_IP_ADDR_TYPE_IPV4, /* (Since: v1.2.6) */
- VIR_IP_ADDR_TYPE_IPV6, /* (Since: v1.2.6) */
+ VIR_IP_ADDR_TYPE_IPV4, /* (Since: 1.2.6) */
+ VIR_IP_ADDR_TYPE_IPV6, /* (Since: 1.2.6) */
# ifdef VIR_ENUM_SENTINELS
- VIR_IP_ADDR_TYPE_LAST /* (Since: v1.2.6) */
+ VIR_IP_ADDR_TYPE_LAST /* (Since: 1.2.6) */
# endif
} virIPAddrType;
/**
* virNetworkDHCPLease:
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
typedef struct _virNetworkDHCPLease virNetworkDHCPLease;
/**
* virNetworkDHCPLeasePtr:
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr;
struct _virNetworkDHCPLease {
* passed in a different parameter position; use VIR_NETWORK_EVENT_CALLBACK()
* when registering an appropriate handler.
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
typedef void (*virConnectNetworkEventGenericCallback)(virConnectPtr conn,
virNetworkPtr net,
/**
* virNetworkPortCreateFlags:
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
typedef enum {
- VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: v5.5.0) */
- VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: v7.8.0) */
+ VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: 5.5.0) */
+ VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: 7.8.0) */
} virNetworkPortCreateFlags;
virNetworkPortPtr
*
* Macro represents the inbound average of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE "inbound.average"
*
* Macro represents the inbound peak of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK "inbound.peak"
*
* Macro represents the inbound burst of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_BURST "inbound.burst"
*
* Macro represents the inbound floor of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR "inbound.floor"
*
* Macro represents the outbound average of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE "outbound.average"
*
* Macro represents the outbound peak of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK "outbound.peak"
*
* Macro represents the outbound burst of NIC bandwidth, as a uint.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST "outbound.burst"
*
* A virNodeDevice contains a node (host) device details.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef struct _virNodeDevice virNodeDevice;
* to call virNodeDeviceFree when done using a virNodeDevicePtr obtained
* from any of the above functions to avoid leaking memory.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
typedef virNodeDevice *virNodeDevicePtr;
* Flags used to filter either by capability or active state, the
* returned node devices.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: v0.10.2) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: v1.0.4) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: v1.0.4) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: v1.1.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: v3.1.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: v3.4.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: v3.4.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: v3.4.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: v6.8.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: v6.9.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: v7.0.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: v7.0.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: v7.0.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: v7.9.0) */
-
- VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: v7.3.0) */
- VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: v7.3.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: 0.10.2) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: 1.0.4) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: 1.0.4) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: 1.1.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: 3.1.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: 3.4.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: 3.4.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: 3.4.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: 6.8.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: 6.9.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: 7.0.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: 7.0.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: 7.0.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: 7.9.0) */
+
+ VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: 7.3.0) */
+ VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: 7.3.0) */
} virConnectListAllNodeDeviceFlags;
int virConnectListAllNodeDevices (virConnectPtr conn,
* Used to cast the event specific callback into the generic one
* for use for virConnectNodeDeviceEventRegisterAny()
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
# define VIR_NODE_DEVICE_EVENT_CALLBACK(cb)((virConnectNodeDeviceEventGenericCallback)(cb))
* virConnectNodeDeviceEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
typedef enum {
- VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: v2.2.0) */
- VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: v2.2.0) */
+ VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: 2.2.0) */
+ VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: 2.2.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_NODE_DEVICE_EVENT_ID_LAST
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
# endif
} virNodeDeviceEventID;
* passed in a different parameter position; use
* VIR_NODE_DEVICE_EVENT_CALLBACK() when registering an appropriate handler.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
typedef void (*virConnectNodeDeviceEventGenericCallback)(virConnectPtr conn,
virNodeDevicePtr dev,
* a virNodeDeviceEventLifecycleType is emitted during node device
* lifecycle events
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
typedef enum {
- VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: v2.2.0) */
- VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: v2.2.0) */
- VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: v7.3.0) */
- VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: v7.3.0) */
+ VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: 2.2.0) */
+ VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: 2.2.0) */
+ VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: 7.3.0) */
+ VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: 7.3.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_NODE_DEVICE_EVENT_LAST /* (Since: v2.2.0) */
+ VIR_NODE_DEVICE_EVENT_LAST /* (Since: 2.2.0) */
# endif
} virNodeDeviceEventLifecycleType;
* VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE with
* virConnectNodeDeviceEventRegisterAny()
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
typedef void (*virConnectNodeDeviceEventLifecycleCallback)(virConnectPtr conn,
virNodeDevicePtr dev,
*
* a virNWFilter is a private structure representing a network filter
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef struct _virNWFilter virNWFilter;
* a virNWFilterPtr is pointer to a virNWFilter private structure,
* this is the type used to reference a network filter in the API.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
typedef virNWFilter *virNWFilterPtr;
* a virNWFilterBinding is a private structure representing a network
* filter binding to a port
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
typedef struct _virNWFilterBinding virNWFilterBinding;
* structure, this is the type used to reference a network filter
* port binding in the API.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
typedef virNWFilterBinding *virNWFilterBindingPtr;
/**
* virNWFilterDefineFlags:
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
typedef enum {
- VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
+ VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virNWFilterDefineFlags;
/*
/**
* virNWFilterBindingCreateFlags:
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
typedef enum {
- VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */
+ VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.8.0) */
} virNWFilterBindingCreateFlags;
const char* virNWFilterGetName (virNWFilterPtr nwfilter);
/**
* virDomainQemuMonitorCommandFlags:
*
- * Since: v0.8.8
+ * Since: 0.8.8
*/
typedef enum {
- VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0, /* (Since: v0.8.8) */
- VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since: v0.8.8) */
+ VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0, /* (Since: 0.8.8) */
+ VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since: 0.8.8) */
} virDomainQemuMonitorCommandFlags;
int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd,
/**
* virDomainQemuAgentCommandTimeoutValues:
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
typedef enum {
- VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: v0.10.0) */
- VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: v0.10.0) */
- VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT, /* (Since: v0.10.0) */
- VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT, /* (Since: v0.10.0) */
- VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60, /* (Since: v1.2.15) */
+ VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: 0.10.0) */
+ VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: 0.10.0) */
+ VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT, /* (Since: 0.10.0) */
+ VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT, /* (Since: 0.10.0) */
+ VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60, /* (Since: 1.2.15) */
} virDomainQemuAgentCommandTimeoutValues;
char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd,
* The callback signature to use when registering for a qemu monitor
* event with virConnectDomainQemuMonitorEventRegister().
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr conn,
virDomainPtr dom,
/**
* virConnectDomainQemuMonitorEventRegisterFlags:
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
typedef enum {
- /* Event filter is a regex rather than a literal string (Since: v1.2.3) */
+ /* Event filter is a regex rather than a literal string (Since: 1.2.3) */
VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_REGEX = (1 << 0),
- /* Event filter is case insensitive (Since: v1.2.3) */
+ /* Event filter is case insensitive (Since: 1.2.3) */
VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_NOCASE = (1 << 1),
} virConnectDomainQemuMonitorEventRegisterFlags;
* A virSecret stores a secret value (e.g. a passphrase or encryption key)
* and associated metadata.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
typedef struct _virSecret virSecret;
/**
* virSecretPtr:
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
typedef virSecret *virSecretPtr;
/**
* virSecretUsageType:
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
typedef enum {
- VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: v0.7.1) */
- VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: v0.7.1) */
- VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: v0.9.7) */
- VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: v1.0.4) */
- VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: v2.3.0) */
- VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: v5.6.0) */
+ VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: 0.7.1) */
+ VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: 0.7.1) */
+ VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: 0.9.7) */
+ VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: 1.0.4) */
+ VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: 2.3.0) */
+ VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: 5.6.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_SECRET_USAGE_TYPE_LAST
* added to the libvirt API. It reflects the last usage type supported
* by this version of the libvirt API.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
# endif
} virSecretUsageType;
* Flags used to filter the returned secrets. Flags in each group
* are exclusive attributes of a secret.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
typedef enum {
VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1 << 0, /* kept in memory, never
- stored persistently (Since: v0.10.2) */
- VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: v0.10.2) */
+ stored persistently (Since: 0.10.2) */
+ VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_SECRETS_PRIVATE = 1 << 2, /* not revealed to any caller
of libvirt, nor to any other
- node (Since: v0.10.2) */
- VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: v0.10.2) */
+ node (Since: 0.10.2) */
+ VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: 0.10.2) */
} virConnectListAllSecretsFlags;
int virConnectListAllSecrets(virConnectPtr conn,
/**
* virSecretDefineFlags:
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
typedef enum {
- VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
+ VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virSecretDefineFlags;
virSecretPtr virSecretDefineXML (virConnectPtr conn,
* Used to cast the event specific callback into the generic one
* for use for virConnectSecretEventRegisterAny()
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# define VIR_SECRET_EVENT_CALLBACK(cb)((virConnectSecretEventGenericCallback)(cb))
* virConnectSecretEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
typedef enum {
- VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: v3.0.0) */
- VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: v3.0.0) */
+ VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: 3.0.0) */
+ VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: 3.0.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_SECRET_EVENT_ID_LAST
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
# endif
} virSecretEventID;
* passed in a different parameter position; use
* VIR_SECRET_EVENT_CALLBACK() when registering an appropriate handler.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
typedef void (*virConnectSecretEventGenericCallback)(virConnectPtr conn,
virSecretPtr secret,
* a virSecretEventLifecycleType is emitted during secret
* lifecycle events
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
typedef enum {
- VIR_SECRET_EVENT_DEFINED = 0, /* (Since: v3.0.0) */
- VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: v3.0.0) */
+ VIR_SECRET_EVENT_DEFINED = 0, /* (Since: 3.0.0) */
+ VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: 3.0.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_SECRET_EVENT_LAST /* (Since: v3.0.0) */
+ VIR_SECRET_EVENT_LAST /* (Since: 3.0.0) */
# endif
} virSecretEventLifecycleType;
* VIR_SECRET_EVENT_ID_LIFECYCLE with
* virConnectSecretEventRegisterAny()
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
typedef void (*virConnectSecretEventLifecycleCallback)(virConnectPtr conn,
virSecretPtr secret,
*
* a virStoragePool is a private structure representing a storage pool
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef struct _virStoragePool virStoragePool;
* a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the
* type used to reference a storage pool in the API.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef virStoragePool *virStoragePoolPtr;
/**
* virStoragePoolState:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: v0.4.1) */
- VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: v0.4.1) */
- VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: v0.4.1) */
- VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: v0.4.1) */
- VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: v0.8.2) */
+ VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: 0.4.1) */
+ VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: 0.4.1) */
+ VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: 0.4.1) */
+ VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: 0.4.1) */
+ VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: 0.8.2) */
# ifdef VIR_ENUM_SENTINELS
- VIR_STORAGE_POOL_STATE_LAST /* (Since: v0.9.10) */
+ VIR_STORAGE_POOL_STATE_LAST /* (Since: 0.9.10) */
# endif
} virStoragePoolState;
/**
* virStoragePoolBuildFlags:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: v0.4.1) */
- VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: v0.4.1) */
- VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: v0.4.1) */
- VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: v0.9.5) */
- VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: v0.9.5) */
+ VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: 0.4.1) */
+ VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: 0.4.1) */
+ VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: 0.4.1) */
+ VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: 0.9.5) */
+ VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: 0.9.5) */
} virStoragePoolBuildFlags;
/**
* virStoragePoolDeleteFlags:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */
- VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */
+ VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: 0.4.1) */
+ VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: 0.4.1) */
} virStoragePoolDeleteFlags;
/**
* virStoragePoolCreateFlags:
*
- * Since: v1.3.1
+ * Since: 1.3.1
*/
typedef enum {
- /* Create the pool but do not perform pool build (Since: v1.3.1) */
+ /* Create the pool but do not perform pool build (Since: 1.3.1) */
VIR_STORAGE_POOL_CREATE_NORMAL = 0,
- /* Create the pool and perform pool build without any flags (Since: v1.3.1) */
+ /* Create the pool and perform pool build without any flags (Since: 1.3.1) */
VIR_STORAGE_POOL_CREATE_WITH_BUILD = 1 << 0,
/* Create the pool and perform pool build using the
* VIR_STORAGE_POOL_BUILD_OVERWRITE flag. This is mutually
* exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE
*
- * Since: v1.3.1
+ * Since: 1.3.1
*/
VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE = 1 << 1,
* VIR_STORAGE_POOL_BUILD_NO_OVERWRITE flag. This is mutually
* exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE
*
- * Since: v1.3.1
+ * Since: 1.3.1
*/
VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE = 1 << 2,
} virStoragePoolCreateFlags;
/**
* virStoragePoolInfo:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef struct _virStoragePoolInfo virStoragePoolInfo;
/**
* virStoragePoolInfoPtr:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef virStoragePoolInfo *virStoragePoolInfoPtr;
*
* a virStorageVol is a private structure representing a storage volume
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef struct _virStorageVol virStorageVol;
* a virStorageVolPtr is pointer to a virStorageVol private structure, this is the
* type used to reference a storage volume in the API.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef virStorageVol *virStorageVolPtr;
/**
* virStorageVolType:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: v0.4.1) */
- VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: v0.4.1) */
- VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: v0.9.5) */
- VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: v0.9.13) */
+ VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: 0.4.1) */
+ VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: 0.4.1) */
+ VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: 0.9.5) */
+ VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: 0.9.13) */
VIR_STORAGE_VOL_NETDIR = 4, /* Network accessible directory that can
- * contain other network volumes (Since: v1.2.0) */
- VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: v1.3.4) */
+ * contain other network volumes (Since: 1.2.0) */
+ VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: 1.3.4) */
# ifdef VIR_ENUM_SENTINELS
- VIR_STORAGE_VOL_LAST /* (Since: v0.9.10) */
+ VIR_STORAGE_VOL_LAST /* (Since: 0.9.10) */
# endif
} virStorageVolType;
/**
* virStorageVolDeleteFlags:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef enum {
- VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */
- VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */
- VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: v1.2.21) */
+ VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: 0.4.1) */
+ VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: 0.4.1) */
+ VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: 1.2.21) */
} virStorageVolDeleteFlags;
/**
* virStorageVolWipeAlgorithm:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: v0.9.10) */
+ VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_NNSA = 1, /* 4-pass NNSA Policy Letter
- NAP-14.1-C (XVI-8) (Since: v0.9.10) */
+ NAP-14.1-C (XVI-8) (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_DOD = 2, /* 4-pass DoD 5220.22-M section
- 8-306 procedure (Since: v0.9.10) */
+ 8-306 procedure (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_BSI = 3, /* 9-pass method recommended by the
German Center of Security in
- Information Technologies (Since: v0.9.10) */
- VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: v0.9.10) */
+ Information Technologies (Since: 0.9.10) */
+ VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_SCHNEIER = 5, /* 7-pass method described by
Bruce Schneier in "Applied
- Cryptography" (1996) (Since: v0.9.10) */
- VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: v0.9.10) */
+ Cryptography" (1996) (Since: 0.9.10) */
+ VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: 0.9.10) */
- VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: v0.9.10) */
+ VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: 0.9.10) */
- VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: v0.9.10) */
+ VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_TRIM = 9, /* 1-pass, trim all data on the
- volume by using TRIM or DISCARD (Since: v1.3.2) */
+ volume by using TRIM or DISCARD (Since: 1.3.2) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_VOL_WIPE_ALG_LAST
* added to the libvirt API. It reflects the last algorithm supported
* by this version of the libvirt API.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
# endif
} virStorageVolWipeAlgorithm;
/**
* virStorageVolInfoFlags:
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
typedef enum {
- VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: v3.0.0) */
- VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: v3.0.0) */
+ VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: 3.0.0) */
+ VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: 3.0.0) */
} virStorageVolInfoFlags;
/**
* virStorageVolInfo:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef struct _virStorageVolInfo virStorageVolInfo;
/**
* virStorageVolInfoPtr:
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
typedef virStorageVolInfo *virStorageVolInfoPtr;
/**
* virStorageXMLFlags:
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
typedef enum {
- VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: v0.9.13) */
+ VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: 0.9.13) */
} virStorageXMLFlags;
/*
* 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.10.2
+ * Since: 0.10.2
*/
typedef enum {
- VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */
-
- VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */
-
- VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */
-
- VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: v0.10.2) */
- VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: v1.2.1) */
- VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: v1.2.8) */
- VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: v3.1.0) */
- VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: v5.6.0) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: 0.10.2) */
+
+ VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: 0.10.2) */
+
+ VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: 0.10.2) */
+
+ VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: 0.10.2) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: 1.2.1) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: 1.2.8) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: 3.1.0) */
+ VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: 5.6.0) */
} virConnectListAllStoragePoolsFlags;
int virConnectListAllStoragePools(virConnectPtr conn,
/**
* virStoragePoolDefineFlags:
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
typedef enum {
- VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
+ VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virStoragePoolDefineFlags;
/*
/**
* virStorageVolCreateFlags:
*
- * Since: v1.0.1
+ * Since: 1.0.1
*/
typedef enum {
- VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: v1.0.1) */
- VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: v1.2.13) */
+ VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: 1.0.1) */
+ VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: 1.2.13) */
} virStorageVolCreateFlags;
virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr pool,
/**
* virStorageVolDownloadFlags:
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
typedef enum {
- VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */
+ VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: 3.4.0) */
} virStorageVolDownloadFlags;
int virStorageVolDownload (virStorageVolPtr vol,
/**
* virStorageVolUploadFlags:
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
typedef enum {
- VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */
+ VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: 3.4.0) */
} virStorageVolUploadFlags;
int virStorageVolUpload (virStorageVolPtr vol,
/**
* virStorageVolResizeFlags:
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
typedef enum {
- VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: v0.9.10) */
- VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: v0.9.10) */
- VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: v0.9.10) */
+ VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: 0.9.10) */
+ VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: 0.9.10) */
+ VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: 0.9.10) */
} virStorageVolResizeFlags;
int virStorageVolResize (virStorageVolPtr vol,
* Used to cast the event specific callback into the generic one
* for use for virConnectStoragePoolEventRegisterAny()
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# define VIR_STORAGE_POOL_EVENT_CALLBACK(cb)((virConnectStoragePoolEventGenericCallback)(cb))
* virConnectStoragePoolEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef enum {
- VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: v2.0.0) */
- VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: v2.0.0) */
+ VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: 2.0.0) */
+ VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: 2.0.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_POOL_EVENT_ID_LAST
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
# endif
} virStoragePoolEventID;
* passed in a different parameter position; use
* VIR_STORAGE_POOL_EVENT_CALLBACK() when registering an appropriate handler.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef void (*virConnectStoragePoolEventGenericCallback)(virConnectPtr conn,
virStoragePoolPtr pool,
* a virStoragePoolEventLifecycleType is emitted during storage pool
* lifecycle events
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef enum {
- VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: v2.0.0) */
- VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: v2.0.0) */
- VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: v2.0.0) */
- VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: v2.0.0) */
- VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: v3.8.0) */
- VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: v3.8.0) */
+ VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: 2.0.0) */
+ VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: 2.0.0) */
+ VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: 2.0.0) */
+ VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: 2.0.0) */
+ VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: 3.8.0) */
+ VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: 3.8.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_STORAGE_POOL_EVENT_LAST /* (Since: v2.0.0) */
+ VIR_STORAGE_POOL_EVENT_LAST /* (Since: 2.0.0) */
# endif
} virStoragePoolEventLifecycleType;
* VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE with
* virConnectStoragePoolEventRegisterAny()
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
typedef void (*virConnectStoragePoolEventLifecycleCallback)(virConnectPtr conn,
virStoragePoolPtr pool,
/**
* virStreamFlags:
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef enum {
- VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: v0.7.2) */
+ VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: 0.7.2) */
} virStreamFlags;
virStreamPtr virStreamNew(virConnectPtr conn,
/**
* virStreamRecvFlagsValues:
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
typedef enum {
- VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: v3.4.0) */
+ VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: 3.4.0) */
} virStreamRecvFlagsValues;
int virStreamRecvFlags(virStreamPtr st,
* Returns the number of bytes filled, 0 upon end
* of file, or -1 upon error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef int (*virStreamSourceFunc)(virStreamPtr st,
char *data,
* Returns 0 on success,
* -1 upon error
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
typedef int (*virStreamSourceHoleFunc)(virStreamPtr st,
int *inData,
* Returns 0 on success,
* -1 upon error.
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
typedef int (*virStreamSourceSkipFunc)(virStreamPtr st,
long long length,
* Returns the number of bytes consumed or -1 upon
* error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef int (*virStreamSinkFunc)(virStreamPtr st,
const char *data,
* Returns 0 on success,
* -1 upon error
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
typedef int (*virStreamSinkHoleFunc)(virStreamPtr st,
long long length,
/**
* virStreamEventType:
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef enum {
- VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: v0.7.2) */
- VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: v0.7.2) */
- VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: v0.7.2) */
- VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: v0.7.2) */
+ VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: 0.7.2) */
+ VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: 0.7.2) */
+ VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: 0.7.2) */
+ VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: 0.7.2) */
} virStreamEventType;
* Callback for receiving stream events. The callback will
* be invoked once for each event which is pending.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
typedef void (*virStreamEventCallback)(virStreamPtr stream, int events, void *opaque);
*
* Indicates the level of an error
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef enum {
- VIR_ERR_NONE = 0, /* (Since: v0.1.0) */
- VIR_ERR_WARNING = 1, /* A simple warning (Since: v0.1.0) */
- VIR_ERR_ERROR = 2 /* An error (Since: v0.1.0) */
+ VIR_ERR_NONE = 0, /* (Since: 0.1.0) */
+ VIR_ERR_WARNING = 1, /* A simple warning (Since: 0.1.0) */
+ VIR_ERR_ERROR = 2 /* An error (Since: 0.1.0) */
} virErrorLevel;
/**
* Indicates where an error may have come from. This should remain
* stable, with all additions placed at the end since libvirt 0.1.0.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef enum {
- VIR_FROM_NONE = 0, /* (Since: v0.1.0) */
- VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: v0.1.0) */
- VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: v0.1.0) */
- VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: v0.1.0) */
- VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: v0.1.0) */
-
- VIR_FROM_XML = 5, /* Error in the XML code (Since: v0.1.0) */
- VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: v0.1.0) */
- VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: v0.1.1) */
+ VIR_FROM_NONE = 0, /* (Since: 0.1.0) */
+ VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: 0.1.0) */
+ VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: 0.1.0) */
+ VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: 0.1.0) */
+ VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: 0.1.0) */
+
+ VIR_FROM_XML = 5, /* Error in the XML code (Since: 0.1.0) */
+ VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: 0.1.0) */
+ VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: 0.1.1) */
VIR_FROM_PROXY = 8, /* Error in the proxy code; unused since
- 0.8.6 (Since: v0.1.3) */
- VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: v0.1.6) */
-
- VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: v0.2.0) */
- VIR_FROM_NET = 11, /* Error when operating on a network (Since: v0.2.0) */
- VIR_FROM_TEST = 12, /* Error from test driver (Since: v0.2.3) */
- VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: v0.2.3) */
- VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: v0.3.1) */
-
- VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: v0.4.1) */
- VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: v0.4.1) */
- VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: v0.4.2) */
- VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: v0.4.1) */
- VIR_FROM_NETWORK = 19, /* Error from network config (Since: v0.4.6) */
-
- VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: v0.4.6) */
- VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: v0.5.0) */
- VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: v0.5.0) */
- VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: v0.5.0) */
- VIR_FROM_SECURITY = 24, /* Error from security framework (Since: v0.6.1) */
-
- VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: v0.6.3) */
- VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: v0.6.4) */
+ 0.8.6 (Since: 0.1.3) */
+ VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: 0.1.6) */
+
+ VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: 0.2.0) */
+ VIR_FROM_NET = 11, /* Error when operating on a network (Since: 0.2.0) */
+ VIR_FROM_TEST = 12, /* Error from test driver (Since: 0.2.3) */
+ VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: 0.2.3) */
+ VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: 0.3.1) */
+
+ VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: 0.4.1) */
+ VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: 0.4.1) */
+ VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: 0.4.2) */
+ VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: 0.4.1) */
+ VIR_FROM_NETWORK = 19, /* Error from network config (Since: 0.4.6) */
+
+ VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: 0.4.6) */
+ VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: 0.5.0) */
+ VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: 0.5.0) */
+ VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: 0.5.0) */
+ VIR_FROM_SECURITY = 24, /* Error from security framework (Since: 0.6.1) */
+
+ VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: 0.6.3) */
+ VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: 0.6.4) */
VIR_FROM_ONE = 27, /* The OpenNebula driver no longer exists.
- Retained for ABI/API compat only (Since: v0.6.4) */
- VIR_FROM_ESX = 28, /* Error from ESX driver (Since: v0.7.0) */
- VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: v0.7.0) */
-
- VIR_FROM_SECRET = 30, /* Error from secret storage (Since: v0.7.1) */
- VIR_FROM_CPU = 31, /* Error from CPU driver (Since: v0.7.5) */
- VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: v0.8.0) */
- VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: v0.8.0) */
- VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: v0.8.0) */
-
- VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: v0.8.0) */
- VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: v0.8.5) */
- VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: v0.8.6) */
- VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: v0.8.6) */
- VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: v0.8.7) */
-
- VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: v0.9.0) */
- VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: v0.9.0) */
- VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: v0.9.2) */
- VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: v0.9.5) */
- VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: v0.9.8) */
-
- VIR_FROM_URI = 45, /* Error from URI handling (Since: v0.9.11) */
- VIR_FROM_AUTH = 46, /* Error from auth handling (Since: v0.9.11) */
- VIR_FROM_DBUS = 47, /* Error from DBus (Since: v0.9.12) */
- VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: v0.10.0) */
- VIR_FROM_DEVICE = 49, /* Error from Device (Since: v0.10.0) */
-
- VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: v0.10.0) */
- VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: v1.0.0) */
- VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: v1.0.1) */
- VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: v1.0.4) */
- VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: v1.0.5) */
-
- VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: v1.1.0) */
- VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: v1.1.1) */
- VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: v1.2.2) */
- VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: v1.2.3) */
- VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: v1.2.4) */
-
- VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: v1.2.9) */
- VIR_FROM_THREAD = 61, /* Error from thread utils (Since: v1.2.14) */
- VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: v1.2.17) */
- VIR_FROM_LOGGING = 63, /* Error from log manager (Since: v1.3.0) */
- VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: v1.3.2) */
-
- VIR_FROM_PERF = 65, /* Error from perf (Since: v1.3.3) */
- VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: v2.5.0) */
- VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: v3.7.0) */
- VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: v5.1.0) */
- VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: v5.2.0) */
-
- VIR_FROM_TPM = 70, /* Error from TPM (Since: v5.6.0) */
- VIR_FROM_BPF = 71, /* Error from BPF code (Since: v5.10.0) */
- VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: v7.5.0) */
+ Retained for ABI/API compat only (Since: 0.6.4) */
+ VIR_FROM_ESX = 28, /* Error from ESX driver (Since: 0.7.0) */
+ VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: 0.7.0) */
+
+ VIR_FROM_SECRET = 30, /* Error from secret storage (Since: 0.7.1) */
+ VIR_FROM_CPU = 31, /* Error from CPU driver (Since: 0.7.5) */
+ VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: 0.8.0) */
+ VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: 0.8.0) */
+ VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: 0.8.0) */
+
+ VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: 0.8.0) */
+ VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: 0.8.5) */
+ VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: 0.8.6) */
+ VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: 0.8.6) */
+ VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: 0.8.7) */
+
+ VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: 0.9.0) */
+ VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: 0.9.0) */
+ VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: 0.9.2) */
+ VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: 0.9.5) */
+ VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: 0.9.8) */
+
+ VIR_FROM_URI = 45, /* Error from URI handling (Since: 0.9.11) */
+ VIR_FROM_AUTH = 46, /* Error from auth handling (Since: 0.9.11) */
+ VIR_FROM_DBUS = 47, /* Error from DBus (Since: 0.9.12) */
+ VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: 0.10.0) */
+ VIR_FROM_DEVICE = 49, /* Error from Device (Since: 0.10.0) */
+
+ VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: 0.10.0) */
+ VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: 1.0.0) */
+ VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: 1.0.1) */
+ VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: 1.0.4) */
+ VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: 1.0.5) */
+
+ VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: 1.1.0) */
+ VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: 1.1.1) */
+ VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: 1.2.2) */
+ VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: 1.2.3) */
+ VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: 1.2.4) */
+
+ VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: 1.2.9) */
+ VIR_FROM_THREAD = 61, /* Error from thread utils (Since: 1.2.14) */
+ VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: 1.2.17) */
+ VIR_FROM_LOGGING = 63, /* Error from log manager (Since: 1.3.0) */
+ VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: 1.3.2) */
+
+ VIR_FROM_PERF = 65, /* Error from perf (Since: 1.3.3) */
+ VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: 2.5.0) */
+ VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: 3.7.0) */
+ VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: 5.1.0) */
+ VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: 5.2.0) */
+
+ VIR_FROM_TPM = 70, /* Error from TPM (Since: 5.6.0) */
+ VIR_FROM_BPF = 71, /* Error from BPF code (Since: 5.10.0) */
+ VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: 7.5.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_ERR_DOMAIN_LAST /* (Since: v0.9.13) */
+ VIR_ERR_DOMAIN_LAST /* (Since: 0.9.13) */
# endif
} virErrorDomain;
* Reference counts are not incremented so the underlying objects
* may be deleted without notice after the error has been delivered.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef struct _virError virError;
/**
* virErrorPtr:
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef virError *virErrorPtr;
struct _virError {
* default:
* }
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef enum {
- VIR_ERR_OK = 0, /* (Since: v0.1.0) */
- VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: v0.1.0) */
- VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: v0.1.0) */
- VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: v0.1.0) */
- VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: v0.1.0) */
- VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: v0.1.0) */
- VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: v0.1.0) */
- VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: v0.1.0) */
- VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: v0.1.0) */
- VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: v0.1.0) */
- VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: v0.1.0) */
- VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: v0.1.0) */
- VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: v0.1.0) */
- VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: v0.1.0) */
+ VIR_ERR_OK = 0, /* (Since: 0.1.0) */
+ VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: 0.1.0) */
+ VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: 0.1.0) */
+ VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: 0.1.0) */
+ VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: 0.1.0) */
+ VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: 0.1.0) */
+ VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: 0.1.0) */
+ VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: 0.1.0) */
+ VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: 0.1.0) */
+ VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: 0.1.0) */
+ VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: 0.1.0) */
+ VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: 0.1.0) */
+ VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: 0.1.0) */
+ VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: 0.1.0) */
VIR_ERR_NO_XEN = 14, /* could not open Xen hypervisor
- control (Since: v0.1.0) */
- VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: v0.1.0) */
- VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: v0.1.0) */
- VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: v0.1.0) */
- VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: v0.1.0) */
- VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: v0.1.0) */
- VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: v0.1.0) */
- VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: v0.1.0) */
- VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: v0.1.0) */
- VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: v0.1.0) */
- VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: v0.1.0) */
- VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: v0.1.0) */
+ control (Since: 0.1.0) */
+ VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: 0.1.0) */
+ VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: 0.1.0) */
+ VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: 0.1.0) */
+ VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: 0.1.0) */
+ VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: 0.1.0) */
+ VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: 0.1.0) */
+ VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: 0.1.0) */
+ VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: 0.1.0) */
+ VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: 0.1.0) */
+ VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: 0.1.0) */
+ VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: 0.1.0) */
VIR_ERR_CALL_FAILED = 26, /* not supported by the drivers
- (DEPRECATED) (Since: v0.1.0) */
+ (DEPRECATED) (Since: 0.1.0) */
VIR_ERR_XML_ERROR = 27, /* an XML description is not well
- formed or broken (Since: v0.1.1) */
- VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: v0.1.1) */
+ formed or broken (Since: 0.1.1) */
+ VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: 0.1.1) */
VIR_ERR_OPERATION_DENIED = 29, /* operation forbidden on read-only
- connections (Since: v0.1.4) */
- VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: v0.1.6) */
- VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: v0.1.6) */
- VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: v0.1.6) */
+ connections (Since: 0.1.4) */
+ VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: 0.1.6) */
+ VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: 0.1.6) */
+ VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: 0.1.6) */
VIR_ERR_CONF_SYNTAX = 33, /* failed to parse the syntax of a
- conf file (Since: v0.1.6) */
- VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: v0.1.6) */
- VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: v0.1.9) */
- VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: v0.2.0) */
- VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: v0.2.0) */
- VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: v0.2.1) */
- VIR_ERR_RPC = 39, /* some sort of RPC error (Since: v0.2.3) */
- VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: v0.2.3) */
- VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: v0.2.3) */
+ conf file (Since: 0.1.6) */
+ VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: 0.1.6) */
+ VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: 0.1.9) */
+ VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: 0.2.0) */
+ VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: 0.2.0) */
+ VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: 0.2.1) */
+ VIR_ERR_RPC = 39, /* some sort of RPC error (Since: 0.2.3) */
+ VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: 0.2.3) */
+ VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: 0.2.3) */
VIR_ERR_NO_DOMAIN = 42, /* domain not found or unexpectedly
- disappeared (Since: v0.3.0) */
- VIR_ERR_NO_NETWORK = 43, /* network not found (Since: v0.3.0) */
- VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: v0.3.1) */
- VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: v0.4.1) */
- VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: v0.4.1) */
- VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: v0.4.1) */
- VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: v0.4.1) */
- VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: v0.4.1) */
- VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: v0.4.1) */
- VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: v0.5.0) */
- VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: v0.5.0) */
- VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: v0.5.0) */
- VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: v0.6.1) */
+ disappeared (Since: 0.3.0) */
+ VIR_ERR_NO_NETWORK = 43, /* network not found (Since: 0.3.0) */
+ VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: 0.3.1) */
+ VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: 0.4.1) */
+ VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: 0.4.1) */
+ VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: 0.4.1) */
+ VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: 0.4.1) */
+ VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: 0.4.1) */
+ VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: 0.4.1) */
+ VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: 0.5.0) */
+ VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: 0.5.0) */
+ VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: 0.5.0) */
+ VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: 0.6.1) */
VIR_ERR_OPERATION_INVALID = 55, /* operation is not applicable at this
- time (Since: v0.6.4) */
- VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: v0.6.4) */
- VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: v0.6.4) */
- VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: v0.6.4) */
+ time (Since: 0.6.4) */
+ VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: 0.6.4) */
+ VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: 0.6.4) */
+ VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: 0.6.4) */
VIR_ERR_MULTIPLE_INTERFACES = 59, /* more than one matching interface
- found (Since: v0.7.0) */
- VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: v0.8.0) */
- VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: v0.8.0) */
- VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: v0.8.0) */
- VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: v0.8.0) */
- VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: v0.7.1) */
- VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: v0.7.1) */
- VIR_ERR_NO_SECRET = 66, /* secret not found (Since: v0.7.1) */
+ found (Since: 0.7.0) */
+ VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: 0.8.0) */
+ VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: 0.8.0) */
+ VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: 0.8.0) */
+ VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: 0.8.0) */
+ VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: 0.7.1) */
+ VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: 0.7.1) */
+ VIR_ERR_NO_SECRET = 66, /* secret not found (Since: 0.7.1) */
VIR_ERR_CONFIG_UNSUPPORTED = 67, /* unsupported configuration
- construct (Since: v0.7.3) */
- VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: v0.7.3) */
+ construct (Since: 0.7.3) */
+ VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: 0.7.3) */
VIR_ERR_MIGRATE_PERSIST_FAILED = 69,/* a migration worked, but making the
- VM persist on the dest host failed (Since: v0.7.3) */
- VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: v0.8.0) */
- VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: v0.8.0) */
- VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: v0.8.0) */
- VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: v0.9.0) */
+ VM persist on the dest host failed (Since: 0.7.3) */
+ VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: 0.8.0) */
+ VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: 0.8.0) */
+ VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: 0.8.0) */
+ VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: 0.9.0) */
VIR_ERR_ARGUMENT_UNSUPPORTED = 74, /* valid API use but unsupported by
- the given driver (Since: v0.9.4) */
- VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: v0.9.5) */
- VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: v0.9.5) */
+ the given driver (Since: 0.9.4) */
+ VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: 0.9.5) */
+ VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: 0.9.5) */
VIR_ERR_SNAPSHOT_REVERT_RISKY = 77, /* force was not requested for a
- risky domain snapshot revert (Since: v0.9.7) */
+ risky domain snapshot revert (Since: 0.9.7) */
VIR_ERR_OPERATION_ABORTED = 78, /* operation on a domain was
- canceled/aborted by user (Since: v0.9.9) */
- VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: v0.9.10) */
- VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: v0.9.10) */
- VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: v0.9.11) */
- VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: v0.9.11) */
- VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: v0.9.12) */
+ canceled/aborted by user (Since: 0.9.9) */
+ VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: 0.9.10) */
+ VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: 0.9.10) */
+ VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: 0.9.11) */
+ VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: 0.9.11) */
+ VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: 0.9.12) */
VIR_ERR_OPERATION_UNSUPPORTED = 84, /* The requested operation is not
- supported (Since: v0.10.0) */
- VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: v0.10.0) */
+ supported (Since: 0.10.0) */
+ VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: 0.10.0) */
VIR_ERR_AGENT_UNRESPONSIVE = 86, /* guest agent is unresponsive,
- not running or not usable (Since: v0.10.0) */
- VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: v1.0.0) */
+ not running or not usable (Since: 0.10.0) */
+ VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: 1.0.0) */
VIR_ERR_ACCESS_DENIED = 88, /* operation on the object/resource
- was denied (Since: v1.1.0) */
- VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: v1.1.1) */
- VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: v1.1.4) */
- VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: v1.2.6) */
- VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: v1.2.12) */
- VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: v1.2.18) */
- VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: v1.3.3) */
- VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: v1.3.3) */
- VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: v1.3.5) */
+ was denied (Since: 1.1.0) */
+ VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: 1.1.1) */
+ VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: 1.1.4) */
+ VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: 1.2.6) */
+ VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: 1.2.12) */
+ VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: 1.2.18) */
+ VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: 1.3.3) */
+ VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: 1.3.3) */
+ VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: 1.3.5) */
VIR_ERR_AGENT_UNSYNCED = 97, /* guest agent replies with wrong id
- to guest-sync command (DEPRECATED) (Since: v2.3.0) */
- VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: v2.5.0) */
- VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: v4.1.0) */
- VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: v4.5.0) */
- VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: v4.5.0) */
- VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: v5.2.0) */
- VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: v5.2.0) */
- VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: v5.2.0) */
- VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: v5.5.0) */
- VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: v5.5.0) */
- VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: v5.5.0) */
- VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: v6.1.0) */
- VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: v6.10.0) */
- VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: v7.1.0) */
+ to guest-sync command (DEPRECATED) (Since: 2.3.0) */
+ VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: 2.5.0) */
+ VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: 4.1.0) */
+ VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: 4.5.0) */
+ VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: 4.5.0) */
+ VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: 5.2.0) */
+ VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: 5.2.0) */
+ VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: 5.2.0) */
+ VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: 5.5.0) */
+ VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: 5.5.0) */
+ VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: 5.5.0) */
+ VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: 6.1.0) */
+ VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: 6.10.0) */
+ VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: 7.1.0) */
# ifdef VIR_ENUM_SENTINELS
- VIR_ERR_NUMBER_LAST /* (Since: v5.0.0) */
+ VIR_ERR_NUMBER_LAST /* (Since: 5.0.0) */
# endif
} virErrorNumber;
*
* Signature of a function to use when there is an error raised by the library.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
typedef void (*virErrorFunc) (void *userData, virErrorPtr error);
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmInitialize(void)
*
* Returns @virAdmConnectPtr object or NULL on error
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
virAdmConnectPtr
virAdmConnectOpen(const char *name, unsigned int flags)
* application should not try to further use a connection after the
* virAdmConnectClose that matches the initial open.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmConnectClose(virAdmConnectPtr conn)
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmConnectRef(virAdmConnectPtr conn)
*
* Returns 0 on success, -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmGetVersion(unsigned long long *libVer)
* Returns 1, if the connection is alive, 0 if there isn't an existing
* connection at all or the channel has already been closed, or -1 on error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmConnectIsAlive(virAdmConnectPtr conn)
* Returns an URI string related to the connection or NULL in case of an error.
* Caller is responsible for freeing the string.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
char *
virAdmConnectGetURI(virAdmConnectPtr conn)
*
* Returns 0 on success, -1 on error
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn,
virAdmConnectCloseFunc cb,
*
* Returns 0 on success, -1 on error
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn,
virAdmConnectCloseFunc cb)
*
* Returns 0 on success, -1 on failure and @libVer follows this format:
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virAdmConnectGetLibVersion(virAdmConnectPtr conn,
unsigned long long *libVer)
* Returns a pointer to the name or NULL. The string doesn't need to be
* deallocated since its lifetime will be the same as the server object.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
const char *
virAdmServerGetName(virAdmServerPtr srv)
*
* Returns 0 on success, -1 on failure.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virAdmServerFree(virAdmServerPtr srv)
{
*
* Returns numeric value used for client's ID or -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
unsigned long long
virAdmClientGetID(virAdmClientPtr client)
* (epoch time) if libvirt doesn't have any information about client's
* connection time, or -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
long long
virAdmClientGetTimestamp(virAdmClientPtr client)
* Returns integer representation of the connection transport used by @client
* (this will be one of virClientTransport) or -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmClientGetTransport(virAdmClientPtr client)
*
* Returns 0 in success, -1 on failure.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virAdmClientFree(virAdmClientPtr client)
{
* Caller is responsible to call virAdmServerFree() on each list element,
* followed by freeing @servers.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmConnectListServers(virAdmConnectPtr conn,
* Returns the requested server or NULL in case of failure. If the
* server cannot be found, then VIR_ERR_NO_SERVER error is raised.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
virAdmServerPtr
virAdmConnectLookupServer(virAdmConnectPtr conn,
*
* Returns 0 on success, -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmServerGetThreadPoolParameters(virAdmServerPtr srv,
*
* Returns 0 on success, -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmServerSetThreadPoolParameters(virAdmServerPtr srv,
* Caller is responsible to call virAdmClientFree() on each list element,
* followed by freeing @clients.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmServerListClients(virAdmServerPtr srv,
* Returns the requested client or NULL in case of failure. If the
* client could not be found, then VIR_ERR_NO_CLIENT error is raised.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
virAdmClientPtr
virAdmServerLookupClient(virAdmServerPtr srv,
* Returns 0 if the information has been successfully retrieved or -1 in case
* of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmClientGetInfo(virAdmClientPtr client,
* Returns 0 if the daemon's connection with @client was closed successfully
* or -1 in case of an error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virAdmClientClose(virAdmClientPtr client,
unsigned int flags)
* Returns 0 on success, allocating @params to size returned in @nparams, or
* -1 in case of an error. Caller is responsible for deallocating @params.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmServerGetClientLimits(virAdmServerPtr srv,
* Returns 0 if the limits have been changed successfully or -1 in case of an
* error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virAdmServerSetClientLimits(virAdmServerPtr srv,
* Returns 0 if the TLS files have been updated successfully or -1 in case of an
* error.
*
- * Since: v6.2.0
+ * Since: 6.2.0
*/
int
virAdmServerUpdateTlsFiles(virAdmServerPtr srv,
*
* Returns the count of outputs in @outputs, or -1 in case of an error.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn,
* Returns the number of filters returned in @filters, or -1 in case of
* an error.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virAdmConnectGetLoggingFilters(virAdmConnectPtr conn,
* Returns 0 if the new output or the set of outputs has been defined
* successfully, or -1 in case of an error.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn,
* Returns 0 if the new filter or the set of filters has been defined
* successfully, or -1 in case of an error.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virAdmConnectSetLoggingFilters(virAdmConnectPtr conn,
* Returns a pointer to the name or NULL, the string need not be deallocated
* as its lifetime will be the same as the checkpoint object.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
const char *
virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint)
*
* Returns the domain or NULL.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
virDomainPtr
virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint)
*
* Returns the connection or NULL.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
virConnectPtr
virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint)
* Returns an (opaque) new virDomainCheckpointPtr on success or NULL
* on failure.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
virDomainCheckpointPtr
virDomainCheckpointCreateXML(virDomainPtr domain,
* Returns a 0 terminated UTF-8 encoded XML instance or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
char *
virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint,
* responsible for calling virDomainCheckpointFree() on each array element,
* then calling free() on @checkpoints.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
int
virDomainListAllCheckpoints(virDomainPtr domain,
* for calling virDomainCheckpointFree() on each array element, then calling
* free() on @children.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
int
virDomainCheckpointListAllChildren(virDomainCheckpointPtr checkpoint,
* domain checkpoint cannot be found, then the VIR_ERR_NO_DOMAIN_CHECKPOINT
* error is raised.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
virDomainCheckpointPtr
virDomainCheckpointLookupByName(virDomainPtr domain,
* given checkpoint is a root (no parent), then the VIR_ERR_NO_DOMAIN_CHECKPOINT
* error is raised.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
virDomainCheckpointPtr
virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint,
*
* Returns 0 on success, -1 on error.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
int
virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
int
virDomainCheckpointRef(virDomainCheckpointPtr checkpoint)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v5.6.0
+ * Since: 5.6.0
*/
int
virDomainCheckpointFree(virDomainCheckpointPtr checkpoint)
* Returns a pointer to the name or NULL, the string need not be deallocated
* as its lifetime will be the same as the snapshot object.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
const char *
virDomainSnapshotGetName(virDomainSnapshotPtr snapshot)
*
* Returns the domain or NULL.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
virDomainPtr
virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot)
*
* Returns the connection or NULL.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
virConnectPtr
virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot)
* Returns an (opaque) new virDomainSnapshotPtr on success or NULL on
* failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
* Returns a 0 terminated UTF-8 encoded XML instance or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
char *
virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,
*
* Returns the number of domain snapshots found or -1 in case of error.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
* Returns the number of domain snapshots found or -1 in case of error.
* The caller is responsible to call free() for each member of the array.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen,
* for calling virDomainSnapshotFree() on each array element, then calling
* free() on @snaps.
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
int
virDomainListAllSnapshots(virDomainPtr domain, virDomainSnapshotPtr **snaps,
*
* Returns the number of domain snapshots found or -1 in case of error.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
int
virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int flags)
* Returns the number of domain snapshots found or -1 in case of error.
* The caller is responsible to call free() for each member of the array.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
int
virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot,
* for calling virDomainSnapshotFree() on each array element, then calling
* free() on @snaps.
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
int
virDomainSnapshotListAllChildren(virDomainSnapshotPtr snapshot,
* domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
* error is raised.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virDomainSnapshotPtr
virDomainSnapshotLookupByName(virDomainPtr domain,
*
* Returns 1 if such snapshot exists, 0 if it doesn't, -1 on error.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags)
* current domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
* error is raised.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virDomainSnapshotPtr
virDomainSnapshotCurrent(virDomainPtr domain,
* given snapshot is a root (no parent), then the VIR_ERR_NO_DOMAIN_SNAPSHOT
* error is raised.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
virDomainSnapshotPtr
virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot,
*
* Returns 1 if current, 0 if not current, or -1 on error.
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
int
virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot,
* Returns 1 if the snapshot has metadata, 0 if the snapshot exists without
* help from libvirt, or -1 on error.
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
int
virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot,
*
* Returns 0 if the creation is successful, -1 on error.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
* Returns 0 if the selected snapshot(s) were successfully deleted,
* -1 on error.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
int
virDomainSnapshotRef(virDomainSnapshotPtr snapshot)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainSnapshotFree(virDomainSnapshotPtr snapshot)
* that all currently active domains were listed if the return is less
* than @maxids.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
*
* Returns the number of domain found or -1 in case of error
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virConnectNumOfDomains(virConnectPtr conn)
*
* Returns the virConnectPtr or NULL in case of failure.
*
- * Since: v0.3.0
+ * Since: 0.3.0
*/
virConnectPtr
virDomainGetConnect(virDomainPtr dom)
*
* Returns a new domain object or NULL in case of failure
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
virDomainPtr
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
*
* Returns a new domain object or NULL in case of failure
*
- * Since: v1.1.1
+ * Since: 1.1.1
*/
virDomainPtr
virDomainCreateXMLWithFiles(virConnectPtr conn, const char *xmlDesc,
*
* Returns a new domain object or NULL in case of failure
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
* 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.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
virDomainPtr
virDomainLookupByID(virConnectPtr conn, int id)
* 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.
*
- * Since: v0.0.5
+ * Since: 0.0.5
*/
virDomainPtr
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* 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.
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
* 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.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
virDomainPtr
virDomainLookupByName(virConnectPtr conn, const char *name)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainDestroy(virDomainPtr domain)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainDestroyFlags(virDomainPtr domain,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainFree(virDomainPtr domain)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.6.0
+ * Since: 0.6.0
*/
int
virDomainRef(virDomainPtr domain)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainSuspend(virDomainPtr domain)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainResume(virDomainPtr domain)
* Returns: 0 on success,
* -1 on failure.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virDomainPMSuspendForDuration(virDomainPtr dom,
* Returns: 0 on success,
* -1 on failure.
*
- * Since: v0.9.11
+ * Since: 0.9.11
*/
int
virDomainPMWakeup(virDomainPtr dom,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainSave(virDomainPtr domain, const char *to)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainSaveFlags(virDomainPtr domain, const char *to,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainRestore(virConnectPtr conn, const char *from)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainRestoreFlags(virConnectPtr conn, const char *from, const char *dxml,
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of
* error. The caller must free() the returned value.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
char *
virDomainSaveImageGetXMLDesc(virConnectPtr conn, const char *file,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainSaveImageDefineXML(virConnectPtr conn, const char *file,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.1.9
+ * Since: 0.1.9
*/
int
virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
int
virDomainCoreDumpWithFormat(virDomainPtr domain, const char *to,
* Returns a string representing the mime-type of the image format, or
* NULL upon error. The caller must free() the returned value.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
char *
virDomainScreenshot(virDomainPtr domain,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainShutdown(virDomainPtr domain)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virDomainShutdownFlags(virDomainPtr domain, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
int
virDomainReboot(virDomainPtr domain, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
int
virDomainReset(virDomainPtr domain, unsigned int flags)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the domain object.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
const char *
virDomainGetName(virDomainPtr domain)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.0.5
+ * Since: 0.0.5
*/
int
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
*
* Returns the domain ID number or (unsigned int) -1 in case of error
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
unsigned int
virDomainGetID(virDomainPtr domain)
* Returns the new string or NULL in case of error, the string must be
* freed by the caller.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
char *
virDomainGetOSType(virDomainPtr domain)
* Returns the memory size in kibibytes (blocks of 1024 bytes), or 0 in
* case of error.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
unsigned long
virDomainGetMaxMemory(virDomainPtr domain)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int
virDomainSetMemoryFlags(virDomainPtr domain, unsigned long memory,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v1.1.1
+ * Since: 1.1.1
*/
int
virDomainSetMemoryStatsPeriod(virDomainPtr domain, int period,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
int
virDomainSetMemoryParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
int
virDomainGetMemoryParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
int
virDomainSetNumaParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
int
virDomainGetNumaParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int
virDomainSetBlkioParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int
virDomainGetBlkioParameters(virDomainPtr domain,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virDomainGetState(virDomainPtr domain,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virDomainGetControlInfo(virDomainPtr domain,
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
char *
virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
char *
virConnectDomainXMLFromNative(virConnectPtr conn,
* Returns a 0 terminated UTF-8 encoded native config datafile, or
* NULL in case of error. The caller must free() the returned value.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
char *
virConnectDomainXMLToNative(virConnectPtr conn,
* or NULL in case of error. Note that the new domain object
* exists in the scope of the destination connection (dconn).
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
virDomainPtr
virDomainMigrate(virDomainPtr domain,
* or NULL in case of error. Note that the new domain object
* exists in the scope of the destination connection (dconn).
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
virDomainPtr
virDomainMigrate2(virDomainPtr domain,
* or NULL in case of error. Note that the new domain object
* exists in the scope of the destination connection (dconn).
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
virDomainPtr
virDomainMigrate3(virDomainPtr domain,
*
* Returns 0 if the migration succeeded, -1 upon error.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virDomainMigrateToURI(virDomainPtr domain,
*
* Returns 0 if the migration succeeded, -1 upon error.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virDomainMigrateToURI2(virDomainPtr domain,
*
* Returns 0 if the migration succeeded, -1 upon error.
*
- * Since: v1.1.0
+ * Since: 1.1.0
*/
int
virDomainMigrateToURI3(virDomainPtr domain,
*
* Returns NULL in case of error. The caller must free the returned string.
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
int
virDomainGetSchedulerParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virDomainGetSchedulerParametersFlags(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.2.3
+ * Since: 0.2.3
*/
int
virDomainSetSchedulerParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virDomainSetSchedulerParametersFlags(virDomainPtr domain,
*
* Returns: 0 in case of success or -1 in case of failure.
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
int
virDomainBlockStats(virDomainPtr dom, const char *disk,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
int
virDomainBlockStatsFlags(virDomainPtr dom,
*
* Returns: 0 in case of success or -1 in case of failure.
*
- * Since: v0.3.2
+ * Since: 0.3.2
*/
int
virDomainInterfaceStats(virDomainPtr dom, const char *device,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
int
virDomainSetInterfaceParameters(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.9
+ * Since: 0.9.9
*/
int
virDomainGetInterfaceParameters(virDomainPtr domain,
*
* Returns: The number of stats provided or -1 in case of failure.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
int
virDomainMemoryStats(virDomainPtr dom, virDomainMemoryStatPtr stats,
*
* Returns: 0 in case of success or -1 in case of failure.
*
- * Since: v0.4.3
+ * Since: 0.4.3
*/
int
virDomainBlockPeek(virDomainPtr dom,
*
* Returns: 0 in case of success or -1 in case of failure.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
int
virDomainBlockResize(virDomainPtr dom,
*
* Returns: 0 in case of success or -1 in case of failure.
*
- * Since: v0.4.3
+ * Since: 0.4.3
*/
int
virDomainMemoryPeek(virDomainPtr dom,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.8.1
+ * Since: 0.8.1
*/
int
virDomainGetBlockInfo(virDomainPtr domain, const char *disk,
*
* Returns NULL in case of error, a pointer to the domain otherwise
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml)
*
* Returns NULL in case of error, a pointer to the domain otherwise
*
- * Since: v1.2.12
+ * Since: 1.2.12
*/
virDomainPtr
virDomainDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
int
virDomainUndefine(virDomainPtr domain)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainUndefineFlags(virDomainPtr domain,
*
* Returns the number of domain found or -1 in case of error
*
- * Since: v0.1.5
+ * Since: 0.1.5
*/
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
* guaranteed that all currently defined domains were listed if the return
* is less than @maxids. The client must call free() on each returned name.
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
int
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
* make iteration easier. The caller is responsible for calling virDomainFree()
* on each array element, then calling free() on @domains.
*
- * Since: v0.9.13
+ * Since: 0.9.13
*/
int
virConnectListAllDomains(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.1.1
+ * Since: 0.1.1
*/
int
virDomainCreate(virDomainPtr domain)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.8.2
+ * Since: 0.8.2
*/
int
virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v1.1.1
+ * Since: 1.1.1
*/
int
virDomainCreateWithFiles(virDomainPtr domain, unsigned int nfiles,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
int
virDomainGetAutostart(virDomainPtr domain,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
int
virDomainSetAutostart(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virDomainInjectNMI(virDomainPtr domain, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virDomainSendKey(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v1.0.1
+ * Since: 1.0.1
*/
int
virDomainSendProcessSignal(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
int
virDomainSetVcpusFlags(virDomainPtr domain, unsigned int nvcpus,
*
* Returns the number of vCPUs in case of success, -1 in case of failure.
*
- * Since: v0.8.5
+ * Since: 0.8.5
*/
int
virDomainGetVcpusFlags(virDomainPtr domain, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virDomainPinVcpuFlags(virDomainPtr domain, unsigned int vcpu,
* Returns the number of virtual CPUs in case of success,
* -1 in case of failure.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virDomainGetVcpuPinInfo(virDomainPtr domain, int ncpumaps,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
int
virDomainPinEmulator(virDomainPtr domain, unsigned char *cpumap,
* 0 in case of no emulator threads are pined to pcpus,
* -1 in case of failure.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
int
virDomainGetEmulatorPinInfo(virDomainPtr domain, unsigned char *cpumap,
*
* Returns the number of info filled in case of success, -1 in case of failure.
*
- * Since: v0.1.4
+ * Since: 0.1.4
*/
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
*
* Returns the maximum of virtual CPU or -1 in case of error.
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
int
virDomainGetMaxVcpus(virDomainPtr domain)
* responsible for calling virDomainIOThreadInfoFree() on each array element,
* then calling free() on @info. On error, @info is set to NULL.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
int
virDomainGetIOThreadInfo(virDomainPtr dom,
*
* Frees the memory used by @info.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
void
virDomainIOThreadInfoFree(virDomainIOThreadInfoPtr info)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
int
virDomainPinIOThread(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v1.2.15
+ * Since: 1.2.15
*/
int
virDomainAddIOThread(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v1.2.15
+ * Since: 1.2.15
*/
int
virDomainDelIOThread(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v4.10.0
+ * Since: 4.10.0
*/
int
virDomainSetIOThreadParams(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
*
* Returns number of elements in @seclabels on success, -1 in case of failure.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
int
virDomainGetSecurityLabelList(virDomainPtr domain,
*
* Returns 0 on success, -1 in case of failure.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virDomainSetMetadata(virDomainPtr domain,
* Returns the metadata string on success (caller must free),
* or NULL in case of failure.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
char *
virDomainGetMetadata(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.1.9
+ * Since: 0.1.9
*/
int
virDomainAttachDevice(virDomainPtr domain, const char *xml)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
int
virDomainAttachDeviceFlags(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.1.9
+ * Since: 0.1.9
*/
int
virDomainDetachDevice(virDomainPtr domain, const char *xml)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
int
virDomainDetachDeviceFlags(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainUpdateDeviceFlags(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v4.4.0
+ * Since: 4.4.0
*/
int
virDomainDetachDeviceAlias(virDomainPtr domain,
* sometimes returned a positive number on success, but without any reliable
* semantics on what that number represents.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virConnectDomainEventRegister(virConnectPtr conn,
* sometimes returned a positive number on success, but without any reliable
* semantics on what that number represents.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virConnectDomainEventDeregister(virConnectPtr conn,
*
* Returns 1 if running, 0 if inactive, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virDomainIsActive(virDomainPtr dom)
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virDomainIsPersistent(virDomainPtr dom)
*
* Returns 0 if successfully renamed, -1 on error
*
- * Since: v1.2.19
+ * Since: 1.2.19
*/
int
virDomainRename(virDomainPtr dom,
*
* Returns 1 if updated, 0 if not, -1 on error
*
- * Since: v0.8.6
+ * Since: 0.8.6
*/
int
virDomainIsUpdated(virDomainPtr dom)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
int
virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
int
virDomainGetJobStats(virDomainPtr domain,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
int
virDomainAbortJob(virDomainPtr domain)
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainMigrateSetMaxDowntime(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v3.7.0
+ * Since: 3.7.0
*/
int
virDomainMigrateGetMaxDowntime(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
int
virDomainMigrateGetCompressionCache(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
int
virDomainMigrateSetCompressionCache(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int
virDomainMigrateSetMaxSpeed(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v0.9.5
+ * Since: 0.9.5
*/
int
virDomainMigrateGetMaxSpeed(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
int
virDomainMigrateStartPostCopy(virDomainPtr domain,
*
* Returns a callback identifier on success, -1 on failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virConnectDomainEventRegisterAny(virConnectPtr conn,
* sometimes returned a positive number on success, but without any reliable
* semantics on what that number represents.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virConnectDomainEventDeregisterAny(virConnectPtr conn,
*
* Returns 0 in case of success or -1 in case of failure
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainManagedSave(virDomainPtr dom, unsigned int flags)
* Returns 0 if no image is present, 1 if an image is present, and
* -1 in case of error
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainHasManagedSaveImage(virDomainPtr dom, unsigned int flags)
*
* Returns 0 in case of success, and -1 in case of error
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of
* error. The caller must free() the returned value.
*
- * Since: v3.7.0
+ * Since: 3.7.0
*/
char *
virDomainManagedSaveGetXMLDesc(virDomainPtr domain, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v3.7.0
+ * Since: 3.7.0
*/
int
virDomainManagedSaveDefineXML(virDomainPtr domain, const char *dxml,
*
* Returns 0 if the console was opened, -1 on error
*
- * Since: v0.8.6
+ * Since: 0.8.6
*/
int
virDomainOpenConsole(virDomainPtr dom,
*
* Returns 0 if the channel was opened, -1 on error
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virDomainOpenChannel(virDomainPtr dom,
*
* Returns -1 in case of failure, 0 in case of success.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
int virDomainGetPerfEvents(virDomainPtr domain,
virTypedParameterPtr *params,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v1.3.3
+ * Since: 1.3.3
*/
int virDomainSetPerfEvents(virDomainPtr domain,
virTypedParameterPtr params,
*
* Returns -1 in case of failure, 0 when successful.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
*
* Returns -1 in case of failure, 0 when nothing found, 1 when info was found.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk,
*
* Returns -1 in case of failure, 0 when successful.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk,
*
* Returns 0 if the operation has started, -1 on failure.
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
int
virDomainBlockPull(virDomainPtr dom, const char *disk,
*
* Returns 0 if the operation has started, -1 on failure.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virDomainBlockRebase(virDomainPtr dom, const char *disk,
*
* Returns 0 if the operation has started, -1 on failure.
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
int
virDomainBlockCopy(virDomainPtr dom, const char *disk,
*
* Returns 0 if the operation has started, -1 on failure.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virDomainBlockCommit(virDomainPtr dom, const char *disk,
*
* Returns 0 on success, -1 on failure
*
- * Since: v0.9.7
+ * Since: 0.9.7
*/
int
virDomainOpenGraphics(virDomainPtr dom,
*
* Returns an fd on success, -1 on failure
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
int
virDomainOpenGraphicsFD(virDomainPtr dom,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
int
virDomainSetBlockIoTune(virDomainPtr dom,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
int
virDomainGetBlockIoTune(virDomainPtr dom,
* @ncpus is too large). The caller is responsible for freeing any
* returned string parameters.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virDomainGetCPUStats(virDomainPtr domain,
* Returns number of disks with errors filled in the @errors array or -1 on
* error.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virDomainGetDiskErrors(virDomainPtr dom,
* Returns the hostname which must be freed by the caller, or
* NULL if there was an error.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
char *
virDomainGetHostname(virDomainPtr domain, unsigned int flags)
*
* Returns 0 on success, -1 otherwise.
*
- * Since: v1.0.1
+ * Since: 1.0.1
*/
int
virDomainFSTrim(virDomainPtr dom,
*
* Returns the number of frozen filesystems on success, -1 otherwise.
*
- * Since: v1.2.5
+ * Since: 1.2.5
*/
int
virDomainFSFreeze(virDomainPtr dom,
*
* Returns the number of thawed filesystems on success, -1 otherwise.
*
- * Since: v1.2.5
+ * Since: 1.2.5
*/
int
virDomainFSThaw(virDomainPtr dom,
*
* Returns 0 on success, -1 otherwise.
*
- * Since: v1.2.5
+ * Since: 1.2.5
*/
int
virDomainGetTime(virDomainPtr dom,
*
* Returns 0 on success, -1 otherwise.
*
- * Since: v1.2.5
+ * Since: 1.2.5
*/
int
virDomainSetTime(virDomainPtr dom,
*
* Returns 0 on success, -1 otherwise.
*
- * Since: v1.2.16
+ * Since: 1.2.16
*/
int
virDomainSetUserPassword(virDomainPtr dom,
* Returns NULL in case of error or an XML string
* defining the capabilities.
*
- * Since: v1.2.7
+ * Since: 1.2.7
*/
char *
virConnectGetDomainCapabilities(virConnectPtr conn,
* The requested data are returned in the @retStats parameter. The returned
* array should be freed by the caller. See virDomainStatsRecordListFree.
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
int
virConnectGetAllDomainStats(virConnectPtr conn,
* Note that the count of returned stats may be less than the domain count
* provided via @doms.
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
int
virDomainListGetStats(virDomainPtr *doms,
* Convenience function to free a list of domain stats returned by
* virDomainListGetStats and virConnectGetAllDomainStats.
*
- * Since: v1.2.8
+ * Since: 1.2.8
*/
void
virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats)
* responsible for calling virDomainFSInfoFree() on each array element, then
* calling free() on @info. On error, @info is set to NULL.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
int
virDomainGetFSInfo(virDomainPtr dom,
*
* Frees all the memory occupied by @info.
*
- * Since: v1.2.11
+ * Since: 1.2.11
*/
void
virDomainFSInfoFree(virDomainFSInfoPtr info)
*
* Returns the number of interfaces on success, -1 in case of error.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
int
virDomainInterfaceAddresses(virDomainPtr dom,
* freed and should not be used thereafter. If @iface
* is NULL, then this method has no effect.
*
- * Since: v1.2.14
+ * Since: 1.2.14
*/
void
virDomainInterfaceFree(virDomainInterfacePtr iface)
*
* Returns 0 on success, -1 on error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virDomainGetGuestVcpus(virDomainPtr domain,
*
* Returns 0 on success, -1 on error.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virDomainSetGuestVcpus(virDomainPtr domain,
*
* Returns 0 on success, -1 on error.
*
- * Since: v3.1.0
+ * Since: 3.1.0
*/
int
virDomainSetVcpu(virDomainPtr domain,
*
* Returns 0 on success, -1 on error.
*
- * Since: v5.7.0
+ * Since: 5.7.0
*/
int virDomainGetGuestInfo(virDomainPtr domain,
unsigned int types,
*
* Returns 0 if the operation has started, -1 on failure.
*
- * Since: v3.2.0
+ * Since: 3.2.0
*/
int
virDomainSetBlockThreshold(virDomainPtr domain,
*
* Returns 0 on success, -1 on failure.
*
- * Since: v3.9.0
+ * Since: 3.9.0
*/
int virDomainSetLifecycleAction(virDomainPtr domain,
unsigned int type,
*
* Returns -1 in case of failure, 0 in case of success.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int virDomainGetLaunchSecurityInfo(virDomainPtr domain,
virTypedParameterPtr *params,
*
* Returns -1 in case of failure, 0 in case of success.
*
- * Since: v8.0.0
+ * Since: 8.0.0
*/
int virDomainSetLaunchSecurityState(virDomainPtr domain,
virTypedParameterPtr params,
*
* Returns 0 on success, -1 on failure
*
- * Since: v5.10.0
+ * Since: 5.10.0
*/
int
virDomainAgentSetResponseTimeout(virDomainPtr domain,
*
* Returns 0 on success or -1 on failure.
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
int
virDomainBackupBegin(virDomainPtr domain,
* Returns a NUL-terminated UTF-8 encoded XML instance or NULL in
* case of error. The caller must free() the returned value.
*
- * Since: v6.0.0
+ * Since: 6.0.0
*/
char *
virDomainBackupGetXMLDesc(virDomainPtr domain,
* Returns: number of keys stored in @keys,
* -1 otherwise.
*
- * Since: v6.10.0
+ * Since: 6.10.0
*/
int
virDomainAuthorizedSSHKeysGet(virDomainPtr domain,
* Returns: 0 on success,
* -1 otherwise.
*
- * Since: v6.10.0
+ * Since: 6.10.0
*/
int
virDomainAuthorizedSSHKeysSet(virDomainPtr domain,
* Returns: number of messages stored in @msgs,
* -1 otherwise.
*
- * Since: v7.1.0
+ * Since: 7.1.0
*/
int
virDomainGetMessages(virDomainPtr domain,
*
* Returns 0 in case of success, -1 otherwise.
*
- * Since: v7.2.0
+ * Since: 7.2.0
*/
int
virDomainStartDirtyRateCalc(virDomainPtr domain,
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v0.6.0
+ * Since: 0.6.0
*/
int
virConnectRef(virConnectPtr conn)
*
* Returns: 0 if the identity change was accepted, -1 on error
*
- * Since: v5.8.0
+ * Since: 5.8.0
*/
int
virConnectSetIdentity(virConnectPtr conn,
*
* Returns NULL in case of error, a static zero terminated string otherwise.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
const char *
virConnectGetType(virConnectPtr conn)
* extracted by lack of capacities returns 0 and @hvVer is 0, otherwise
* @hvVer value is major * 1,000,000 + minor * 1,000 + release
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
* Returns -1 in case of failure, 0 otherwise, and values for @libVer have
* the format major * 1,000,000 + minor * 1,000 + release.
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer)
* Returns the hostname which must be freed by the caller, or
* NULL if there was an error.
*
- * Since: v0.3.0
+ * Since: 0.3.0
*/
char *
virConnectGetHostname(virConnectPtr conn)
* Returns the URI string which must be freed by the caller, or
* NULL if there was an error.
*
- * Since: v0.3.0
+ * Since: 0.3.0
*/
char *
virConnectGetURI(virConnectPtr conn)
* Returns the XML string which must be freed by the caller, or
* NULL if there was an error.
*
- * Since: v0.8.8
+ * Since: 0.8.8
*/
char *
virConnectGetSysinfo(virConnectPtr conn, unsigned int flags)
*
* Returns the maximum of virtual CPU or -1 in case of error.
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
int
virConnectGetMaxVcpus(virConnectPtr conn,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
int
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
* defining the capabilities.
* The client must free the returned string after use.
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
char *
virConnectGetCapabilities(virConnectPtr conn)
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virNodeGetCPUStats(virConnectPtr conn,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virNodeGetMemoryStats(virConnectPtr conn,
*
* Returns the available free memory in bytes or 0 in case of error
*
- * Since: v0.3.3
+ * Since: 0.3.3
*/
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
* delay), -1 on failure (the operation is not supported, or an attempted
* suspend is already underway).
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
int
virNodeSuspendForDuration(virConnectPtr conn,
*
* Returns 0 in case of success, and -1 in case of failure.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virNodeGetMemoryParameters(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virNodeSetMemoryParameters(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
*
* Returns the number of entries filled in freeMems, or -1 in case of error.
*
- * Since: v0.3.3
+ * Since: 0.3.3
*/
int
virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems,
*
* Returns 1 if encrypted, 0 if not encrypted, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virConnectIsEncrypted(virConnectPtr conn)
*
* Returns 1 if secure, 0 if not secure, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virConnectIsSecure(virConnectPtr conn)
* VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details about
* the incompatibility.
*
- * Since: v0.7.5
+ * Since: 0.7.5
*/
int
virConnectCompareCPU(virConnectPtr conn,
* VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details about
* the incompatibility.
*
- * Since: v4.4.0
+ * Since: 4.4.0
*/
int
virConnectCompareHypervisorCPU(virConnectPtr conn,
* Returns -1 on error, number of elements in @models on success (0 means
* libvirt accepts any CPU model).
*
- * Since: v1.1.3
+ * Since: 1.1.3
*/
int
virConnectGetCPUModelNames(virConnectPtr conn, const char *arch, char ***models,
*
* Returns XML description of the computed CPU (caller frees) or NULL on error.
*
- * Since: v0.7.7
+ * Since: 0.7.7
*/
char *
virConnectBaselineCPU(virConnectPtr conn,
*
* Returns XML description of the computed CPU (caller frees) or NULL on error.
*
- * Since: v4.4.0
+ * Since: 4.4.0
*/
char *
virConnectBaselineHypervisorCPU(virConnectPtr conn,
* Returns -1 on error, 0 on success, 1 when remote party doesn't support
* keepalive messages.
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
int
virConnectSetKeepAlive(virConnectPtr conn,
*
* Returns 1 if alive, 0 if dead, -1 on error
*
- * Since: v0.9.8
+ * Since: 0.9.8
*/
int
virConnectIsAlive(virConnectPtr conn)
*
* Returns 0 on success, -1 on error
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
int
virConnectRegisterCloseCallback(virConnectPtr conn,
*
* Returns 0 on success, -1 on error
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
int
virConnectUnregisterCloseCallback(virConnectPtr conn,
* Returns number of CPUs present on the host node,
* or -1 if there was an error.
*
- * Since: v1.0.0
+ * Since: 1.0.0
*/
int
virNodeGetCPUMap(virConnectPtr conn,
*
* Returns: the number of entries filled in @counts or -1 in case of error.
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
int
virNodeGetFreePages(virConnectPtr conn,
* Returns: the number of nodes successfully adjusted or -1 in
* case of an error.
*
- * Since: v1.2.9
+ * Since: 1.2.9
*/
int
virNodeAllocPages(virConnectPtr conn,
*
* Returns 0 in case of success, and -1 in case of failure.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virNodeGetSEVInfo(virConnectPtr conn,
*
* Returns the virConnectPtr or NULL in case of failure.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
virConnectPtr
virInterfaceGetConnect(virInterfacePtr iface)
* to make iteration easier. The caller is responsible for calling
* virStorageInterfaceFree() on each array element, then calling free() on @ifaces.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virConnectListAllInterfaces(virConnectPtr conn,
*
* Returns the number of active interfaces found or -1 in case of error
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virConnectNumOfInterfaces(virConnectPtr conn)
* all currently active interfaces were listed if the return is less than
* @maxnames. The client must call free() on each returned name.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
*
* Returns the number of defined interface found or -1 in case of error
*
- * Since: v0.7.0
+ * Since: 0.7.0
*/
int
virConnectNumOfDefinedInterfaces(virConnectPtr conn)
* guaranteed that all currently defined interfaces were listed if the return
* is less than @maxnames. The client must call free() on each returned name.
*
- * Since: v0.7.0
+ * Since: 0.7.0
*/
int
virConnectListDefinedInterfaces(virConnectPtr conn,
* Returns a new interface object or NULL in case of failure. If the
* interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
virInterfacePtr
virInterfaceLookupByName(virConnectPtr conn, const char *name)
* Returns a new interface object or NULL in case of failure. If the
* interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
virInterfacePtr
virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the interface object.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
const char *
virInterfaceGetName(virInterfacePtr iface)
* format) or NULL, the string need not be deallocated its lifetime
* will be the same as the interface object.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
const char *
virInterfaceGetMACString(virInterfacePtr iface)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
char *
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
*
* Returns NULL in case of error, a pointer to the interface otherwise
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virInterfaceUndefine(virInterfacePtr iface)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virInterfaceRef(virInterfacePtr iface)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
int
virInterfaceFree(virInterfacePtr iface)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.9.2
+ * Since: 0.9.2
*/
int
virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags)
*
* Returns 1 if running, 0 if inactive, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virInterfaceIsActive(virInterfacePtr iface)
*
* Returns the number of opened file descriptors, or -1 on error
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virDomainLxcOpenNamespace(virDomainPtr domain,
*
* Returns 0 on success, -1 on error
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virDomainLxcEnterNamespace(virDomainPtr domain,
*
* Returns 0 on success, -1 on error
*
- * Since: v1.0.4
+ * Since: 1.0.4
*/
int
virDomainLxcEnterSecurityLabel(virSecurityModelPtr model,
*
* Returns 0 on success, -1 on error
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int virDomainLxcEnterCGroup(virDomainPtr domain,
unsigned int flags)
*
* Returns the virConnectPtr or NULL in case of failure.
*
- * Since: v0.3.0
+ * Since: 0.3.0
*/
virConnectPtr
virNetworkGetConnect(virNetworkPtr net)
* to make iteration easier. The caller is responsible for calling
* virNetworkFree() on each array element, then calling free() on @nets.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virConnectListAllNetworks(virConnectPtr conn,
*
* Returns the number of network found or -1 in case of error
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virConnectNumOfNetworks(virConnectPtr conn)
* all currently active networks were listed if the return is less than
* @maxnames. The client must call free() on each returned name.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
*
* Returns the number of networks found or -1 in case of error
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virConnectNumOfDefinedNetworks(virConnectPtr conn)
* guaranteed that all currently defined networks were listed if the return
* is less than @maxnames. The client must call free() on each returned name.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
* Returns a new network object or NULL in case of failure. If the
* network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
* Returns a new network object or NULL in case of failure. If the
* network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* Returns a new network object or NULL in case of failure. If the
* network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
*
* Returns a new network object or NULL in case of failure
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
virNetworkPtr
virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc)
*
* Returns a new network object or NULL in case of failure
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
virNetworkPtr
virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags)
*
* Returns NULL in case of error, a pointer to the network otherwise
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
virNetworkPtr
virNetworkDefineXML(virConnectPtr conn, const char *xml)
*
* Returns NULL in case of error, a pointer to the network otherwise
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
virNetworkPtr
virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virNetworkUndefine(virNetworkPtr network)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virNetworkUpdate(virNetworkPtr network,
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virNetworkCreate(virNetworkPtr network)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virNetworkDestroy(virNetworkPtr network)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virNetworkFree(virNetworkPtr network)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.0
+ * Since: 0.6.0
*/
int
virNetworkRef(virNetworkPtr network)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the network object.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
const char *
virNetworkGetName(virNetworkPtr network)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
int
virNetworkGetUUIDString(virNetworkPtr network, char *buf)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
char *
virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
* Returns a 0 terminated interface name, or NULL in case of
* error. The caller must free() the returned value.
*
- * Since: v0.2.0
+ * Since: 0.2.0
*/
char *
virNetworkGetBridgeName(virNetworkPtr network)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
int
virNetworkGetAutostart(virNetworkPtr network,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.2.1
+ * Since: 0.2.1
*/
int
virNetworkSetAutostart(virNetworkPtr network,
*
* Returns 1 if running, 0 if inactive, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virNetworkIsActive(virNetworkPtr net)
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virNetworkIsPersistent(virNetworkPtr net)
*
* Returns a callback identifier on success, -1 on failure.
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
int
virConnectNetworkEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure
*
- * Since: v1.2.1
+ * Since: 1.2.1
*/
int
virConnectNetworkEventDeregisterAny(virConnectPtr conn,
* Returns the number of leases found or -1 and sets @leases to NULL in
* case of error.
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
int
virNetworkGetDHCPLeases(virNetworkPtr network,
*
* Frees all the memory occupied by @lease.
*
- * Since: v1.2.6
+ * Since: 1.2.6
*/
void
virNetworkDHCPLeaseFree(virNetworkDHCPLeasePtr lease)
* Returns a new network port object or NULL in case of failure. If the
* network port cannot be found, then VIR_ERR_NO_NETWORK_PORT error is raised.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
virNetworkPortPtr
virNetworkPortLookupByUUID(virNetworkPtr net,
* Returns a new network port object or NULL in case of failure. If the
* network port cannot be found, then VIR_ERR_NO_NETWORK_PORT error is raised.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
virNetworkPortPtr
virNetworkPortLookupByUUIDString(virNetworkPtr net,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortSetParameters(virNetworkPortPtr port,
*
* Returns -1 in case of error, 0 in case of success.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortGetParameters(virNetworkPortPtr port,
*
* Returns a new network port object or NULL in case of failure
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
virNetworkPortPtr
virNetworkPortCreateXML(virNetworkPtr net,
*
* Returns the virNetworkPtr or NULL in case of failure.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
virNetworkPtr
virNetworkPortGetNetwork(virNetworkPortPtr port)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
char *
virNetworkPortGetXMLDesc(virNetworkPortPtr port,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortGetUUID(virNetworkPortPtr port,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortDelete(virNetworkPortPtr port,
* for calling virNetworkPortFree() on each array element, then calling
* free() on @ports.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkListAllPorts(virNetworkPtr network,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortFree(virNetworkPortPtr port)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v5.5.0
+ * Since: 5.5.0
*/
int
virNetworkPortRef(virNetworkPortPtr port)
*
* Returns the number of node devices or -1 in case of error
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags)
* virNodeDeviceFree() on each array element, then calling free() on
* @devices.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virConnectListAllNodeDevices(virConnectPtr conn,
*
* Returns the number of node devices found or -1 in case of error
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virNodeListDevices(virConnectPtr conn,
*
* Returns a virNodeDevicePtr if found, NULL otherwise.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
virNodeDevicePtr
virNodeDeviceLookupByName(virConnectPtr conn, const char *name)
*
* Returns a virNodeDevicePtr if found, NULL otherwise.
*
- * Since: v1.0.3
+ * Since: 1.0.3
*/
virNodeDevicePtr
virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn,
*
* Returns the XML document, or NULL on error
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
char *
virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
*
* Returns the device name or NULL in case of error
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
const char *
virNodeDeviceGetName(virNodeDevicePtr dev)
* Returns the name of the device's parent, or NULL if an
* error occurred or when the device has no parent.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
const char *
virNodeDeviceGetParent(virNodeDevicePtr dev)
* Returns the number of capabilities supported by the device or -1
* in case of error.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
* Returns the number of capability names listed in @names or -1
* in case of error.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virNodeDeviceListCaps(virNodeDevicePtr dev,
*
* Returns the 0 for success, -1 for error.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
int
virNodeDeviceFree(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.0
+ * Since: 0.6.0
*/
int
virNodeDeviceRef(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
int
virNodeDeviceDettach(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v1.0.5
+ * Since: 1.0.5
*/
int
virNodeDeviceDetachFlags(virNodeDevicePtr dev,
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
int
virNodeDeviceReset(virNodeDevicePtr dev)
*
* Returns a node device object if successful, NULL in case of failure
*
- * Since: v0.6.3
+ * Since: 0.6.3
*/
virNodeDevicePtr
virNodeDeviceCreateXML(virConnectPtr conn,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.6.3
+ * Since: 0.6.3
*/
int
virNodeDeviceDestroy(virNodeDevicePtr dev)
*
* Returns a node device object if successful, NULL in case of failure
*
- * Since: v7.3.0
+ * Since: 7.3.0
*/
virNodeDevicePtr
virNodeDeviceDefineXML(virConnectPtr conn,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v7.3.0
+ * Since: 7.3.0
*/
int
virNodeDeviceUndefine(virNodeDevicePtr dev,
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v7.3.0
+ * Since: 7.3.0
*/
int
virNodeDeviceCreate(virNodeDevicePtr dev,
*
* Returns a callback identifier on success, -1 on failure.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
int
virConnectNodeDeviceEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure.
*
- * Since: v2.2.0
+ * Since: 2.2.0
*/
int
virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
int
virNodeDeviceSetAutostart(virNodeDevicePtr dev,
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
int
virNodeDeviceGetAutostart(virNodeDevicePtr dev,
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
int
virNodeDeviceIsPersistent(virNodeDevicePtr dev)
*
* Returns 1 if active, 0 if inactive, -1 on error
*
- * Since: v7.8.0
+ * Since: 7.8.0
*/
int virNodeDeviceIsActive(virNodeDevicePtr dev)
{
*
* Returns the number of nwfilters found or -1 in case of error
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virConnectNumOfNWFilters(virConnectPtr conn)
* to make iteration easier. The caller is responsible for calling
* virNWFilterFree() on each array element, then calling free() on @filters.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virConnectListAllNWFilters(virConnectPtr conn,
*
* Returns the number of network filters found or -1 in case of error
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnames)
* Returns a new nwfilter object or NULL in case of failure. If the
* network filter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virNWFilterPtr
virNWFilterLookupByName(virConnectPtr conn, const char *name)
* Returns a new nwfilter object or NULL in case of failure. If the
* nwfdilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virNWFilterPtr
virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* Returns a new nwfilter object or NULL in case of failure. If the
* nwfilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virNWFilterPtr
virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virNWFilterFree(virNWFilterPtr nwfilter)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the nwfilter object.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
const char *
virNWFilterGetName(virNWFilterPtr nwfilter)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf)
*
* Returns a new nwfilter object or NULL in case of failure
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
virNWFilterPtr
virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc)
*
* Returns a new nwfilter object or NULL in case of failure
*
- * Since: v7.7.0
+ * Since: 7.7.0
*/
virNWFilterPtr
virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virNWFilterUndefine(virNWFilterPtr nwfilter)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
char *
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virNWFilterRef(virNWFilterPtr nwfilter)
* to make iteration easier. The caller is responsible for calling
* virNWFilterFree() on each array element, then calling free() on @filters.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virConnectListAllNWFilterBindings(virConnectPtr conn,
* network filter cannot be found, then VIR_ERR_NO_NWFILTER_BINDING
* error is raised.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
virNWFilterBindingPtr
virNWFilterBindingLookupByPortDev(virConnectPtr conn, const char *portdev)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virNWFilterBindingFree(virNWFilterBindingPtr binding)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the binding object.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
const char *
virNWFilterBindingGetPortDev(virNWFilterBindingPtr binding)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the binding object.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
const char *
virNWFilterBindingGetFilterName(virNWFilterBindingPtr binding)
*
* Returns a new binding object or NULL in case of failure
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
virNWFilterBindingPtr
virNWFilterBindingCreateXML(virConnectPtr conn, const char *xml, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virNWFilterBindingDelete(virNWFilterBindingPtr binding)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
char *
virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virNWFilterBindingRef(virNWFilterBindingPtr binding)
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v0.8.3
+ * Since: 0.8.3
*/
int
virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd,
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v8.2.0
+ * Since: 8.2.0
*/
int
virDomainQemuMonitorCommandWithFiles(virDomainPtr domain,
*
* Returns a new domain object on success, NULL otherwise
*
- * Since: v0.9.4
+ * Since: 0.9.4
*/
virDomainPtr
virDomainQemuAttach(virConnectPtr conn,
*
* Returns strings if success, NULL in failure.
*
- * Since: v0.10.0
+ * Since: 0.10.0
*/
char *
virDomainQemuAgentCommand(virDomainPtr domain,
*
* Returns a callback identifier on success, -1 on failure
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
int
virConnectDomainQemuMonitorEventRegister(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure
*
- * Since: v1.2.3
+ * Since: 1.2.3
*/
int
virConnectDomainQemuMonitorEventDeregister(virConnectPtr conn,
*
* Returns the virConnectPtr or NULL in case of failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
virConnectPtr
virSecretGetConnect(virSecretPtr secret)
*
* Returns the number currently defined secrets.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virConnectNumOfSecrets(virConnectPtr conn)
* to make iteration easier. The caller is responsible for calling
* virSecretFree() on each array element, then calling free() on @secrets.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virConnectListAllSecrets(virConnectPtr conn,
*
* Returns the number of UUIDs provided in the array, or -1 on failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids)
* Returns a new secret object or NULL in case of failure. If the
* secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
virSecretPtr
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* Returns a new secret object or NULL in case of failure. If the
* secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
virSecretPtr
virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
* Returns a new secret object or NULL in case of failure. If the
* secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
virSecretPtr
virSecretLookupByUsage(virConnectPtr conn,
*
* Returns a secret on success, NULL on failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
virSecretPtr
virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
* Returns 0 on success with the uuid buffer being filled, or
* -1 upon failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretGetUUIDString(virSecretPtr secret, char *buf)
* Returns a positive integer identifying the type of object,
* or -1 upon error.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretGetUsageType(virSecretPtr secret)
* Returns a string identifying the object using the secret,
* or NULL upon error
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
const char *
virSecretGetUsageID(virSecretPtr secret)
* Returns the XML document on success, NULL on failure. The caller must
* free() the XML.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
char *
virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags)
*
* Returns 0 on success, -1 on failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretSetValue(virSecretPtr secret, const unsigned char *value,
* Returns the secret value on success, NULL on failure. The caller must
* free() the secret value.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
unsigned char *
virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags)
*
* Returns 0 on success, -1 on failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretUndefine(virSecretPtr secret)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretRef(virSecretPtr secret)
*
* Returns 0 on success, or -1 on error
*
- * Since: v0.7.1
+ * Since: 0.7.1
*/
int
virSecretFree(virSecretPtr secret)
*
* Returns a callback identifier on success, -1 on failure.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virConnectSecretEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure.
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virConnectSecretEventDeregisterAny(virConnectPtr conn,
*
* Returns the virConnectPtr or NULL in case of failure.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virConnectPtr
virStoragePoolGetConnect(virStoragePoolPtr pool)
* for calling virStoragePoolFree() on each array element, then calling
* free() on @pools.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virConnectListAllStoragePools(virConnectPtr conn,
*
* Returns the number of pools found, or -1 on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virConnectNumOfStoragePools(virConnectPtr conn)
* that all currently active pools were listed if the return is less than
* @maxnames. The client must call free() on each returned name.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virConnectListStoragePools(virConnectPtr conn,
*
* Returns the number of pools found, or -1 on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virConnectNumOfDefinedStoragePools(virConnectPtr conn)
* guaranteed that all currently defined pools were listed if the return
* is less than @maxnames. The client must call free() on each returned name.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virConnectListDefinedStoragePools(virConnectPtr conn,
* containing a source document appropriate to the given pool
* type for each discovered source.
*
- * Since: v0.4.5
+ * Since: 0.4.5
*/
char *
virConnectFindStoragePoolSources(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByName(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByUUID(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByUUIDString(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByVolume(virStorageVolPtr vol)
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
- * Since: v4.1.0
+ * Since: 4.1.0
*/
virStoragePoolPtr
virStoragePoolLookupByTargetPath(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if creation failed
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolCreateXML(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if creation failed
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
*
* Returns 0 on success, or -1 upon failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolBuild(virStoragePoolPtr pool,
*
* Returns 0 on success, -1 on failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolUndefine(virStoragePoolPtr pool)
*
* Returns 0 on success, or -1 if it could not be started
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolCreate(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 if it could not be destroyed
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolDestroy(virStoragePoolPtr pool)
*
* Returns 0 on success, or -1 if it could not be obliterate
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolDelete(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 if it could not be free'd.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolFree(virStoragePoolPtr pool)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.0
+ * Since: 0.6.0
*/
int
virStoragePoolRef(virStoragePoolPtr pool)
*
* Returns 0 if the volume list was refreshed, -1 on failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolRefresh(virStoragePoolPtr pool,
*
* Returns the name of the pool, or NULL on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
*
* Returns 0 on success, or -1 on error;
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 on error;
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 on failure.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
*
* Returns a XML document (caller frees), or NULL on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
*
* Returns 0 on success, -1 on failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
*
* Returns 0 on success, -1 on failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
* for calling virStorageVolFree() on each array element, then calling
* free() on @vols.
*
- * Since: v0.10.2
+ * Since: 0.10.2
*/
int
virStoragePoolListAllVolumes(virStoragePoolPtr pool,
*
* Returns the number of storage pools, or -1 on failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolNumOfVolumes(virStoragePoolPtr pool)
*
* Returns the number of names fetched, or -1 on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStoragePoolListVolumes(virStoragePoolPtr pool,
*
* Returns the virConnectPtr or NULL in case of failure.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virConnectPtr
virStorageVolGetConnect(virStorageVolPtr vol)
*
* Returns a storage volume, or NULL if not found / error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
*
* Returns a storage volume, or NULL if not found / error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
*
* Returns a storage volume, or NULL if not found / error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
*
* Returns the volume name, or NULL on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
const char*
virStorageVolGetName(virStorageVolPtr vol)
*
* Returns the volume key, or NULL on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
const char*
virStorageVolGetKey(virStorageVolPtr vol)
*
* Returns the storage volume, or NULL on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
*
* Returns the storage volume, or NULL on error
*
- * Since: v0.6.4
+ * Since: 0.6.4
*/
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
*
* Returns 0, or -1 upon error.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int
virStorageVolDownload(virStorageVolPtr vol,
*
* Returns 0, or -1 upon error.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int
virStorageVolUpload(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStorageVolDelete(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error
*
- * Since: v0.8.0
+ * Since: 0.8.0
*/
int
virStorageVolWipe(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virStorageVolWipePattern(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStorageVolFree(virStorageVolPtr vol)
*
* Returns 0 in case of success, -1 in case of failure.
*
- * Since: v0.6.0
+ * Since: 0.6.0
*/
int
virStorageVolRef(virStorageVolPtr vol)
*
* Returns 0 on success, or -1 on failure
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
int
virStorageVolGetInfo(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on failure
*
- * Since: v3.0.0
+ * Since: 3.0.0
*/
int
virStorageVolGetInfoFlags(virStorageVolPtr vol,
*
* Returns the XML document, or NULL on error
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
* Returns the storage volume path, or NULL on error. The
* caller must free() the returned path after use.
*
- * Since: v0.4.1
+ * Since: 0.4.1
*/
char *
virStorageVolGetPath(virStorageVolPtr vol)
*
* Returns 0 on success, or -1 on error.
*
- * Since: v0.9.10
+ * Since: 0.9.10
*/
int
virStorageVolResize(virStorageVolPtr vol,
*
* Returns 1 if running, 0 if inactive, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virStoragePoolIsActive(virStoragePoolPtr pool)
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
- * Since: v0.7.3
+ * Since: 0.7.3
*/
int
virStoragePoolIsPersistent(virStoragePoolPtr pool)
*
* Returns a callback identifier on success, -1 on failure.
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virConnectStoragePoolEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure
*
- * Since: v2.0.0
+ * Since: 2.0.0
*/
int
virConnectStoragePoolEventDeregisterAny(virConnectPtr conn,
*
* Returns NULL in case of error or an XML string defining the capabilities.
*
- * Since: v5.2.0
+ * Since: 5.2.0
*/
char *
virConnectGetStoragePoolCapabilities(virConnectPtr conn,
*
* Returns the new stream, or NULL upon error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
virStreamPtr
virStreamNew(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of failure
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamRef(virStreamPtr stream)
* Returns -2 if the outgoing transmit buffers are full &
* the stream is marked as non-blocking.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamSend(virStreamPtr stream,
* Returns -2 if there is no data pending to be read & the
* stream is marked as non-blocking.
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamRecv(virStreamPtr stream,
* Returns -3 if there is a hole in stream and caller requested
* to stop at a hole.
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
int
virStreamRecvFlags(virStreamPtr stream,
* Returns 0 on success,
* -1 error
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
int
virStreamSendHole(virStreamPtr stream,
* Returns 0 on success,
* -1 on error or when there's currently no hole in the stream
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
int
virStreamRecvHole(virStreamPtr stream,
* having been called, so the caller need only call
* virStreamFree().
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamSendAll(virStreamPtr stream,
* having been called, so the caller need only call
* virStreamFree().
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
int virStreamSparseSendAll(virStreamPtr stream,
virStreamSourceFunc handler,
* having been called, so the caller need only call
* virStreamFree()
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamRecvAll(virStreamPtr stream,
* Returns -1 upon any error, with virStreamAbort() already
* having been called, so the caller need only call virStreamFree().
*
- * Since: v3.4.0
+ * Since: 3.4.0
*/
int
virStreamSparseRecvAll(virStreamPtr stream,
*
* Returns 0 on success, -1 upon error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamEventAddCallback(virStreamPtr stream,
*
* Returns 0 on success, -1 if no callback is registered
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamEventUpdateCallback(virStreamPtr stream,
*
* Returns 0 on success, -1 on error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamEventRemoveCallback(virStreamPtr stream)
*
* Returns 0 on success, -1 upon error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamFinish(virStreamPtr stream)
*
* Returns 0 on success, -1 upon error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamAbort(virStreamPtr stream)
*
* Returns 0 upon success, or -1 on error
*
- * Since: v0.7.2
+ * Since: 0.7.2
*/
int
virStreamFree(virStreamPtr stream)
*
* Returns 0 in case of success, -1 in case of error
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
int
virInitialize(void)
* Returns -1 in case of failure, 0 otherwise, and values for @libVer and
* @typeVer have the format major * 1,000,000 + minor * 1,000 + release.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virGetVersion(unsigned long *libVer, const char *type G_GNUC_UNUSED,
*
* Returns a pointer to the hypervisor connection or NULL in case of error
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
virConnectPtr
virConnectOpen(const char *name)
*
* Returns a pointer to the hypervisor connection or NULL in case of error
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
virConnectPtr
virConnectOpenReadOnly(const char *name)
*
* Returns a pointer to the hypervisor connection or NULL in case of error
*
- * Since: v0.4.0
+ * Since: 0.4.0
*/
virConnectPtr
virConnectOpenAuth(const char *name,
* connection, but the application should not try to further use a
* connection after the virConnectClose that matches the initial open.
*
- * Since: v0.0.3
+ * Since: 0.0.3
*/
int
virConnectClose(virConnectPtr conn)
*
* Returns a pointer to the last error or NULL if none occurred.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
virErrorPtr
virGetLastError(void)
*
* Returns the most recent error code, or VIR_ERR_OK if none is set.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virGetLastErrorCode(void)
* Returns a numerical value of the most recent error's origin, or VIR_FROM_NONE
* if none is set.
*
- * Since: v4.5.0
+ * Since: 4.5.0
*/
int
virGetLastErrorDomain(void)
* Returns the most recent error message string in this
* thread, or a generic message if none is set
*
- * Since: v1.0.6
+ * Since: 1.0.6
*/
const char *
virGetLastErrorMessage(void)
*
* Returns error code or -1 in case of parameter error.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
int
virCopyLastError(virErrorPtr to)
* It is the caller's responsibility to free the error with
* virFreeError().
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
virErrorPtr
virSaveLastError(void)
*
* Reset the error being pointed to
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
void
virResetError(virErrorPtr err)
*
* Resets and frees the given error.
*
- * Since: v0.6.1
+ * Since: 0.6.1
*/
void
virFreeError(virErrorPtr err)
* threads can safely access this concurrently, only resetting
* their own error object.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
void
virResetLastError(void)
*
* Returns a pointer to the last error or NULL if none occurred.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
virErrorPtr
virConnGetLastError(virConnectPtr conn)
* Returns 0 if no error was found and the error code otherwise and -1 in case
* of parameter error.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
int
virConnCopyLastError(virConnectPtr conn, virErrorPtr to)
*
* Reset the last error caught on that connection
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
void
virConnResetLastError(virConnectPtr conn)
* it will reset to default printing on stderr. The error raised there
* are those for which no handler at the connection level could caught.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
void
virSetErrorFunc(void *userData, virErrorFunc handler)
* it will reset to default which is to pass error back to the global
* library handler.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
void
virConnSetErrorFunc(virConnectPtr conn, void *userData,
*
* Default routine reporting an error to stderr.
*
- * Since: v0.1.0
+ * Since: 0.1.0
*/
void
virDefaultErrorFunc(virErrorPtr err)
* Returns -1 if the file handle cannot be registered, otherwise a handle
* watch number to be used for updating and unregistering for events.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virEventAddHandle(int fd,
*
* Will not fail if fd exists.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
void
virEventUpdateHandle(int watch, int events)
*
* Returns -1 if the file handle was not registered, 0 upon success.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virEventRemoveHandle(int watch)
* Returns -1 if the timer cannot be registered, a positive
* integer timer id upon success.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virEventAddTimeout(int timeout,
*
* Will not fail if timer exists.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
void
virEventUpdateTimeout(int timer, int timeout)
*
* Returns -1 if the timer was not registered, 0 upon success.
*
- * Since: v0.9.3
+ * Since: 0.9.3
*/
int
virEventRemoveTimeout(int timer)
* to stop running the event loop immediately after closing
* the connection.
*
- * Since: v0.5.0
+ * Since: 0.5.0
*/
void virEventRegisterImpl(virEventAddHandleFunc addHandle,
virEventUpdateHandleFunc updateHandle,
*
* Returns 0 on success, -1 on failure.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int virEventRegisterDefaultImpl(void)
{
*
* Returns 0 on success, -1 on failure.
*
- * Since: v0.9.0
+ * Since: 0.9.0
*/
int virEventRunDefaultImpl(void)
{
* Returns pointer to the parameter or NULL if it does not exist in @params.
* This function does not raise an error, even when returning NULL.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
virTypedParameterPtr
virTypedParamsGet(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetInt(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetUInt(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetLLong(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetULLong(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetDouble(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetBoolean(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsGetString(virTypedParameterPtr params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddInt(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddUInt(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddLLong(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddULLong(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddDouble(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddBoolean(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddString(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.2.17
+ * Since: 1.2.17
*/
int
virTypedParamsAddStringList(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
int
virTypedParamsAddFromString(virTypedParameterPtr *params,
*
* Returns nothing.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
void
virTypedParamsClear(virTypedParameterPtr params,
*
* Returns nothing.
*
- * Since: v1.0.2
+ * Since: 1.0.2
*/
void
virTypedParamsFree(virTypedParameterPtr params,
projects / libvirt.git / commitdiff