Module libvirt from libvirt

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

#define LIBVIR_VERSION_NUMBER
+      -->libvirt: Module libvirt from libvirt
Home
News
Downloads
DocumentationDeployment
Architecture
XML format
Drivers
API referencelibvirt
virterror
Driver support
Language bindings
Wiki
FAQ
Bug reports
Contact
Related Links
Sitemap
Module libvirt from libvirt
Provides the interfaces of the libvirt library to handle virtualized domains 
Table of Contents
Macros
#define LIBVIR_VERSION_NUMBER
 #define VIR_COPY_CPUMAP
 #define VIR_CPU_MAPLEN
 #define VIR_CPU_USABLE
@@ -30,6 +30,7 @@ typedef struct _virDomainInfo virDomainInfo
 typedef virDomainInfo * virDomainInfoPtr
 typedef virDomainInterfaceStatsStruct * virDomainInterfaceStatsPtr
 typedef struct _virDomainInterfaceStats virDomainInterfaceStatsStruct
+typedef enum virDomainMemoryFlags
 typedef enum virDomainMigrateFlags
 typedef virDomain * virDomainPtr
 typedef enum virDomainState
@@ -83,6 +84,7 @@ int	virConnectNumOfStoragePools	(virConnectPtr	virConnectOpenAuth	(const char * name, 
					 virConnectAuthPtr auth, 
					 int flags)
 virConnectPtr	virConnectOpenReadOnly	(const char * name)
 int	virDomainAttachDevice		(virDomainPtr domain, 
					 const char * xml)
+int	virDomainBlockPeek		(virDomainPtr dom, 
					 const char * path, 
					 unsigned long long offset, 
					 size_t size, 
					 void * buffer, 
					 unsigned int flags)
 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)
@@ -110,6 +112,7 @@ int	virDomainInterfaceStats		(virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)
 virDomainPtr	virDomainLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)
 virDomainPtr	virDomainLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)
+int	virDomainMemoryPeek		(virDomainPtr dom, 
					 unsigned long long start, 
					 size_t size, 
					 void * buffer, 
					 unsigned int flags)
 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)
@@ -208,6 +211,8 @@ char *	virStorageVolGetXMLDesc		(
virDomainInterfaceStatsStruct
struct virDomainInterfaceStatsStruct{
 
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
 }
+
virDomainMemoryFlags
enum virDomainMemoryFlags {
+
VIR_MEMORY_VIRTUAL  = 1  : addresses are virtual addresses
}
 
virDomainMigrateFlags
enum virDomainMigrateFlags {
 
VIR_MIGRATE_LIVE  = 1  : live migration
}
 
virDomainState
enum virDomainState {
@@ -276,13 +281,14 @@ char *	virStorageVolGetXMLDesc		(This function should be called first to get a connection to the Hypervisor and xen store
name: URI of the hypervisor
Returns: a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.htmlvirConnectOpenAuth
virConnectPtr	virConnectOpenAuth	(const char * name, 
					 virConnectAuthPtr auth, 
					 int flags)

 
This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback
name: URI of the hypervisor
auth: Authenticate callback parameters
flags: Open flags
Returns: a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html
virConnectOpenReadOnly
virConnectPtr	virConnectOpenReadOnly	(const char * name)

 
This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.
name: URI of the hypervisor
Returns: a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html
virDomainAttachDevice
int	virDomainAttachDevice		(virDomainPtr domain, 
					 const char * xml)

-
Create a virtual device attachment to backend.
domain: pointer to domain object
xml: pointer to XML description of one device
Returns: 0 in case of success, -1 in case of failure.
virDomainBlockStats
int	virDomainBlockStats		(virDomainPtr dom, 
					 const char * path, 
					 virDomainBlockStatsPtr stats, 
					 size_t size)

+
Create a virtual device attachment to backend.
domain: pointer to domain object
xml: pointer to XML description of one device
Returns: 0 in case of success, -1 in case of failure.
virDomainBlockPeek
int	virDomainBlockPeek		(virDomainPtr dom, 
					 const char * path, 
					 unsigned long long offset, 
					 size_t size, 
					 void * buffer, 
					 unsigned int flags)

+
This function allows you to read the contents of a domain's disk device. Typical uses for this are to determine if the domain has written a Master Boot Record (indicating that the domain has completed installation), or to try to work out the state of the domain's filesystems. (Note that in the local case you might try to open the block device or file directly, but that won't work in the remote case, nor if you don't have sufficient permission. Hence the need for this call). 'path' must be a device or file corresponding to the domain. In other words it must be the precise string returned in a <disk><source dev='...'/></disk> from virDomainGetXMLDesc. 'offset' and 'size' represent an area which must lie entirely within the device or file. 'size' may be 0 to test if the call would succeed. 'buffer' is the return buffer and must be at least 'size' bytes. NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to <= 65536 bytes.
dom: pointer to the domain object
path: path to the block device
offset: offset within block device
size: size to read
buffer: return buffer (must be at least size bytes)
flags: unused, always pass 0
Returns: 0 in case of success or -1 in case of failure. really 64 bits
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.
dom: pointer to the domain object
path: path to the block device
stats: block device stats (returned)
size: size of stats structure
Returns: 0 in case of success or -1 in case of failure.
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.
domain: a domain object
to: path for the core file
flags: extra flags, currently unused
Returns: 0 in case of success and -1 in case of failure.
virDomainCreate
int	virDomainCreate			(virDomainPtr domain)

 
launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.
domain: pointer to a defined domain
Returns: 0 in case of success, -1 in case of error
virDomainCreateLinux
virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * xmlDesc, 
					 unsigned int flags)

 
Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.
conn: pointer to the hypervisor connection
xmlDesc: string containing an XML description of the domain
flags: an optional set of virDomainFlags
Returns: a new domain object or NULL in case of failure
virDomainDefineXML
virDomainPtr	virDomainDefineXML	(virConnectPtr conn, 
					 const char * xml)

 
define a domain, but does not start it
conn: pointer to the hypervisor connection
xml: the XML description for the domain, preferably in UTF-8
Returns: NULL in case of error, a pointer to the domain otherwise
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 privileged access
domain: a domain object
Returns: 0 in case of success and -1 in case of failure.
virDomainDetachDevice
int	virDomainDetachDevice		(virDomainPtr domain, 
					 const char * xml)

+
Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virDomainPtr object. This function may require privileged access
domain: a domain object
Returns: 0 in case of success and -1 in case of failure.
virDomainDetachDevice
int	virDomainDetachDevice		(virDomainPtr domain, 
					 const char * xml)

 
Destroy a virtual device attachment to backend.
domain: pointer to domain object
xml: pointer to XML description of one device
Returns: 0 in case of success, -1 in case of failure.
virDomainFree
int	virDomainFree			(virDomainPtr domain)

 
Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.
domain: a domain object
Returns: 0 in case of success and -1 in case of failure.
virDomainGetAutostart
int	virDomainGetAutostart		(virDomainPtr domain, 
					 int * autostart)

 
Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.
domain: a domain object
autostart: the value returned
Returns: -1 in case of error, 0 in case of success
virDomainGetConnect
virConnectPtr	virDomainGetConnect	(virDomainPtr dom)

@@ -300,10 +306,11 @@ char *	virStorageVolGetXMLDesc		(Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn't NULL.
domain: pointer to domain object, or NULL for Domain0
info: pointer to an array of virVcpuInfo structures (OUT)
maxinfo: number of structures in info array
cpumaps: pointer to an bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It's assumed there is <maxinfo> cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.
maplen: number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...).
Returns: the number of info filled in case of success, -1 in case of failure.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().
domain: a domain object
flags: an OR'ed set of virDomainXMLFlags
Returns: a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.
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.
dom: pointer to the domain object
path: path to the interface
stats: network interface stats (returned)
size: size of stats structure
Returns: 0 in case of success or -1 in case of failure.
virDomainLookupByID
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)

-
Try to find a domain based on the hypervisor ID number
conn: pointer to the hypervisor connection
id: the domain ID number
Returns: a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
virDomainLookupByName
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)

+
Try to find a domain based on the hypervisor ID number Note that this won't work for inactive domains which have an ID of -1, in that case a lookup based on the Name or UUId need to be done instead.
conn: pointer to the hypervisor connection
id: the domain ID number
Returns: a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
virDomainLookupByName
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)

 
Try to lookup a domain on the given hypervisor based on its name.
conn: pointer to the hypervisor connection
name: name for the domain
Returns: a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
virDomainLookupByUUID
virDomainPtr	virDomainLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)

 
Try to lookup a domain on the given hypervisor based on its UUID.
conn: pointer to the hypervisor connection
uuid: the raw UUID for the domain
Returns: a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
virDomainLookupByUUIDString
virDomainPtr	virDomainLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

-
Try to lookup a domain on the given hypervisor based on its UUID.
conn: pointer to the hypervisor connection
uuidstr: the string UUID for the domain
Returns: a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
virDomainMigrate
virDomainPtr	virDomainMigrate	(virDomainPtr domain, 
					 virConnectPtr dconn, 
					 unsigned long flags, 
					 const char * dname, 
					 const char * uri, 
					 unsigned long bandwidth)

+
Try to lookup a domain on the given hypervisor based on its UUID.
conn: pointer to the hypervisor connection
uuidstr: the string UUID for the domain
Returns: a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
virDomainMemoryPeek
int	virDomainMemoryPeek		(virDomainPtr dom, 
					 unsigned long long start, 
					 size_t size, 
					 void * buffer, 
					 unsigned int flags)

+
This function allows you to read the contents of a domain's memory. The memory which is read is controlled by the 'start', 'size' and 'flags' parameters. If 'flags' is VIR_MEMORY_VIRTUAL then the 'start' and 'size' parameters are interpreted as virtual memory addresses for whichever task happens to be running on the domain at the moment. Although this sounds haphazard it is in fact what you want in order to read Linux kernel state, because it ensures that pointers in the kernel image can be interpreted coherently. 'buffer' is the return buffer and must be at least 'size' bytes. 'size' may be 0 to test if the call would succeed. NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to <= 65536 bytes.
dom: pointer to the domain object
start: start of memory to peek
size: size of memory to peek
buffer: return buffer (must be at least size bytes)
flags: flags, see below
Returns: 0 in case of success or -1 in case of failure. really 64 bits
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.
domain: a domain object
dconn: destination host (a connection object)
flags: flags
dname: (optional) rename domain to this at destination
uri: (optional) dest hostname/URI as seen from the source host
bandwidth: (optional) specify migration bandwidth limit in Mbps
Returns: the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).
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 privileged access to the hypervisor.
domain: pointer to domain object, or NULL for Domain0
vcpu: virtual CPU number
cpumap: pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.
maplen: number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.
Returns: 0 in case of success, -1 in case of failure.
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.
domain: a domain object
flags: extra flags for the reboot operation, not used yet
Returns: 0 in case of success and -1 in case of failure.
virDomainRestore
int	virDomainRestore		(virConnectPtr conn, 
					 const char * from)

@@ -323,7 +330,7 @@ char *	virStorageVolGetXMLDesc		(Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.
network: pointer to a defined network
Returns: 0 in case of success, -1 in case of errorvirNetworkCreateXML
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()
conn: pointer to the hypervisor connection
xmlDesc: an XML description of the network
Returns: a new network object or NULL in case of failure
virNetworkDefineXML
virNetworkPtr	virNetworkDefineXML	(virConnectPtr conn, 
					 const char * xml)

 
Define a network, but does not create it
conn: pointer to the hypervisor connection
xml: the XML description for the network, preferably in UTF-8
Returns: NULL in case of error, a pointer to the network otherwise
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 privileged access
network: a network object
Returns: 0 in case of success and -1 in case of failure.
virNetworkFree
int	virNetworkFree			(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. This does not free the associated virNetworkPtr object. This function may require privileged access
network: a network object
Returns: 0 in case of success and -1 in case of failure.
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.
network: a network object
Returns: 0 in case of success and -1 in case of failure.
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.
network: a network object
autostart: the value returned
Returns: -1 in case of error, 0 in case of success
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.
network: a network object
Returns: a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.
virNetworkGetConnect
virConnectPtr	virNetworkGetConnect	(virNetworkPtr net)

diff --git a/docs/html/libvirt-virterror.html b/docs/html/libvirt-virterror.html
index bb0cf72fd7..e355078271 100644
--- a/docs/html/libvirt-virterror.html
+++ b/docs/html/libvirt-virterror.html
@@ -25,7 +25,7 @@ void	virSetErrorFunc			(void * userData, 

 
int code  : The error code, a virErrorNumber
int domain  : What part of the library raised this error
char * message  : human-readable informative error message
virErrorLevel level  : how consequent is the error
virConnectPtr conn  : connection if available, see note above
virDomainPtr dom  : domain if available, see note above
char * str1  : extra string information
char * str2  : extra string information
char * str3  : extra string information
int int1  : extra number information
int int2  : extra number information
virNetworkPtr net  : network if available, see note above
 }
 
virErrorDomain
enum virErrorDomain {
-
VIR_FROM_NONE  = 0
VIR_FROM_XEN  = 1  : Error at Xen hypervisor layer
VIR_FROM_XEND  = 2  : Error at connection with xend daemon
VIR_FROM_XENSTORE  = 3  : Error at connection with xen store
VIR_FROM_SEXPR  = 4  : Error in the S-Expression code
VIR_FROM_XML  = 5  : Error in the XML code
VIR_FROM_DOM  = 6  : Error when operating on a domain
VIR_FROM_RPC  = 7  : Error in the XML-RPC code
VIR_FROM_PROXY  = 8  : Error in the proxy code
VIR_FROM_CONF  = 9  : Error in the configuration file handling
VIR_FROM_QEMU  = 10  : Error at the QEMU daemon
VIR_FROM_NET  = 11  : Error when operating on a network
VIR_FROM_TEST  = 12  : Error from test driver
VIR_FROM_REMOTE  = 13  : Error from remote driver
VIR_FROM_OPENVZ  = 14  : Error from OpenVZ driver
VIR_FROM_XENXM  = 15  : Error at Xen XM layer
VIR_FROM_STATS_LINUX  = 16  : Error in the Linux Stats code
VIR_FROM_LXC  = 17  : Error from Linux Container driver
VIR_FROM_STORAGE  = 18  : Error from storage driver
}
+
VIR_FROM_NONE  = 0
VIR_FROM_XEN  = 1  : Error at Xen hypervisor layer
VIR_FROM_XEND  = 2  : Error at connection with xend daemon
VIR_FROM_XENSTORE  = 3  : Error at connection with xen store
VIR_FROM_SEXPR  = 4  : Error in the S-Expression code
VIR_FROM_XML  = 5  : Error in the XML code
VIR_FROM_DOM  = 6  : Error when operating on a domain
VIR_FROM_RPC  = 7  : Error in the XML-RPC code
VIR_FROM_PROXY  = 8  : Error in the proxy code
VIR_FROM_CONF  = 9  : Error in the configuration file handling
VIR_FROM_QEMU  = 10  : Error at the QEMU daemon
VIR_FROM_NET  = 11  : Error when operating on a network
VIR_FROM_TEST  = 12  : Error from test driver
VIR_FROM_REMOTE  = 13  : Error from remote driver
VIR_FROM_OPENVZ  = 14  : Error from OpenVZ driver
VIR_FROM_XENXM  = 15  : Error at Xen XM layer
VIR_FROM_STATS_LINUX  = 16  : Error in the Linux Stats code
VIR_FROM_LXC  = 17  : Error from Linux Container driver
VIR_FROM_STORAGE  = 18  : Error from storage driver
VIR_FROM_NETWORK  = 19  : Error from network config
VIR_FROM_DOMAIN  = 20  : Error from domain config
}
 
virErrorLevel
enum virErrorLevel {
 
VIR_ERR_NONE  = 0
VIR_ERR_WARNING  = 1  : A simple warning
VIR_ERR_ERROR  = 2  : An error
}
 
virErrorNumber
enum virErrorNumber {
diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index 3a4317ab12..136ba0d756 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -3,7 +3,7 @@
   
     
      core interfaces for the libvirt library
-     Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 
+     Provides the interfaces of the libvirt library to handle virtualized domains 
      Daniel Veillard <veillard@redhat.com> 
      
      
@@ -36,6 +36,7 @@
      
      
      
+     
      
      
      
@@ -87,10 +88,11 @@
      
      
      
-     
+     
      
      
      
+     
      
      
      
@@ -188,6 +190,7 @@
      
      
      
+     
      
      
      
@@ -233,6 +236,7 @@
      
      
      
+     
      
      
     
@@ -289,6 +293,7 @@
      
      
      
+     
      
      
      
@@ -298,6 +303,7 @@
      
      
      
+     
      
      
      
@@ -463,8 +469,10 @@
     
     
     
+    
     
     
+    
     
     
     
@@ -473,13 +481,14 @@
     
     
     
-    
+    
     
     
     
     
     
     
+    
     
     
     
@@ -519,7 +528,7 @@
     
     
     
-      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.
+      a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Hypervisor in the API.
     
     
     
@@ -556,9 +565,10 @@
       
       
     
+    
     
     
-      a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API.
+      a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a domain in the API.
     
     
     
@@ -567,7 +577,8 @@
       
       
       
-      
+      
       
       
       
@@ -812,6 +823,16 @@
       
       
     
+    
+      This function allows you to read the contents of a domain's disk device.  Typical uses for this are to determine if the domain has written a Master Boot Record (indicating that the domain has completed installation), or to try to work out the state of the domain's filesystems.  (Note that in the local case you might try to open the block device or file directly, but that won't work in the remote case, nor if you don't have sufficient permission. Hence the need for this call).  'path' must be a device or file corresponding to the domain. In other words it must be the precise string returned in a <disk><source dev='...'/></disk> from virDomainGetXMLDesc.  'offset' and 'size' represent an area which must lie entirely within the device or file.  'size' may be 0 to test if the call would succeed.  'buffer' is the return buffer and must be at least 'size' bytes.  NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to <= 65536 bytes.
+      
+      
+      
+      
+      
+      
+      
+    
     
       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.
       
@@ -846,7 +867,7 @@
       
     
     
-      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 privileged access
+      Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virDomainPtr object. This function may require privileged access
       
       
     
@@ -952,7 +973,7 @@
       
     
     
-      Try to find a domain based on the hypervisor ID number
+      Try to find a domain based on the hypervisor ID number Note that this won't work for inactive domains which have an ID of -1, in that case a lookup based on the Name or UUId need to be done instead.
       
       
       
@@ -975,6 +996,15 @@
       
       
     
+    
+      This function allows you to read the contents of a domain's memory.  The memory which is read is controlled by the 'start', 'size' and 'flags' parameters.  If 'flags' is VIR_MEMORY_VIRTUAL then the 'start' and 'size' parameters are interpreted as virtual memory addresses for whichever task happens to be running on the domain at the moment.  Although this sounds haphazard it is in fact what you want in order to read Linux kernel state, because it ensures that pointers in the kernel image can be interpreted coherently.  'buffer' is the return buffer and must be at least 'size' bytes. 'size' may be 0 to test if the call would succeed.  NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to <= 65536 bytes.
+      
+      
+      
+      
+      
+      
+    
     
       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.
       
@@ -1101,7 +1131,7 @@
       
     
     
-      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 privileged access
+      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. This does not free the associated virNetworkPtr object. This function may require privileged access
       
       
     
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index 4d10350262..9504755e50 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -86,8 +86,10 @@
     
     
     
+    
     
     
+    
     
     
     
@@ -104,6 +106,7 @@
     
     
     
+    
     
     
     
@@ -179,6 +182,7 @@
     
     
     
+    
     
     
     
@@ -213,6 +217,8 @@
     
     
     
+    
+    
     
     
     
@@ -411,8 +417,10 @@
       
       
       
+      
       
       
+      
       
       
       
@@ -429,6 +437,7 @@
       
       
       
+      
       
       
       
@@ -508,6 +517,7 @@
       
       
       
+      
       
       
       
@@ -542,6 +552,8 @@
       
       
       
+      
+      
       
       
       
@@ -729,8 +741,10 @@
       
     
     
+      
       
       
+      
     
     
       
@@ -741,7 +755,9 @@
     
     
       
+      
       
+      
       
       
       
@@ -765,6 +781,10 @@
       
       
     
+    
+      
+      
+    
     
       
     
@@ -833,6 +853,7 @@
     
     
       
+      
       
       
       
@@ -854,6 +875,7 @@
       
       
       
+      
       
       
       
@@ -944,6 +966,8 @@
     
       
       
+      
+      
       
       
     
@@ -982,6 +1006,7 @@
       
       
       
+      
       
       
       
@@ -1048,6 +1073,7 @@
       
       
       
+      
       
       
       
@@ -1082,6 +1108,8 @@
       
       
       
+      
+      
       
       
       
@@ -1236,8 +1264,10 @@
       
       
       
+      
       
       
+      
       
       
       
@@ -1296,6 +1326,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -1304,6 +1337,9 @@
         
       
       
+        
+          
+        
         
           
         
@@ -1460,8 +1496,10 @@
           
         
         
+          
           
           
+          
           
         
         
@@ -1489,6 +1527,9 @@
         
       
       
+        
+          
+        
         
           
           
@@ -1529,6 +1570,7 @@
         
         
           
+          
         
         
           
@@ -1543,6 +1585,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -1558,6 +1603,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -1568,8 +1616,10 @@
           
         
         
+          
           
           
+          
           
           
           
@@ -1628,6 +1678,8 @@
           
         
       
+    
+    
       
         
           
@@ -1639,6 +1691,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -1666,8 +1721,6 @@
           
         
       
-    
-    
       
         
           
@@ -1718,6 +1771,9 @@
           
           
         
+        
+          
+        
       
       
         
@@ -1753,6 +1809,9 @@
           
           
         
+        
+          
+        
         
           
           
@@ -1786,6 +1845,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -1844,6 +1906,10 @@
         
       
       
+        
+          
+          
+        
         
           
           
@@ -1900,6 +1966,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -1945,6 +2014,10 @@
         
           
         
+        
+          
+          
+        
         
           
           
@@ -1955,6 +2028,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -1996,12 +2072,17 @@
           
           
           
+          
           
+          
           
           
           
           
         
+        
+          
+        
         
           
           
@@ -2029,7 +2110,9 @@
           
         
         
+          
           
+          
           
           
           
@@ -2116,6 +2199,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -2125,6 +2211,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -2148,7 +2237,12 @@
           
           
         
+        
+          
+          
+        
         
+          
           
         
         
@@ -2173,6 +2267,8 @@
         
           
           
+          
+          
           
           
         
@@ -2182,6 +2278,7 @@
           
           
           
+          
           
           
           
@@ -2193,25 +2290,10 @@
           
         
         
+          
+          
           
         
-        
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
       
       
         
@@ -2221,14 +2303,14 @@
           
           
           
+          
           
-          
           
+          
           
           
           
           
-          
           
           
           
@@ -2276,6 +2358,7 @@
           
           
           
+          
           
           
           
@@ -2349,6 +2432,9 @@
           
           
         
+        
+          
+        
         
           
           
@@ -2366,6 +2452,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -2410,12 +2499,17 @@
           
         
         
+          
+          
           
         
         
           
           
         
+        
+          
+        
         
           
           
@@ -2426,6 +2520,7 @@
           
         
         
+          
           
         
         
@@ -2493,10 +2588,8 @@
       
         
           
-          
           
           
-          
           
           
         
@@ -2566,14 +2659,19 @@
           
           
         
+        
+          
+        
         
           
         
         
+          
           
         
         
           
+          
           
           
         
@@ -2585,12 +2683,14 @@
           
         
         
+          
           
         
         
           
         
         
+          
           
           
           
@@ -2633,8 +2733,15 @@
           
           
           
+          
           
         
+        
+          
+        
+        
+          
+        
         
           
           
@@ -2642,6 +2749,8 @@
         
           
           
+          
+          
           
           
         
@@ -2677,6 +2786,12 @@
           
           
         
+        
+          
+        
+        
+          
+        
         
           
         
@@ -2722,6 +2837,9 @@
         
       
       
+        
+          
+        
         
           
         
@@ -2758,9 +2876,13 @@
           
         
         
+          
           
           
         
+        
+          
+        
         
           
           
@@ -2793,6 +2915,7 @@
           
           
           
+          
           
           
           
@@ -2849,8 +2972,10 @@
           
           
           
+          
           
           
+          
           
           
           
@@ -2866,10 +2991,8 @@
         
           
           
-          
           
           
-          
           
         
         
@@ -2879,6 +3002,7 @@
           
           
           
+          
           
           
           
@@ -2898,11 +3022,13 @@
           
           
           
+          
           
           
           
           
           
+          
           
           
           
@@ -3008,16 +3134,25 @@
           
           
         
+        
+          
+        
+        
+          
+        
         
           
         
         
+          
           
           
         
         
+          
           
           
+          
           
           
         
@@ -3080,9 +3215,16 @@
           
           
         
+        
+          
+        
         
           
         
+        
+          
+          
+        
         
           
           
@@ -3091,6 +3233,7 @@
           
           
           
+          
           
           
           
@@ -3110,6 +3253,7 @@
         
         
           
+          
           
           
         
@@ -3142,6 +3286,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3151,6 +3298,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -3166,6 +3316,7 @@
         
         
           
+          
         
         
           
@@ -3219,6 +3370,9 @@
           
           
         
+        
+          
+        
         
           
           
@@ -3245,6 +3399,10 @@
           
           
         
+        
+          
+          
+        
         
           
           
@@ -3268,6 +3426,8 @@
           
         
         
+          
+          
           
         
         
@@ -3314,11 +3474,16 @@
           
           
         
+        
+          
+        
         
           
           
         
         
+          
+          
           
         
         
@@ -3350,6 +3515,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3364,6 +3532,7 @@
           
         
         
+          
           
           
           
@@ -3449,29 +3618,6 @@
           
           
         
-        
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
         
           
         
@@ -3483,6 +3629,7 @@
           
           
           
+          
           
           
           
@@ -3507,6 +3654,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -3527,6 +3677,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -3564,10 +3717,12 @@
           
           
           
+          
           
           
           
           
+          
           
           
           
@@ -3618,7 +3773,9 @@
           
           
           
+          
           
+          
           
           
         
@@ -3668,6 +3825,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -3700,6 +3860,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3719,6 +3882,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3735,6 +3901,7 @@
           
         
         
+          
           
           
         
@@ -3747,6 +3914,7 @@
           
         
         
+          
           
           
           
@@ -3764,9 +3932,16 @@
           
           
         
+        
+          
+        
         
           
         
+        
+          
+          
+        
       
     
     
@@ -3786,6 +3961,7 @@
           
           
           
+          
           
         
         
@@ -3802,6 +3978,7 @@
         
         
           
+          
           
           
         
@@ -3809,6 +3986,7 @@
           
         
         
+          
           
           
           
@@ -3818,6 +3996,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -3827,6 +4008,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3846,6 +4030,7 @@
         
           
           
+          
         
         
           
@@ -3866,6 +4051,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -3899,6 +4087,10 @@
         
           
         
+        
+          
+          
+        
         
           
           
@@ -3948,6 +4140,8 @@
         
         
           
+          
+          
         
         
           
@@ -3955,6 +4149,10 @@
           
           
         
+        
+          
+          
+        
         
           
           
@@ -3996,13 +4194,19 @@
         
           
         
+        
+          
+          
+        
         
           
           
         
         
           
+          
           
+          
           
         
         
@@ -4014,6 +4218,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -4023,6 +4230,12 @@
         
         
           
+          
+          
+        
+        
+          
+          
         
         
           
@@ -4031,14 +4244,12 @@
         
         
           
-          
           
           
           
           
           
           
-          
         
         
           
@@ -4083,16 +4294,17 @@
         
           
           
-          
+          
           
           
+          
           
           
-          
           
         
         
           
+          
           
           
           
@@ -4139,6 +4351,7 @@
           
           
           
+          
           
           
           
@@ -4186,6 +4399,7 @@
         
           
           
+          
           
           
         
@@ -4214,15 +4428,15 @@
           
           
           
+          
           
-          
           
           
           
+          
           
           
           
-          
           
           
         
@@ -4248,27 +4462,6 @@
         
           
         
-        
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
         
           
         
@@ -4278,7 +4471,11 @@
         
           
         
+        
+          
+        
         
+          
           
         
         
@@ -4296,8 +4493,13 @@
         
           
         
+        
+          
+          
+        
         
           
+          
           
           
         
@@ -4321,6 +4523,8 @@
         
         
           
+          
+          
           
           
         
@@ -4383,6 +4587,7 @@
           
           
           
+          
           
           
           
@@ -4396,11 +4601,9 @@
         
         
           
-          
           
           
           
-          
           
           
         
@@ -4408,7 +4611,9 @@
           
         
         
+          
           
+          
           
         
         
@@ -4419,6 +4624,9 @@
           
           
         
+        
+          
+        
         
           
           
@@ -4465,6 +4673,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -4474,6 +4685,10 @@
           
           
         
+        
+          
+          
+        
         
           
           
@@ -4486,11 +4701,14 @@
           
           
           
+          
           
           
           
           
           
+          
+          
           
           
           
@@ -4513,6 +4731,7 @@
           
           
           
+          
           
           
           
@@ -4533,9 +4752,7 @@
           
         
         
-          
           
-          
           
         
         
@@ -4565,6 +4782,7 @@
           
         
         
+          
           
         
         
@@ -4629,6 +4847,7 @@
           
         
         
+          
           
           
           
@@ -4707,6 +4926,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -4800,6 +5022,7 @@
           
         
         
+          
           
           
         
@@ -4814,6 +5037,9 @@
           
           
         
+        
+          
+        
         
           
         
@@ -4839,6 +5065,9 @@
         
           
         
+        
+          
+        
         
           
           
@@ -4892,6 +5121,7 @@
           
           
           
+          
           
           
           
@@ -4912,6 +5142,9 @@
         
       
       
+        
+          
+        
         
           
           
@@ -4924,6 +5157,7 @@
           
         
         
+          
           
         
         
@@ -4954,8 +5188,11 @@
           
           
           
+          
           
           
+          
+          
           
           
           
@@ -4970,6 +5207,7 @@
           
         
         
+          
           
         
         
@@ -5000,6 +5238,7 @@
           
         
         
+          
           
           
           
@@ -5010,8 +5249,22 @@
         
           
         
+        
+          
+          
+        
+        
+          
+        
         
           
+          
+          
+          
+        
+        
+          
+          
         
         
           
@@ -5024,6 +5277,7 @@
         
         
           
+          
         
         
           
@@ -5045,10 +5299,16 @@
           
         
         
+          
           
           
+          
           
         
+        
+          
+          
+        
       
       
         
@@ -5059,8 +5319,8 @@
       
     
     
-      
-      
+      
+      
       
       
       
diff --git a/include/libvirt/libvirt.h b/include/libvirt/libvirt.h
index 8980bc24aa..9c3e1c27b1 100644
--- a/include/libvirt/libvirt.h
+++ b/include/libvirt/libvirt.h
@@ -2,7 +2,7 @@
  * libvirt.h:
  * Summary: core interfaces for the libvirt library
  * Description: Provides the interfaces of the libvirt library to handle
- *              Xen domains from a process running in domain 0
+ *              virtualized domains
  *
  * Copy:  Copyright (C) 2005,2006 Red Hat, Inc.
  *
@@ -33,7 +33,7 @@ extern "C" {
  * virConnect:
  *
  * a virConnect is a private structure representing a connection to
- * the Xen Hypervisor.
+ * the Hypervisor.
  */
 typedef struct _virConnect virConnect;
 
@@ -41,14 +41,14 @@ typedef struct _virConnect virConnect;
  * virConnectPtr:
  *
  * 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.
+ * type used to reference a connection to the Hypervisor in the API.
  */
 typedef virConnect *virConnectPtr;
 
 /**
  * virDomain:
  *
- * a virDomain is a private structure representing a Xen domain.
+ * a virDomain is a private structure representing a domain.
  */
 typedef struct _virDomain virDomain;
 
@@ -56,7 +56,7 @@ typedef struct _virDomain virDomain;
  * virDomainPtr:
  *
  * a virDomainPtr is pointer to a virDomain private structure, this is the
- * type used to reference a Xen domain in the API.
+ * type used to reference a domain in the API.
  */
 typedef virDomain *virDomainPtr;
 
diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
index bd5195c10d..f077a26628 100644
--- a/include/libvirt/libvirt.h.in
+++ b/include/libvirt/libvirt.h.in
@@ -2,7 +2,7 @@
  * libvirt.h:
  * Summary: core interfaces for the libvirt library
  * Description: Provides the interfaces of the libvirt library to handle
- *              Xen domains from a process running in domain 0
+ *              virtualized domains
  *
  * Copy:  Copyright (C) 2005,2006 Red Hat, Inc.
  *
@@ -33,7 +33,7 @@ extern "C" {
  * virConnect:
  *
  * a virConnect is a private structure representing a connection to
- * the Xen Hypervisor.
+ * the Hypervisor.
  */
 typedef struct _virConnect virConnect;
 
@@ -41,14 +41,14 @@ typedef struct _virConnect virConnect;
  * virConnectPtr:
  *
  * 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.
+ * type used to reference a connection to the Hypervisor in the API.
  */
 typedef virConnect *virConnectPtr;
 
 /**
  * virDomain:
  *
- * a virDomain is a private structure representing a Xen domain.
+ * a virDomain is a private structure representing a domain.
  */
 typedef struct _virDomain virDomain;
 
@@ -56,7 +56,7 @@ typedef struct _virDomain virDomain;
  * virDomainPtr:
  *
  * a virDomainPtr is pointer to a virDomain private structure, this is the
- * type used to reference a Xen domain in the API.
+ * type used to reference a domain in the API.
  */
 typedef virDomain *virDomainPtr;
`domain`:	pointer to domain object
`xml`:	pointer to XML description of one device
`Returns`:	0 in case of success, -1 in case of failure.
`dom`:	pointer to the domain object
`path`:	path to the block device
`offset`:	offset within block device
`size`:	size to read
`buffer`:	return buffer (must be at least size bytes)
`flags`:	unused, always pass 0
`Returns`:	0 in case of success or -1 in case of failure. really 64 bits
`conn`:	pointer to the hypervisor connection
`xml`:	the XML description for the domain, preferably in UTF-8
`Returns`:	NULL in case of error, a pointer to the domain otherwise
`domain`:	a domain object
`Returns`:	0 in case of success and -1 in case of failure.
`conn`:	pointer to the hypervisor connection
`id`:	the domain ID number
`Returns`:	a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
`conn`:	pointer to the hypervisor connection
`uuidstr`:	the string UUID for the domain
`Returns`:	a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
`dom`:	pointer to the domain object
`start`:	start of memory to peek
`size`:	size of memory to peek
`buffer`:	return buffer (must be at least size bytes)
`flags`:	flags, see below
`Returns`:	0 in case of success or -1 in case of failure. really 64 bits
`network`:	a network object
`Returns`:	0 in case of success and -1 in case of failure.
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
`name`:	URI of the hypervisor
`Returns`:	a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html
`name`:	URI of the hypervisor
`auth`:	Authenticate callback parameters
`flags`:	Open flags
`Returns`:	a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html
`domain`:	a domain object
`to`:	path for the core file
`flags`:	extra flags, currently unused
`Returns`:	0 in case of success and -1 in case of failure.
`domain`:	pointer to a defined domain
`Returns`:	0 in case of success, -1 in case of error
`conn`:	pointer to the hypervisor connection
`xmlDesc`:	string containing an XML description of the domain
`flags`:	an optional set of virDomainFlags
`Returns`:	a new domain object or NULL in case of failure
`domain`:	a domain object
`autostart`:	the value returned
`Returns`:	-1 in case of error, 0 in case of success
`domain`:	pointer to domain object, or NULL for Domain0
`info`:	pointer to an array of virVcpuInfo structures (OUT)
`maxinfo`:	number of structures in info array
`cpumaps`:	pointer to an bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It's assumed there is <maxinfo> cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.
`maplen`:	number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...).
`Returns`:	the number of info filled in case of success, -1 in case of failure.
`conn`:	pointer to the hypervisor connection
`uuid`:	the raw UUID for the domain
`Returns`:	a new domain object or NULL in case of failure. If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
`domain`:	a domain object
`dconn`:	destination host (a connection object)
`flags`:	flags
`dname`:	(optional) rename domain to this at destination
`uri`:	(optional) dest hostname/URI as seen from the source host
`bandwidth`:	(optional) specify migration bandwidth limit in Mbps
`Returns`:	the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).
`domain`:	pointer to domain object, or NULL for Domain0
`vcpu`:	virtual CPU number
`cpumap`:	pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.
`maplen`:	number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen < size, missing bytes are set to zero. If maplen > size, failure code is returned.
`Returns`:	0 in case of success, -1 in case of failure.
`network`:	pointer to a defined network
`Returns`:	0 in case of success, -1 in case of error
Synopsis

Typedef virConnectPtr

Structure virDomain

Enum virDomainMemoryFlags

Enum virDomainMigrateFlags

Typedef virDomainPtr

Enum virDomainState

Module libvirt from libvirt

Table of Contents

Module libvirt from libvirt

Table of Contents
