Module libvirt from libvirt

	API documentation		The virtualization API	virterror

Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0

Table of Contents

#define LIBVIR_VERSION_NUMBER

#define VIR_COPY_CPUMAP

#define VIR_CPU_MAPLEN

#define VIR_CPU_USABLE

#define VIR_DOMAIN_SCHED_FIELD_LENGTH

#define VIR_GET_CPUMAP

#define VIR_NODEINFO_MAXCPUS

#define VIR_UNUSE_CPU

#define VIR_USE_CPU

#define VIR_UUID_BUFLEN

#define VIR_UUID_STRING_BUFLEN

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

Structure virConnectAuth
struct _virConnectAuth

Typedef virConnectAuth * virConnectAuthPtr

Structure virConnectCredential
struct _virConnectCredential

Typedef virConnectCredential * virConnectCredentialPtr

Enum virConnectCredentialType

Enum virConnectFlags

Typedef virConnect * virConnectPtr

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

Typedef virDomainBlockStatsStruct * virDomainBlockStatsPtr

Structure virDomainBlockStatsStruct
struct _virDomainBlockStats

Enum virDomainCreateFlags

Structure virDomainInfo
struct _virDomainInfo

Typedef virDomainInfo * virDomainInfoPtr

Typedef virDomainInterfaceStatsStruct * virDomainInterfaceStatsPtr

Structure virDomainInterfaceStatsStruct
struct _virDomainInterfaceStats

Enum virDomainMigrateFlags

Typedef virDomain * virDomainPtr

Enum virDomainState

Enum virDomainXMLFlags

Structure virNetwork
struct _virNetwork
The content of this structure is not made public by the API.

Typedef virNetwork * virNetworkPtr

Structure virNodeInfo
struct _virNodeInfo

Typedef virNodeInfo * virNodeInfoPtr

Structure virSchedParameter
struct _virSchedParameter

Typedef virSchedParameter * virSchedParameterPtr

Enum virSchedParameterType

Structure virVcpuInfo
struct _virVcpuInfo

Typedef virVcpuInfo * virVcpuInfoPtr

Enum virVcpuState

Function type: virConnectAuthCallbackPtr
int	virConnectAuthCallbackPtr	(virConnectCredentialPtr cred, 
					 unsigned int ncred, 
					 void * cbdata)

int	virConnectClose			(virConnectPtr conn)

char *	virConnectGetCapabilities	(virConnectPtr conn)

char *	virConnectGetHostname		(virConnectPtr conn)

int	virConnectGetMaxVcpus		(virConnectPtr conn, 
					 const char * type)

const char *	virConnectGetType	(virConnectPtr conn)

char *	virConnectGetURI		(virConnectPtr conn)

int	virConnectGetVersion		(virConnectPtr conn, 
					 unsigned long * hvVer)

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

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

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

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

int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

int	virConnectNumOfDefinedNetworks	(virConnectPtr conn)

int	virConnectNumOfDomains		(virConnectPtr conn)

int	virConnectNumOfNetworks		(virConnectPtr conn)

virConnectPtr	virConnectOpen		(const char * name)

virConnectPtr	virConnectOpenAuth	(const char * name, 
					 virConnectAuthPtr auth, 
					 int flags)

virConnectPtr	virConnectOpenReadOnly	(const char * name)

int	virDomainAttachDevice		(virDomainPtr domain, 
					 const char * xml)

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

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

int	virDomainCreate			(virDomainPtr domain)

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

virDomainPtr	virDomainDefineXML	(virConnectPtr conn, 
					 const char * xml)

int	virDomainDestroy		(virDomainPtr domain)

int	virDomainDetachDevice		(virDomainPtr domain, 
					 const char * xml)

int	virDomainFree			(virDomainPtr domain)

int	virDomainGetAutostart		(virDomainPtr domain, 
					 int * autostart)

virConnectPtr	virDomainGetConnect	(virDomainPtr dom)

unsigned int	virDomainGetID		(virDomainPtr domain)

int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)

unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)

int	virDomainGetMaxVcpus		(virDomainPtr domain)

const char *	virDomainGetName	(virDomainPtr domain)

char *	virDomainGetOSType		(virDomainPtr domain)

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

char *	virDomainGetSchedulerType	(virDomainPtr domain, 
					 int * nparams)

int	virDomainGetUUID		(virDomainPtr domain, 
					 unsigned char * uuid)

int	virDomainGetUUIDString		(virDomainPtr domain, 
					 char * buf)

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

char *	virDomainGetXMLDesc		(virDomainPtr domain, 
					 int flags)

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

virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)

virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)

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

virDomainPtr	virDomainLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

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

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

int	virDomainReboot			(virDomainPtr domain, 
					 unsigned int flags)

int	virDomainRestore		(virConnectPtr conn, 
					 const char * from)

int	virDomainResume			(virDomainPtr domain)

int	virDomainSave			(virDomainPtr domain, 
					 const char * to)

int	virDomainSetAutostart		(virDomainPtr domain, 
					 int autostart)

int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)

int	virDomainSetMemory		(virDomainPtr domain, 
					 unsigned long memory)

int	virDomainSetSchedulerParameters	(virDomainPtr domain, 
					 virSchedParameterPtr params, 
					 int nparams)

int	virDomainSetVcpus		(virDomainPtr domain, 
					 unsigned int nvcpus)

int	virDomainShutdown		(virDomainPtr domain)

int	virDomainSuspend		(virDomainPtr domain)

int	virDomainUndefine		(virDomainPtr domain)

int	virGetVersion			(unsigned long * libVer, 
					 const char * type, 
					 unsigned long * typeVer)

int	virInitialize			(void)

int	virNetworkCreate		(virNetworkPtr network)

virNetworkPtr	virNetworkCreateXML	(virConnectPtr conn, 
					 const char * xmlDesc)

virNetworkPtr	virNetworkDefineXML	(virConnectPtr conn, 
					 const char * xml)

int	virNetworkDestroy		(virNetworkPtr network)

int	virNetworkFree			(virNetworkPtr network)

int	virNetworkGetAutostart		(virNetworkPtr network, 
					 int * autostart)

char *	virNetworkGetBridgeName		(virNetworkPtr network)

virConnectPtr	virNetworkGetConnect	(virNetworkPtr net)

const char *	virNetworkGetName	(virNetworkPtr network)

int	virNetworkGetUUID		(virNetworkPtr network, 
					 unsigned char * uuid)

int	virNetworkGetUUIDString		(virNetworkPtr network, 
					 char * buf)

char *	virNetworkGetXMLDesc		(virNetworkPtr network, 
					 int flags)

virNetworkPtr	virNetworkLookupByName	(virConnectPtr conn, 
					 const char * name)

virNetworkPtr	virNetworkLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)

virNetworkPtr	virNetworkLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

int	virNetworkSetAutostart		(virNetworkPtr network, 
					 int autostart)

int	virNetworkUndefine		(virNetworkPtr network)

int	virNodeGetCellsFreeMemory	(virConnectPtr conn, 
					 unsigned long long * freeMems, 
					 int startCell, 
					 int maxCells)

unsigned long long	virNodeGetFreeMemory	(virConnectPtr conn)

int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)

Description

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

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

Macro: VIR_CPU_MAPLEN

#define VIR_CPU_MAPLEN

This macro is to be used in conjonction 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

This macro is to be used in conjonction 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_DOMAIN_SCHED_FIELD_LENGTH

#define VIR_DOMAIN_SCHED_FIELD_LENGTH

Macro providing the field length of virSchedParameter

Macro: VIR_GET_CPUMAP

#define VIR_GET_CPUMAP

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

Macro: VIR_NODEINFO_MAXCPUS

#define VIR_NODEINFO_MAXCPUS

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

Macro: VIR_UNUSE_CPU

#define VIR_UNUSE_CPU

This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.

Macro: VIR_USE_CPU

#define VIR_USE_CPU

This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro set 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()

Structure virConnect

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

Structure virConnectAuth

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

Structure virConnectCredential

Structure virConnectCredential
struct _virConnectCredential {
    int	type	: One of virConnectCredentialType constan
    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
    unsigned int	resultlen	: Length of the result
}

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 More may be added - expect the unexpected
}

Enum virConnectFlags

Enum virConnectFlags {
    VIR_CONNECT_RO = 1 : A readonly connection
}

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

Structure virDomain

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

A pointer to a virDomainBlockStats structure

Structure virDomainBlockStatsStruct

Structure virDomainBlockStatsStruct
struct _virDomainBlockStats {
    long long	rd_req
    long long	rd_bytes
    long long	wr_req
    long long	wr_bytes
    long long	errs	: In Xen this returns the mysterious 'oo_
}

Enum virDomainCreateFlags

Enum virDomainCreateFlags {
    VIR_DOMAIN_NONE = 0
}

Structure virDomainInfo

Structure virDomainInfo
struct _virDomainInfo {
    unsigned char	state	: the running state, one of virDomainFlag
    unsigned long	maxMem	: the maximum memory in KBytes allowed
    unsigned long	memory	: the memory in KBytes used by the domain
    unsigned short	nrVirtCpu	: the number of virtual CPUs for the doma
    unsigned long long	cpuTime	: the CPU time used in nanoseconds
}

a virDomainInfoPtr is a pointer to a virDomainInfo structure. A pointe to a virDomainInterfaceStats structure

Structure virDomainInterfaceStatsStruct

Structure virDomainInterfaceStatsStruct
struct _virDomainInterfaceStats {
    long long	rx_bytes
    long long	rx_packets
    long long	rx_errs
    long long	rx_drop
    long long	tx_bytes
    long long	tx_packets
    long long	tx_errs
    long long	tx_drop
}

Enum virDomainMigrateFlags

Enum virDomainMigrateFlags {
    VIR_MIGRATE_LIVE = 1 : live migration
}

a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API.

Enum virDomainState

Enum virDomainState {
    VIR_DOMAIN_NOSTATE = 0 : no state
    VIR_DOMAIN_RUNNING = 1 : the domain is running
    VIR_DOMAIN_BLOCKED = 2 : the domain is blocked on resource
    VIR_DOMAIN_PAUSED = 3 : the domain is paused by user
    VIR_DOMAIN_SHUTDOWN = 4 : the domain is being shut down
    VIR_DOMAIN_SHUTOFF = 5 : the domain is shut off
    VIR_DOMAIN_CRASHED = 6 : the domain is crashed
}

Enum virDomainXMLFlags

Enum virDomainXMLFlags {
    VIR_DOMAIN_XML_SECURE = 1 : dump security sensitive informations too
    VIR_DOMAIN_XML_INACTIVE = 2 : dump inactive domain informations
}

Structure virNetwork

Structure virNetwork
struct _virNetwork {
The content of this structure is not made public by the API.
}

a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.

Structure virNodeInfo

Structure virNodeInfo
struct _virNodeInfo {
    charmodel[32]	model	: string indicating the CPU model
    unsigned long	memory	: memory size in kilobytes
    unsigned int	cpus	: the number of active CPUs
    unsigned int	mhz	: expected CPU frequency
    unsigned int	nodes	: the number of NUMA cell, 1 for uniform
    unsigned int	sockets	: number of CPU socket per node
    unsigned int	cores	: number of core per socket
    unsigned int	threads	: number of threads per core
}

a virNodeInfoPtr is a pointer to a virNodeInfo structure.

Structure virSchedParameter

Structure virSchedParameter
struct _virSchedParameter {
    charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH]	field	: parameter name
    int	type	: parameter type
}

a virSchedParameterPtr is a pointer to a virSchedParameter structure.

Enum virSchedParameterType

Enum virSchedParameterType {
    VIR_DOMAIN_SCHED_FIELD_INT = 1 : integer case
    VIR_DOMAIN_SCHED_FIELD_UINT = 2 : unsigned integer case
    VIR_DOMAIN_SCHED_FIELD_LLONG = 3 : long long case
    VIR_DOMAIN_SCHED_FIELD_ULLONG = 4 : unsigned long long case
    VIR_DOMAIN_SCHED_FIELD_DOUBLE = 5 : double case
    VIR_DOMAIN_SCHED_FIELD_BOOLEAN = 6 : boolean(character) case
}

Structure virVcpuInfo

Structure virVcpuInfo
struct _virVcpuInfo {
    unsigned int	number	: virtual CPU number
    int	state	: value from virVcpuState
    unsigned long long	cpuTime	: CPU time used, in nanoseconds
    int	cpu	: real CPU number, or -1 if offline
}

Enum virVcpuState

Enum virVcpuState {
    VIR_VCPU_OFFLINE = 0 : the virtual CPU is offline
    VIR_VCPU_RUNNING = 1 : the virtual CPU is running
    VIR_VCPU_BLOCKED = 2 : the virtual CPU is blocked on resource
}

Function type: virConnectAuthCallbackPtr

Function type: virConnectAuthCallbackPtr
int	virConnectAuthCallbackPtr	(virConnectCredentialPtr cred, 
					 unsigned int ncred, 
					 void * cbdata)

Function: virConnectClose

int	virConnectClose			(virConnectPtr conn)

This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.

Function: virConnectGetCapabilities

char *	virConnectGetCapabilities	(virConnectPtr conn)

Provides capabilities of the hypervisor / driver.

Function: virConnectGetHostname

char *	virConnectGetHostname		(virConnectPtr conn)

This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call). If we are connected to a remote system, then this returns the hostname of the remote system.

Function: virConnectGetMaxVcpus

int	virConnectGetMaxVcpus		(virConnectPtr conn, 
					 const char * type)

Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The 'type' parameter here corresponds to the 'type' attribute in the <domain> element of the XML.

Function: virConnectGetType

const char *	virConnectGetType	(virConnectPtr conn)

Get the name of the Hypervisor software used.

Function: virConnectGetURI

char *	virConnectGetURI		(virConnectPtr conn)

This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical. If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.

Function: virConnectGetVersion

int	virConnectGetVersion		(virConnectPtr conn, 
					 unsigned long * hvVer)

Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection.

Function: virConnectListDefinedDomains

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

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

Function: virConnectListDefinedNetworks

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

list the inactive networks, stores the pointers to the names in @names

Function: virConnectListDomains

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

Collect the list of active domains, and store their ID in @maxids

Function: virConnectListNetworks

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

Collect the list of active networks, and store their names in @names

Function: virConnectNumOfDefinedDomains

int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

Provides the number of inactive domains.

Function: virConnectNumOfDefinedNetworks

int	virConnectNumOfDefinedNetworks	(virConnectPtr conn)

Provides the number of inactive networks.

Function: virConnectNumOfDomains

int	virConnectNumOfDomains		(virConnectPtr conn)

Provides the number of active domains.

Function: virConnectNumOfNetworks

int	virConnectNumOfNetworks		(virConnectPtr conn)

Provides the number of active networks.

Function: virConnectOpen

virConnectPtr	virConnectOpen		(const char * name)

This function should be called first to get a connection to the Hypervisor and xen store

Function: virConnectOpenAuth

virConnectPtr	virConnectOpenAuth	(const char * name, 
					 virConnectAuthPtr auth, 
					 int flags)

This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback

Function: virConnectOpenReadOnly

virConnectPtr	virConnectOpenReadOnly	(const char * name)

This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.

Function: virDomainAttachDevice

int	virDomainAttachDevice		(virDomainPtr domain, 
					 const char * xml)

Create a virtual device attachment to backend.

Function: virDomainBlockStats

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

This function returns block device (disk) stats for block devices attached to the domain. The path parameter is the name of the block device. Get this by calling virDomainGetXMLDesc and finding the <target dev='...'> attribute within //domain/devices/disk. (For example, "xvda"). Domains may have more than one block device. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.

Function: virDomainCoreDump

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

This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.

Function: virDomainCreate

int	virDomainCreate			(virDomainPtr domain)

launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.

Function: virDomainCreateLinux

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

Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires priviledged access to the hypervisor.

Function: virDomainDefineXML

virDomainPtr	virDomainDefineXML	(virConnectPtr conn, 
					 const char * xml)

define a domain, but does not start it

Function: virDomainDestroy

int	virDomainDestroy		(virDomainPtr domain)

Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access

Function: virDomainDetachDevice

int	virDomainDetachDevice		(virDomainPtr domain, 
					 const char * xml)

Destroy a virtual device attachment to backend.

Function: virDomainFree

int	virDomainFree			(virDomainPtr domain)

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

Function: virDomainGetAutostart

int	virDomainGetAutostart		(virDomainPtr domain, 
					 int * autostart)

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

Function: virDomainGetConnect

virConnectPtr	virDomainGetConnect	(virDomainPtr dom)

Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the domain object together.

Function: virDomainGetID

unsigned int	virDomainGetID		(virDomainPtr domain)

Get the hypervisor ID number for the domain

Function: virDomainGetInfo

int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)

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

Function: virDomainGetMaxMemory

unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)

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

Function: virDomainGetMaxVcpus

int	virDomainGetMaxVcpus		(virDomainPtr domain)

Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.

Function: virDomainGetName

const char *	virDomainGetName	(virDomainPtr domain)

Get the public name for that domain

Function: virDomainGetOSType

char *	virDomainGetOSType		(virDomainPtr domain)

Get the type of domain operation system.

Function: virDomainGetSchedulerParameters

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

Get the scheduler parameters, the @params array will be filled with the values.

Function: virDomainGetSchedulerType

char *	virDomainGetSchedulerType	(virDomainPtr domain, 
					 int * nparams)

Get the scheduler type.

Function: virDomainGetUUID

int	virDomainGetUUID		(virDomainPtr domain, 
					 unsigned char * uuid)

Get the UUID for a domain

Function: virDomainGetUUIDString

int	virDomainGetUUIDString		(virDomainPtr domain, 
					 char * buf)

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

Function: virDomainGetVcpus

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

Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer is'nt NULL.

Function: virDomainGetXMLDesc

char *	virDomainGetXMLDesc		(virDomainPtr domain, 
					 int flags)

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

Function: virDomainInterfaceStats

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

This function returns network interface stats for interfaces attached to the domain. The path parameter is the name of the network interface. Domains may have more than network interface. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.

Function: virDomainLookupByID

virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)

Try to find a domain based on the hypervisor ID number

Function: virDomainLookupByName

virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)

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

Function: virDomainLookupByUUID

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

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

Function: virDomainLookupByUUIDString

virDomainPtr	virDomainLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

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

Function: virDomainMigrate

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

Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host). Flags may be one of more of the following: VIR_MIGRATE_LIVE Attempt a live migration. If a hypervisor supports renaming domains during migration, then you may set the dname parameter to the new name (otherwise it keeps the same name). If this is not supported by the hypervisor, dname must be NULL or else you will get an error. Since typically the two hypervisors connect directly to each other in order to perform the migration, you may need to specify a path from the source to the destination. This is the purpose of the uri parameter. If uri is NULL, then libvirt will try to find the best method. Uri may specify the hostname or IP address of the destination host as seen from the source. Or uri may be a URI giving transport, hostname, user, port, etc. in the usual form. Refer to driver documentation for the particular URIs supported. The maximum bandwidth (in Mbps) that will be used to do migration can be specified with the bandwidth parameter. If set to 0, libvirt will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. To see which features are supported by the current hypervisor, see virConnectGetCapabilities, /capabilities/host/migration_features. There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.

Function: virDomainPinVcpu

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

Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor.

Function: virDomainReboot

int	virDomainReboot			(virDomainPtr domain, 
					 unsigned int flags)

Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.

Function: virDomainRestore

int	virDomainRestore		(virConnectPtr conn, 
					 const char * from)

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

Function: virDomainResume

int	virDomainResume			(virDomainPtr domain)

Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access

Function: virDomainSave

int	virDomainSave			(virDomainPtr domain, 
					 const char * to)

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

Function: virDomainSetAutostart

int	virDomainSetAutostart		(virDomainPtr domain, 
					 int autostart)

Configure the domain to be automatically started when the host machine boots.

Function: virDomainSetMaxMemory

int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)

Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires priviledged access to the hypervisor.

Function: virDomainSetMemory

int	virDomainSetMemory		(virDomainPtr domain, 
					 unsigned long memory)

Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires priviledged access to the hypervisor.

Function: virDomainSetSchedulerParameters

int	virDomainSetSchedulerParameters	(virDomainPtr domain, 
					 virSchedParameterPtr params, 
					 int nparams)

Change the scheduler parameters

Function: virDomainSetVcpus

int	virDomainSetVcpus		(virDomainPtr domain, 
					 unsigned int nvcpus)

Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires priviledged access to the hypervisor.

Function: virDomainShutdown

int	virDomainShutdown		(virDomainPtr domain)

Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?

Function: virDomainSuspend

int	virDomainSuspend		(virDomainPtr domain)

Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires priviledged access.

Function: virDomainUndefine

int	virDomainUndefine		(virDomainPtr domain)

undefine a domain but does not stop it if it is running

Function: virGetVersion

int	virGetVersion			(unsigned long * libVer, 
					 const char * type, 
					 unsigned long * typeVer)

Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not availble, an error code will be returned and @typeVer will be 0.

Function: virInitialize

int	virInitialize			(void)

Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.

Function: virNetworkCreate

int	virNetworkCreate		(virNetworkPtr network)

Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.

Function: virNetworkCreateXML

virNetworkPtr	virNetworkCreateXML	(virConnectPtr conn, 
					 const char * xmlDesc)

Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()

Function: virNetworkDefineXML

virNetworkPtr	virNetworkDefineXML	(virConnectPtr conn, 
					 const char * xml)

Define a network, but does not create it

Function: virNetworkDestroy

int	virNetworkDestroy		(virNetworkPtr network)

Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access

Function: virNetworkFree

int	virNetworkFree			(virNetworkPtr network)

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

Function: virNetworkGetAutostart

int	virNetworkGetAutostart		(virNetworkPtr network, 
					 int * autostart)

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

Function: virNetworkGetBridgeName

char *	virNetworkGetBridgeName		(virNetworkPtr network)

Provides a bridge interface name to which a domain may connect a network interface in order to join the network.

Function: virNetworkGetConnect

virConnectPtr	virNetworkGetConnect	(virNetworkPtr net)

Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the network object together.

Function: virNetworkGetName

const char *	virNetworkGetName	(virNetworkPtr network)

Get the public name for that network

Function: virNetworkGetUUID

int	virNetworkGetUUID		(virNetworkPtr network, 
					 unsigned char * uuid)

Get the UUID for a network

Function: virNetworkGetUUIDString

int	virNetworkGetUUIDString		(virNetworkPtr network, 
					 char * buf)

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

Function: virNetworkGetXMLDesc

char *	virNetworkGetXMLDesc		(virNetworkPtr network, 
					 int flags)

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

Function: virNetworkLookupByName

virNetworkPtr	virNetworkLookupByName	(virConnectPtr conn, 
					 const char * name)

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

Function: virNetworkLookupByUUID

virNetworkPtr	virNetworkLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)

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

Function: virNetworkLookupByUUIDString

virNetworkPtr	virNetworkLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

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

Function: virNetworkSetAutostart

int	virNetworkSetAutostart		(virNetworkPtr network, 
					 int autostart)

Configure the network to be automatically started when the host machine boots.

Function: virNetworkUndefine

int	virNetworkUndefine		(virNetworkPtr network)

Undefine a network but does not stop it if it is running

Function: virNodeGetCellsFreeMemory

int	virNodeGetCellsFreeMemory	(virConnectPtr conn, 
					 unsigned long long * freeMems, 
					 int startCell, 
					 int maxCells)

This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in kilobytes for each cell requested, starting with startCell (in freeMems[0]), up to either (startCell + maxCells), or the number of additional cells in the node, whichever is smaller.

Function: virNodeGetFreeMemory

unsigned long long	virNodeGetFreeMemory	(virConnectPtr conn)

provides the free memory availble on the Node

Function: virNodeGetInfo

int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)

Extract hardware information about the node.