Libvir the virtualization API

path to the

#define LIBVIR_VERSION_NUMBER
Structure virConnect
struct _virConnect
+Module libvir from libvir
main menu
Home
API Menu
Recent Changes
related links
Mail archive
Xen project
API documentation The virtualization API
Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0 
Table of Contents
#define LIBVIR_VERSION_NUMBER
Structure virConnect
struct _virConnect
 The content of this structure is not made public by the API.
 
Typedef virConnect * virConnectPtr
 
Enum virDeviceMode
@@ -42,7 +32,7 @@ The content of this structure is not made public by the API.
 char *	virDomainGetXMLDesc		(virDomainPtr domain, 
					 int flags)
 virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)
 virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)
-int	virDomainRestore		(virDomainPtr domain, 
					 const char * from)
+int	virDomainRestore		(virConnectPtr conn, 
					 const char * from)
 int	virDomainResume			(virDomainPtr domain)
 int	virDomainSave			(virDomainPtr domain, 
					 const char * to)
 int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)
@@ -111,7 +101,7 @@ The content of this structure is not made public by the API.
 conn: pointer to the hypervisor connection
Returns: the number of domain found or -1 in case of error
Function: virConnectOpen
virConnectPtr	virConnectOpen		(const char * name)

 
This function should be called first to get a connection to the Hypervisor and xen store
 name: optional argument currently unused, pass NULL
Returns: a pointer to the hypervisor connection or NULL in case of error
Function: virConnectOpenReadOnly
virConnectPtr	virConnectOpenReadOnly	(const char * name)

-
This function should be called first to get a read-only connection to the xen store. The set of APIs usable are then restricted.
+
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.
 name: optional argument currently unused, pass NULL
Returns: a pointer to the hypervisor connection or NULL in case of error
Function: virDomainCreateLinux
virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * kernel_path, 
					 const char * initrd_path, 
					 const char * cmdline, 
					 unsigned long memory, 
					 unsigned int flags)

 
Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged access to the hypervisor.
 conn: pointer to the hypervisor connection
kernel_path: the file path to the kernel image
initrd_path: an optional file path to an initrd
cmdline: optional command line parameters for the kernel
memory: the memory size in kilobytes
flags: an optional set of virDomainFlags
Returns: a new domain object or NULL in case of failure
Function: virDomainDestroy
int	virDomainDestroy		(virDomainPtr domain)

@@ -134,12 +124,12 @@ The content of this structure is not made public by the API.
 
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
Function: 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
Function: virDomainRestore
int	virDomainRestore		(virDomainPtr domain, 
					 const char * from)

+conn: pointer to the hypervisor connection
name: name for the domain
Returns: a new domain object or NULL in case of failure
Function: virDomainRestore
int	virDomainRestore		(virConnectPtr conn, 
					 const char * from)

 
This method will restore a domain saved to disk by virDomainSave().
-domain: a domain object
from: path to the
Returns: 0 in case of success and -1 in case of failure.
Function: virDomainResume
int	virDomainResume			(virDomainPtr domain)

+conn: pointer to the hypervisor connection
from: path to the
Returns: 0 in case of success and -1 in case of failure.
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
 domain: a domain object
Returns: 0 in case of success and -1 in case of failure.
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. Use virDomainRestore() to restore a domain after saving.
+
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.
 domain: a domain object
to: path for the output file
Returns: 0 in case of success and -1 in case of failure.
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.
 domain: a domain object or NULL
memory: the memory size in kilobytes
Returns: 0 in case of success and -1 in case of failure.
Function: virDomainShutdown
int	virDomainShutdown		(virDomainPtr domain)

@@ -148,4 +138,4 @@ The content of this structure is not made public by the API.
 
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.
 domain: a domain object
Returns: 0 in case of success and -1 in case of failure.
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.
-libVer: return value for the library version (OUT)
type: hypervisor type
typeVer: return value for the version of the hypervisor (OUT)
Returns: -1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.
Daniel Veillard
libVer
type
typeVer
Returns

`libVer`:	return value for the library version (OUT)
`type`:	hypervisor type
`typeVer`:	return value for the version of the hypervisor (OUT)
`Returns`:	-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.

Libvir the virtualization API

API Alphabetic Index A-f for libvir

API menu

API Indexes

related links

API Alphabetic Index A-f for libvir

A-f g-r s-z

Letter A:

Letter C:

Letter D:

Letter b:

Letter c:

Letter d:

Letter e:

A-f g-r s-z -

Libvir the virtualization API

API Alphabetic Index g-r for libvir

API menu

API Indexes

related links

API Alphabetic Index g-r for libvir

A-f g-r s-z

Letter g:

Letter l:

Letter m:

Letter r:

A-f g-r s-z -

Libvir the virtualization API

API Alphabetic Index s-z for libvir

API menu

API Indexes

related links

API Alphabetic Index s-z for libvir

A-f g-r s-z

Letter s:

Letter x:

Letter y:

A-f g-r s-z -

Libvir the virtualization API

List of constructors for libvir

Type unsigned int:

API menu

API Indexes

related links

List of constructors for libvir

Type unsigned int:

Type unsigned long:

Type virConnectPtr:

Type virDomainPtr:

Libvir the virtualization API

List of Symbols per Module for libvir

Module libvir:

API menu

API Indexes

related links

List of Symbols per Module for libvir

Module libvir:

Libvir the virtualization API

List of function manipulating types in libvir

Type int *:

API menu

API Indexes

related links

List of function manipulating types in libvir

Type int *:

Type unsigned int:

Type unsigned long:

Type virDomainInfoPtr:

Type virDomainPtr:

Libvir the virtualization API

Alphabetic List of Symbols in libvir

Letter L:

API menu

API Indexes

related links

Alphabetic List of Symbols in libvir

Letter L:

Letter V:

Libvir the virtualization API

FAQ