Macro LIBVIR_CHECK_VERSION

#define LIBVIR_CHECK_VERSION(major, minor, micro);

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

Macro LIBVIR_VERSION_NUMBER

#define LIBVIR_VERSION_NUMBER;

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

Macro VIR_COPY_CPUMAP

#define VIR_COPY_CPUMAP(cpumaps, maplen, vcpu, cpumap);

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

Macro VIR_CPU_MAPLEN

#define VIR_CPU_MAPLEN(cpu);

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

Macro VIR_CPU_USABLE

#define VIR_CPU_USABLE(cpumaps, maplen, vcpu, cpu);

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

Macro VIR_CPU_USED

#define VIR_CPU_USED(cpumap, cpu);

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

Macro VIR_DOMAIN_BANDWIDTH_IN_AVERAGE

#define VIR_DOMAIN_BANDWIDTH_IN_AVERAGE;

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

Macro VIR_DOMAIN_BANDWIDTH_IN_BURST

#define VIR_DOMAIN_BANDWIDTH_IN_BURST;

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

Macro VIR_DOMAIN_BANDWIDTH_IN_PEAK

#define VIR_DOMAIN_BANDWIDTH_IN_PEAK;

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

Macro VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE

#define VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE;

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

Macro VIR_DOMAIN_BANDWIDTH_OUT_BURST

#define VIR_DOMAIN_BANDWIDTH_OUT_BURST;

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

Macro VIR_DOMAIN_BANDWIDTH_OUT_PEAK

#define VIR_DOMAIN_BANDWIDTH_OUT_PEAK;

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

Macro VIR_DOMAIN_BLKIO_DEVICE_READ_BPS

#define VIR_DOMAIN_BLKIO_DEVICE_READ_BPS;

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

Macro VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS

#define VIR_DOMAIN_BLKIO_DEVICE_READ_IOPS;

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

Macro VIR_DOMAIN_BLKIO_DEVICE_WEIGHT

#define VIR_DOMAIN_BLKIO_DEVICE_WEIGHT;

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

Macro VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS

#define VIR_DOMAIN_BLKIO_DEVICE_WRITE_BPS;

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

Macro VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS

#define VIR_DOMAIN_BLKIO_DEVICE_WRITE_IOPS;

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

Macro VIR_DOMAIN_BLKIO_FIELD_LENGTH

#define VIR_DOMAIN_BLKIO_FIELD_LENGTH;

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

Macro VIR_DOMAIN_BLKIO_WEIGHT

#define VIR_DOMAIN_BLKIO_WEIGHT;

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

Macro VIR_DOMAIN_BLOCK_COPY_BANDWIDTH

#define VIR_DOMAIN_BLOCK_COPY_BANDWIDTH;

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

Macro VIR_DOMAIN_BLOCK_COPY_BUF_SIZE

#define VIR_DOMAIN_BLOCK_COPY_BUF_SIZE;

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

Macro VIR_DOMAIN_BLOCK_COPY_GRANULARITY

#define VIR_DOMAIN_BLOCK_COPY_GRANULARITY;

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

Macro VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC;

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

Macro VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC;

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

Macro VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC;

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

Macro VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC;

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

Macro VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC;

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

Macro VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC

#define VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC;

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

Macro VIR_DOMAIN_BLOCK_STATS_ERRS

#define VIR_DOMAIN_BLOCK_STATS_ERRS;

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

Macro VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH

#define VIR_DOMAIN_BLOCK_STATS_FIELD_LENGTH;

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

Macro VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ

#define VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ;

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

Macro VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES

#define VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES;

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

Macro VIR_DOMAIN_BLOCK_STATS_READ_BYTES

#define VIR_DOMAIN_BLOCK_STATS_READ_BYTES;

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

Macro VIR_DOMAIN_BLOCK_STATS_READ_REQ

#define VIR_DOMAIN_BLOCK_STATS_READ_REQ;

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

Macro VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES

#define VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES;

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

Macro VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES

#define VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES;

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

Macro VIR_DOMAIN_BLOCK_STATS_WRITE_REQ

#define VIR_DOMAIN_BLOCK_STATS_WRITE_REQ;

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

Macro VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES

#define VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES;

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

Macro VIR_DOMAIN_CPU_STATS_CPUTIME

#define VIR_DOMAIN_CPU_STATS_CPUTIME;

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

Macro VIR_DOMAIN_CPU_STATS_SYSTEMTIME

#define VIR_DOMAIN_CPU_STATS_SYSTEMTIME;

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

Macro VIR_DOMAIN_CPU_STATS_USERTIME

#define VIR_DOMAIN_CPU_STATS_USERTIME;

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

Macro VIR_DOMAIN_CPU_STATS_VCPUTIME

#define VIR_DOMAIN_CPU_STATS_VCPUTIME;

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

Macro VIR_DOMAIN_EVENT_CALLBACK

#define VIR_DOMAIN_EVENT_CALLBACK;

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

Macro VIR_DOMAIN_JOB_COMPRESSION_BYTES

#define VIR_DOMAIN_JOB_COMPRESSION_BYTES;

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

Macro VIR_DOMAIN_JOB_COMPRESSION_CACHE

#define VIR_DOMAIN_JOB_COMPRESSION_CACHE;

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

Macro VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES

#define VIR_DOMAIN_JOB_COMPRESSION_CACHE_MISSES;

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

Macro VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW

#define VIR_DOMAIN_JOB_COMPRESSION_OVERFLOW;

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

Macro VIR_DOMAIN_JOB_COMPRESSION_PAGES

#define VIR_DOMAIN_JOB_COMPRESSION_PAGES;

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

Macro VIR_DOMAIN_JOB_DATA_PROCESSED

#define VIR_DOMAIN_JOB_DATA_PROCESSED;

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

Macro VIR_DOMAIN_JOB_DATA_REMAINING

#define VIR_DOMAIN_JOB_DATA_REMAINING;

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

Macro VIR_DOMAIN_JOB_DATA_TOTAL

#define VIR_DOMAIN_JOB_DATA_TOTAL;

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

Macro VIR_DOMAIN_JOB_DISK_BPS

#define VIR_DOMAIN_JOB_DISK_BPS;

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

Macro VIR_DOMAIN_JOB_DISK_PROCESSED

#define VIR_DOMAIN_JOB_DISK_PROCESSED;

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

Macro VIR_DOMAIN_JOB_DISK_REMAINING

#define VIR_DOMAIN_JOB_DISK_REMAINING;

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

Macro VIR_DOMAIN_JOB_DISK_TOTAL

#define VIR_DOMAIN_JOB_DISK_TOTAL;

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

Macro VIR_DOMAIN_JOB_DOWNTIME

#define VIR_DOMAIN_JOB_DOWNTIME;

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

Macro VIR_DOMAIN_JOB_MEMORY_BPS

#define VIR_DOMAIN_JOB_MEMORY_BPS;

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

Macro VIR_DOMAIN_JOB_MEMORY_CONSTANT

#define VIR_DOMAIN_JOB_MEMORY_CONSTANT;

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

Macro VIR_DOMAIN_JOB_MEMORY_NORMAL

#define VIR_DOMAIN_JOB_MEMORY_NORMAL;

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

Macro VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES

#define VIR_DOMAIN_JOB_MEMORY_NORMAL_BYTES;

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

Macro VIR_DOMAIN_JOB_MEMORY_PROCESSED

#define VIR_DOMAIN_JOB_MEMORY_PROCESSED;

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

Macro VIR_DOMAIN_JOB_MEMORY_REMAINING

#define VIR_DOMAIN_JOB_MEMORY_REMAINING;

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

Macro VIR_DOMAIN_JOB_MEMORY_TOTAL

#define VIR_DOMAIN_JOB_MEMORY_TOTAL;

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

Macro VIR_DOMAIN_JOB_SETUP_TIME

#define VIR_DOMAIN_JOB_SETUP_TIME;

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

Macro VIR_DOMAIN_JOB_TIME_ELAPSED

#define VIR_DOMAIN_JOB_TIME_ELAPSED;

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

Macro VIR_DOMAIN_JOB_TIME_REMAINING

#define VIR_DOMAIN_JOB_TIME_REMAINING;

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

Macro VIR_DOMAIN_MEMORY_FIELD_LENGTH

#define VIR_DOMAIN_MEMORY_FIELD_LENGTH;

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

Macro VIR_DOMAIN_MEMORY_HARD_LIMIT

#define VIR_DOMAIN_MEMORY_HARD_LIMIT;

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

Macro VIR_DOMAIN_MEMORY_MIN_GUARANTEE

#define VIR_DOMAIN_MEMORY_MIN_GUARANTEE;

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

Macro VIR_DOMAIN_MEMORY_PARAM_UNLIMITED

#define VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;

Macro providing the virMemoryParameter value that indicates "unlimited"

Macro VIR_DOMAIN_MEMORY_SOFT_LIMIT

#define VIR_DOMAIN_MEMORY_SOFT_LIMIT;

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

Macro VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT

#define VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT;

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

Macro VIR_DOMAIN_NUMA_MODE

#define VIR_DOMAIN_NUMA_MODE;

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

Macro VIR_DOMAIN_NUMA_NODESET

#define VIR_DOMAIN_NUMA_NODESET;

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

Macro VIR_DOMAIN_SCHEDULER_CAP

#define VIR_DOMAIN_SCHEDULER_CAP;

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

Macro VIR_DOMAIN_SCHEDULER_CPU_SHARES

#define VIR_DOMAIN_SCHEDULER_CPU_SHARES;

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

Macro VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD

#define VIR_DOMAIN_SCHEDULER_EMULATOR_PERIOD;

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

Macro VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA

#define VIR_DOMAIN_SCHEDULER_EMULATOR_QUOTA;

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

Macro VIR_DOMAIN_SCHEDULER_LIMIT

#define VIR_DOMAIN_SCHEDULER_LIMIT;

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

Macro VIR_DOMAIN_SCHEDULER_RESERVATION

#define VIR_DOMAIN_SCHEDULER_RESERVATION;

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

Macro VIR_DOMAIN_SCHEDULER_SHARES

#define VIR_DOMAIN_SCHEDULER_SHARES;

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

Macro VIR_DOMAIN_SCHEDULER_VCPU_PERIOD

#define VIR_DOMAIN_SCHEDULER_VCPU_PERIOD;

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

Macro VIR_DOMAIN_SCHEDULER_VCPU_QUOTA

#define VIR_DOMAIN_SCHEDULER_VCPU_QUOTA;

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

Macro VIR_DOMAIN_SCHEDULER_WEIGHT

#define VIR_DOMAIN_SCHEDULER_WEIGHT;

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

Macro VIR_DOMAIN_SCHED_FIELD_LENGTH

#define VIR_DOMAIN_SCHED_FIELD_LENGTH;

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

Macro VIR_DOMAIN_SEND_KEY_MAX_KEYS

#define VIR_DOMAIN_SEND_KEY_MAX_KEYS;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_DISK

#define VIR_DOMAIN_TUNABLE_BLKDEV_DISK;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_BYTES_SEC;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_READ_IOPS_SEC;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_BYTES_SEC;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_TOTAL_IOPS_SEC;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_BYTES_SEC;

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

Macro VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC

#define VIR_DOMAIN_TUNABLE_BLKDEV_WRITE_IOPS_SEC;

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

Macro VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES

#define VIR_DOMAIN_TUNABLE_CPU_CPU_SHARES;

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

Macro VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN

#define VIR_DOMAIN_TUNABLE_CPU_EMULATORPIN;

Macro represents formatted pinning for emulator process, as VIR_TYPED_PARAM_STRING.

Macro VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD

#define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_PERIOD;

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

Macro VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA

#define VIR_DOMAIN_TUNABLE_CPU_EMULATOR_QUOTA;

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

Macro VIR_DOMAIN_TUNABLE_CPU_VCPUPIN

#define VIR_DOMAIN_TUNABLE_CPU_VCPUPIN;

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

Macro VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD

#define VIR_DOMAIN_TUNABLE_CPU_VCPU_PERIOD;

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

Macro VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA

#define VIR_DOMAIN_TUNABLE_CPU_VCPU_QUOTA;

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

Macro VIR_GET_CPUMAP

#define VIR_GET_CPUMAP(cpumaps, maplen, vcpu);

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

Macro VIR_MIGRATE_PARAM_BANDWIDTH

#define VIR_MIGRATE_PARAM_BANDWIDTH;

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

Macro VIR_MIGRATE_PARAM_DEST_NAME

#define VIR_MIGRATE_PARAM_DEST_NAME;

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

Macro VIR_MIGRATE_PARAM_DEST_XML

#define VIR_MIGRATE_PARAM_DEST_XML;

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

Macro VIR_MIGRATE_PARAM_GRAPHICS_URI

#define VIR_MIGRATE_PARAM_GRAPHICS_URI;

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

Macro VIR_MIGRATE_PARAM_LISTEN_ADDRESS

#define VIR_MIGRATE_PARAM_LISTEN_ADDRESS;

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

Macro VIR_MIGRATE_PARAM_URI

#define VIR_MIGRATE_PARAM_URI;

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

Macro VIR_NETWORK_EVENT_CALLBACK

#define VIR_NETWORK_EVENT_CALLBACK;

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

Macro VIR_NODEINFO_MAXCPUS

#define VIR_NODEINFO_MAXCPUS(nodeinfo);

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

Macro VIR_NODE_CPU_STATS_FIELD_LENGTH

#define VIR_NODE_CPU_STATS_FIELD_LENGTH;

Macro providing the field length of virNodeCPUStats

Macro VIR_NODE_CPU_STATS_IDLE

#define VIR_NODE_CPU_STATS_IDLE;

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

Macro VIR_NODE_CPU_STATS_INTR

#define VIR_NODE_CPU_STATS_INTR;

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

Macro VIR_NODE_CPU_STATS_IOWAIT

#define VIR_NODE_CPU_STATS_IOWAIT;

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

Macro VIR_NODE_CPU_STATS_KERNEL

#define VIR_NODE_CPU_STATS_KERNEL;

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

Macro VIR_NODE_CPU_STATS_USER

#define VIR_NODE_CPU_STATS_USER;

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

Macro VIR_NODE_CPU_STATS_UTILIZATION

#define VIR_NODE_CPU_STATS_UTILIZATION;

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

Macro VIR_NODE_MEMORY_STATS_BUFFERS

#define VIR_NODE_MEMORY_STATS_BUFFERS;

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

Macro VIR_NODE_MEMORY_STATS_CACHED

#define VIR_NODE_MEMORY_STATS_CACHED;

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

Macro VIR_NODE_MEMORY_STATS_FIELD_LENGTH

#define VIR_NODE_MEMORY_STATS_FIELD_LENGTH;

Macro providing the field length of virNodeMemoryStats

Macro VIR_NODE_MEMORY_STATS_FREE

#define VIR_NODE_MEMORY_STATS_FREE;

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

Macro VIR_NODE_MEMORY_STATS_TOTAL

#define VIR_NODE_MEMORY_STATS_TOTAL;

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

Macro VIR_SECURITY_DOI_BUFLEN

#define VIR_SECURITY_DOI_BUFLEN;

Macro providing the maximum length of the virSecurityModel doi string.

Macro VIR_SECURITY_LABEL_BUFLEN

#define VIR_SECURITY_LABEL_BUFLEN;

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

Macro VIR_SECURITY_MODEL_BUFLEN

#define VIR_SECURITY_MODEL_BUFLEN;

Macro providing the maximum length of the virSecurityModel model string.

Macro VIR_TYPED_PARAM_FIELD_LENGTH

#define VIR_TYPED_PARAM_FIELD_LENGTH;

Macro providing the field length of virTypedParameter name

Macro VIR_UNUSE_CPU

#define VIR_UNUSE_CPU(cpumap, cpu);

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

Macro VIR_USE_CPU

#define VIR_USE_CPU(cpumap, cpu);

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

Macro VIR_UUID_BUFLEN

#define VIR_UUID_BUFLEN;

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

Macro VIR_UUID_STRING_BUFLEN

#define VIR_UUID_STRING_BUFLEN;

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

Macro _virBlkioParameter

#define _virBlkioParameter;

Macro _virMemoryParameter

#define _virMemoryParameter;

Macro _virSchedParameter

#define _virSchedParameter;

Structure virBlkioParameter

struct _virTypedParameter {
    char field[VIR_TYPED_PARAM_FIELD_LENGTH]	field	: parameter name
    int	type	: parameter type, virTypedParameterType
    union	value	: parameter value
} virBlkioParameter;

Typedef virBlkioParameterPtr

virBlkioParameter * virBlkioParameterPtr;

a virBlkioParameterPtr is a pointer to a virBlkioParameter structure. Provided for backwards compatibility; virTypedParameterPtr is the preferred alias since 0.9.2.

Enum virBlkioParameterType

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

Enum virCPUCompareResult

enum virCPUCompareResult {
    VIR_CPU_COMPARE_ERROR = -1
    VIR_CPU_COMPARE_INCOMPATIBLE = 0
    VIR_CPU_COMPARE_IDENTICAL = 1
    VIR_CPU_COMPARE_SUPERSET = 2
    VIR_CPU_COMPARE_LAST = 3
};

Structure virConnect

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

Structure virConnectAuth

struct _virConnectAuth {
    int *	credtype	: List of supported virConnectCredentialType values
    unsigned int	ncredtype
    virConnectAuthCallbackPtr	cb	: Callback used to collect credentials
    void *	cbdata
} virConnectAuth;

Typedef virConnectAuthPtr

virConnectAuth * virConnectAuthPtr;

Enum virConnectBaselineCPUFlags

enum virConnectBaselineCPUFlags {
    VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = 1 /* show all features */
};

Enum virConnectCloseReason

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

Enum virConnectCompareCPUFlags

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

Structure virConnectCredential

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

Typedef virConnectCredentialPtr

virConnectCredential * virConnectCredentialPtr;

Enum virConnectCredentialType

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

Enum virConnectDomainEventBlockJobStatus

enum virConnectDomainEventBlockJobStatus {
    VIR_DOMAIN_BLOCK_JOB_COMPLETED = 0
    VIR_DOMAIN_BLOCK_JOB_FAILED = 1
    VIR_DOMAIN_BLOCK_JOB_CANCELED = 2
    VIR_DOMAIN_BLOCK_JOB_READY = 3
    VIR_DOMAIN_BLOCK_JOB_LAST = 4
};

Enum virConnectDomainEventDiskChangeReason

enum virConnectDomainEventDiskChangeReason {
    VIR_DOMAIN_EVENT_DISK_CHANGE_MISSING_ON_START = 0 /* oldSrcPath is set */
    VIR_DOMAIN_EVENT_DISK_DROP_MISSING_ON_START = 1
    VIR_DOMAIN_EVENT_DISK_CHANGE_LAST = 2
};

Enum virConnectFlags

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

Enum virConnectGetAllDomainStatsFlags

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

Enum virConnectListAllDomainsFlags

enum virConnectListAllDomainsFlags {
    VIR_CONNECT_LIST_DOMAINS_ACTIVE = 1
    VIR_CONNECT_LIST_DOMAINS_INACTIVE = 2
    VIR_CONNECT_LIST_DOMAINS_PERSISTENT = 4
    VIR_CONNECT_LIST_DOMAINS_TRANSIENT = 8
    VIR_CONNECT_LIST_DOMAINS_RUNNING = 16
    VIR_CONNECT_LIST_DOMAINS_PAUSED = 32
    VIR_CONNECT_LIST_DOMAINS_SHUTOFF = 64
    VIR_CONNECT_LIST_DOMAINS_OTHER = 128
    VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE = 256
    VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE = 512
    VIR_CONNECT_LIST_DOMAINS_AUTOSTART = 1024
    VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART = 2048
    VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT = 4096
    VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT = 8192
};

Enum virConnectListAllInterfacesFlags

enum virConnectListAllInterfacesFlags {
    VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1
    VIR_CONNECT_LIST_INTERFACES_ACTIVE = 2
};

Enum virConnectListAllNetworksFlags

enum virConnectListAllNetworksFlags {
    VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1
    VIR_CONNECT_LIST_NETWORKS_ACTIVE = 2
    VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 4
    VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 8
    VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 16
    VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 32
};

Enum virConnectListAllNodeDeviceFlags

enum virConnectListAllNodeDeviceFlags {
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 /* System capability */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 2 /* PCI device */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 4 /* USB device */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 8 /* USB interface */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 16 /* Network device */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 32 /* SCSI Host Bus Adapter */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 64 /* SCSI Target */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 128 /* SCSI device */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 256 /* Storage device */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 512 /* FC Host Bus Adapter */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1024 /* Capable of vport */
    VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 2048 /* Capable of scsi_generic */
};

Enum virConnectListAllSecretsFlags

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

Enum virConnectListAllStoragePoolsFlags

enum virConnectListAllStoragePoolsFlags {
    VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1
    VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 2
    VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 4
    VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 8
    VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 16
    VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 32 /* List pools by type */
    VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 64
    VIR_CONNECT_LIST_STORAGE_POOLS_FS = 128
    VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 256
    VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 512
    VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1024
    VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 2048
    VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 4096
    VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 8192
    VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 16384
    VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 32768
    VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 65536
    VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 131072
};

Typedef virConnectPtr

virConnect * virConnectPtr;

a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Hypervisor in the API.

Structure virDomain

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

Enum virDomainBlockCommitFlags

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

Enum virDomainBlockCopyFlags

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

Structure virDomainBlockInfo

struct _virDomainBlockInfo {
    unsigned long long	capacity	: logical size in bytes of the block device backing image
    unsigned long long	allocation	: highest allocated extent in bytes of the block device backing image
    unsigned long long	physical	: physical size in bytes of the container of the backing image
} virDomainBlockInfo;

Typedef virDomainBlockInfoPtr

virDomainBlockInfo * virDomainBlockInfoPtr;

Enum virDomainBlockJobAbortFlags

enum virDomainBlockJobAbortFlags {
    VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC = 1
    VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT = 2
};

Typedef virDomainBlockJobCursor

unsigned long long virDomainBlockJobCursor;

Structure virDomainBlockJobInfo

struct _virDomainBlockJobInfo {
    int	type	: virDomainBlockJobType
    unsigned long	bandwidth	: The following fields provide an indication of block job progress. @cu
    virDomainBlockJobCursor	cur
    virDomainBlockJobCursor	end
} virDomainBlockJobInfo;

Enum virDomainBlockJobInfoFlags

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

Typedef virDomainBlockJobInfoPtr

virDomainBlockJobInfo * virDomainBlockJobInfoPtr;

Enum virDomainBlockJobSetSpeedFlags

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

Enum virDomainBlockJobType

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

Enum virDomainBlockPullFlags

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

Enum virDomainBlockRebaseFlags

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

Enum virDomainBlockResizeFlags

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

Typedef virDomainBlockStatsPtr

virDomainBlockStatsStruct * virDomainBlockStatsPtr;

A pointer to a virDomainBlockStats structure

Structure virDomainBlockStatsStruct

struct _virDomainBlockStats {
    long long	rd_req	: number of read requests
    long long	rd_bytes	: number of read bytes
    long long	wr_req	: number of write requests
    long long	wr_bytes	: number of written bytes
    long long	errs	: In Xen this returns the mysterious 'oo_req'.
} virDomainBlockStatsStruct;

Enum virDomainBlockedReason

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

Enum virDomainChannelFlags

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

Enum virDomainConsoleFlags

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

Structure virDomainControlInfo

struct _virDomainControlInfo {
    unsigned int	state	: control state, one of virDomainControlState
    unsigned int	details	: state details, currently 0
    unsigned long long	stateTime	: for how long (in msec) control interface has been in current state (ex
} virDomainControlInfo;

Typedef virDomainControlInfoPtr

virDomainControlInfo * virDomainControlInfoPtr;

Pointer to virDomainControlInfo structure.

Enum virDomainControlState

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

Enum virDomainCoreDumpFlags

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

Enum virDomainCoreDumpFormat

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

Enum virDomainCrashedReason

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

Enum virDomainCreateFlags

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

Enum virDomainDestroyFlagsValues

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

Enum virDomainDeviceModifyFlags

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

Structure virDomainDiskError

struct _virDomainDiskError {
    char *	disk	: disk target
    int	error	: virDomainDiskErrorCode
} virDomainDiskError;

Enum virDomainDiskErrorCode

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

Typedef virDomainDiskErrorPtr

virDomainDiskError * virDomainDiskErrorPtr;

Enum virDomainEventCrashedDetailType

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

Enum virDomainEventDefinedDetailType

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

Structure virDomainEventGraphicsAddress

struct _virDomainEventGraphicsAddress {
    int	family	: Address family, virDomainEventGraphicsAddressType
    char *	node	: Address of node (eg IP address, or UNIX path)
    char *	service	: Service name/number (eg TCP port, or NULL)
} virDomainEventGraphicsAddress;

Typedef virDomainEventGraphicsAddressPtr

virDomainEventGraphicsAddress * virDomainEventGraphicsAddressPtr;

Enum virDomainEventGraphicsAddressType

enum virDomainEventGraphicsAddressType {
    VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4 = 0 /* IPv4 address */
    VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV6 = 1 /* IPv6 address */
    VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_UNIX = 2 /* UNIX socket path */
    VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_LAST = 3
};

Enum virDomainEventGraphicsPhase

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

Structure virDomainEventGraphicsSubject

struct _virDomainEventGraphicsSubject {
    int	nidentity	: Number of identities in arra
    virDomainEventGraphicsSubjectIdentityPtr	identities	: Array of identities for subject
} virDomainEventGraphicsSubject;

Structure virDomainEventGraphicsSubjectIdentity

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

Typedef virDomainEventGraphicsSubjectIdentityPtr

virDomainEventGraphicsSubjectIdentity * virDomainEventGraphicsSubjectIdentityPtr;

Typedef virDomainEventGraphicsSubjectPtr

virDomainEventGraphicsSubject * virDomainEventGraphicsSubjectPtr;

Enum virDomainEventID

enum virDomainEventID {
    VIR_DOMAIN_EVENT_ID_LIFECYCLE = 0 /* virConnectDomainEventCallback */
    VIR_DOMAIN_EVENT_ID_REBOOT = 1 /* virConnectDomainEventGenericCallback */
    VIR_DOMAIN_EVENT_ID_RTC_CHANGE = 2 /* virConnectDomainEventRTCChangeCallback */
    VIR_DOMAIN_EVENT_ID_WATCHDOG = 3 /* virConnectDomainEventWatchdogCallback */
    VIR_DOMAIN_EVENT_ID_IO_ERROR = 4 /* virConnectDomainEventIOErrorCallback */
    VIR_DOMAIN_EVENT_ID_GRAPHICS = 5 /* virConnectDomainEventGraphicsCallback */
    VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON = 6 /* virConnectDomainEventIOErrorReasonCallback */
    VIR_DOMAIN_EVENT_ID_CONTROL_ERROR = 7 /* virConnectDomainEventGenericCallback */
    VIR_DOMAIN_EVENT_ID_BLOCK_JOB = 8 /* virConnectDomainEventBlockJobCallback */
    VIR_DOMAIN_EVENT_ID_DISK_CHANGE = 9 /* virConnectDomainEventDiskChangeCallback */
    VIR_DOMAIN_EVENT_ID_TRAY_CHANGE = 10 /* virConnectDomainEventTrayChangeCallback */
    VIR_DOMAIN_EVENT_ID_PMWAKEUP = 11 /* virConnectDomainEventPMWakeupCallback */
    VIR_DOMAIN_EVENT_ID_PMSUSPEND = 12 /* virConnectDomainEventPMSuspendCallback */
    VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE = 13 /* virConnectDomainEventBalloonChangeCallback */
    VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK = 14 /* virConnectDomainEventPMSuspendDiskCallback */