From 08ecf61b35b4cb44e430ae043231c6c45787a66d Mon Sep 17 00:00:00 2001
From: Daniel Veillard Yes. The LGPL allows you to embed libvirt into a proprietary
application. It would be graceful to send-back bug fixes and improvements
as patches for possible incorporation in the main development tree. It
- will decrease your maintainance costs anyway if you do so.
The original distribution comes from ftp://libvirt.org/libvirt/.
diff --git a/docs/architecture.html b/docs/architecture.html index 89df869aea..eb587cc13b 100644 --- a/docs/architecture.html +++ b/docs/architecture.html @@ -40,9 +40,9 @@ domain, by specifying the architecture and machine type targetted.The cod
qemud/
directory.
As the previous section explains, libvirt can communicate using different channels with the current hypervisor, and should also be able to use different kind of hypervisor. To simplify the internal design, code, ease -maintainance and simplify the support of other virtualization engine the +maintenance and simplify the support of other virtualization engine the internals have been structured as one core component, the libvirt.c module -acting as a front-end for the library API and a set of hypvisor drivers +acting as a front-end for the library API and a set of hypervisor drivers defining a common set of routines. That way the Xen Daemon accces, the Xen Store one, the Hypervisor hypercall are all isolated in separate C modules implementing at least a subset of the common operations defined by the diff --git a/docs/auth.html b/docs/auth.html index 261a02b24e..e70a805536 100644 --- a/docs/auth.html +++ b/docs/auth.html @@ -11,11 +11,11 @@ of applications using libvirt.
-The libvirt daemon allows the adminstrator to choose the authentication
-mechanisms used for client connections on each network socket independantly.
+The libvirt daemon allows the administrator to choose the authentication
+mechanisms used for client connections on each network socket independently.
This is primarily controlled via the libvirt daemon master config file in
-The default policy can be overriden by the adminstrator using the PolicyKit
+The default policy can be overriden by the administrator using the PolicyKit
master configuration file in
Some operating systems do not install the SASL kerberos plugin by default. It
-may be neccessary to install a sub-package such as
-Next is is neccessary for the adminsitrator of the Kerberos realm to issue a principle
+Next is is necessary for the adminsitrator of the Kerberos realm to issue a principle
for the libvirt server. There needs to be one principle per host running the libvirt
daemon. The principle should be named 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. Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection. This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback 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. 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. 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. Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires riviledged access to the hypervisor. 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 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 Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor. Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor. Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access 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. 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 privileged access to the hypervisor. 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. 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 privileged access to the hypervisor. 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. 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 privileged access to the hypervisor. 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. 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 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. 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 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 Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted Provides the connection pointer associated with a storage pool. 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 pool object together. Get volatile information about the storage pool such as free space / usage summary Provides the connection pointer associated with a storage volume. 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 volume object together. Fetches volatile information about the storage volume such as its current allocation Fetch the storage volume key. This is globally unique, so the same volume will hve the same key no matter what host it is accessed from Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from 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. 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. Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection. list the defined domains, stores the pointers to the names in @names This function should be called first to get a connection to the Hypervisor and xen store This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback 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. launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools. 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. 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. define a domain, but does not start it 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 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 a virtual device attachment to backend. 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. Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor. Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor. 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. This method will restore a domain saved to disk by virDomainSave(). Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access 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. Configure the domain to be automatically started when the host machine boots. 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. 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 privileged access to the hypervisor. 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. 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 privileged access to the hypervisor. Change the scheduler parameters 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. 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 privileged access to the hypervisor. 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 ? 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. 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 privileged access. undefine a domain but does not stop it if it is running Define a network, but does not create it 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 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 Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter. Provides the connection pointer associated with a storage pool. 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 pool object together. Get volatile information about the storage pool such as free space / usage summary Fetch the locally unique name of the storage pool Provides the connection pointer associated with a storage volume. 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 volume object together. Fetches volatile information about the storage volume such as its current allocation Fetch the storage volume key. This is globally unique, so the same volume will hve the same key no matter what host it is accessed from Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from Fetch the storage volume name. This is unique within the scope of a pool/etc/libvirt/libvirtd.conf
. Each of the libvirt sockets can
-have its authentication mechanism configured independantly. There is
+have its authentication mechanism configured independently. There is
currently a choice of none
, polkit
, and sasl
.
The SASL scheme can be further configured to choose between a large
number of different mechanisms.
@@ -44,7 +44,7 @@ session to authenticate using the user's password. This is akin to sudo
/etc/PolicyKit/PolicyKit.conf
. The
PolicyKit.conf(5)
manual page provides details on the syntax
available. The two libvirt daemon actions available are named org.libvirt.unix.monitor
@@ -100,7 +100,7 @@ and/or TLS sockets, Kerberos will also be used for them. Like DIGEST-MD5, the Ke
mechanism provides data encryption of the session.
cyrus-sasl-gssapi
.
+may be necessary to install a sub-package such as cyrus-sasl-gssapi
.
To check whether the Kerberos plugin is installed run the pluginviewer
program and verify that gssapi
is listed,eg:
@@ -111,7 +111,7 @@ Plugin "gssapiv2" [loaded], API version: 4
security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH
features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
libvirt/full.hostname@KERBEROS.REALM
.
This is typically done by running the kadmin.local
command on the Kerberos
diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html
index 62d027f967..cf6314ad14 100644
--- a/docs/devhelp/libvirt-libvirt.html
+++ b/docs/devhelp/libvirt-libvirt.html
@@ -338,7 +338,7 @@ The content of this structure is not made public by the API.
long long rd_req : number of read requests
long long rd_bytes : number of read bytes
long long wr_req : number of write requests
- long long wr_bytes : numbber of written bytes
+ long long wr_bytes : number of written bytes
long long errs : In Xen this returns the mysterious 'oo_req'.
} virDomainBlockStatsStruct;
conn: pointer to a hypervisor connection Returns: the URI string which must be freed by the caller, or NULL if there was an error.
virConnectGetVersion ()
int virConnectGetVersion (virConnectPtr conn,
unsigned long * hvVer)
-conn: pointer to the hypervisor connection hvVer: return value for the version of the running hypervisor (OUT) Returns: -1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release
virConnectListDefinedDomains ()
int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames)
@@ -652,11 +652,11 @@ The content of this structure is not made public by the API.
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
virConnectOpenAuth ()
virConnectPtr virConnectOpenAuth (const char * name,
virConnectAuthPtr auth,
int flags)
-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)
-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)
@@ -676,7 +676,7 @@ The content of this structure is not made public by the API.
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)
-conn: pointer to the hypervisor connection xmlDesc: 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)
@@ -684,7 +684,7 @@ The content of this structure is not made public by the API.
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)
-domain: a domain object Returns: 0 in case of success and -1 in case of failure.
virDomainDetachDevice ()
int virDomainDetachDevice (virDomainPtr domain,
const char * xml)
@@ -776,7 +776,7 @@ The content of this structure is not made public by the API.
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)
-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)
@@ -788,7 +788,7 @@ The content of this structure is not made public by the API.
conn: pointer to the hypervisor connection from: path to the Returns: 0 in case of success and -1 in case of failure.
virDomainResume ()
int virDomainResume (virDomainPtr domain)
-domain: a domain object Returns: 0 in case of success and -1 in case of failure.
virDomainSave ()
int virDomainSave (virDomainPtr domain,
const char * to)
@@ -800,11 +800,11 @@ The content of this structure is not made public by the API.
domain: a domain object autostart: whether the domain should be automatically started 0 or 1 Returns: -1 in case of error, 0 in case of success
virDomainSetMaxMemory ()
int virDomainSetMaxMemory (virDomainPtr domain,
unsigned long memory)
-domain: a domain object or NULL memory: the memory size in kilobytes Returns: 0 in case of success and -1 in case of failure.
virDomainSetMemory ()
int virDomainSetMemory (virDomainPtr domain,
unsigned long memory)
-domain: a domain object or NULL memory: the memory size in kilobytes Returns: 0 in case of success and -1 in case of failure.
virDomainSetSchedulerParameters ()
int virDomainSetSchedulerParameters (virDomainPtr domain,
virSchedParameterPtr params,
int nparams)
@@ -812,7 +812,7 @@ The content of this structure is not made public by the API.
domain: pointer to domain object params: pointer to scheduler parameter objects nparams: number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType) Returns: -1 in case of error, 0 in case of success.
virDomainSetVcpus ()
int virDomainSetVcpus (virDomainPtr domain,
unsigned int nvcpus)
-domain: pointer to domain object, or NULL for Domain0 nvcpus: the new number of virtual CPUs for this domain Returns: 0 in case of success, -1 in case of failure.
virDomainShutdown ()
int virDomainShutdown (virDomainPtr domain)
@@ -820,7 +820,7 @@ The content of this structure is not made public by the API.
domain: a domain object Returns: 0 in case of success and -1 in case of failure.
virDomainSuspend ()
int virDomainSuspend (virDomainPtr domain)
-domain: a domain object Returns: 0 in case of success and -1 in case of failure.
virDomainUndefine ()
int virDomainUndefine (virDomainPtr domain)
@@ -848,7 +848,7 @@ The content of this structure is not made public by the API.
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)
-network: a network object Returns: 0 in case of success and -1 in case of failure.
virNetworkFree ()
int virNetworkFree (virNetworkPtr network)
@@ -924,7 +924,7 @@ The content of this structure is not made public by the API.
pool: pointer to storage pool flags: Returns: 0 on success, or -1 if it could not be started
virStoragePoolCreateXML ()
virStoragePoolPtr virStoragePoolCreateXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags)
-conn: pointer to hypervisor connection xmlDesc: XML description for new pool flags: Returns: a virStoragePoolPtr object, or NULL if creation failed
virStoragePoolDefineXML ()
virStoragePoolPtr virStoragePoolDefineXML (virConnectPtr conn,
const char * xml,
unsigned int flags)
@@ -949,7 +949,7 @@ The content of this structure is not made public by the API.
virStoragePoolGetConnect ()
virConnectPtr virStoragePoolGetConnect (virStoragePoolPtr pool)
pool: pointer to a poool Returns: the virConnectPtr or NULL in case of failure. pool: pointer to a pool Returns: the virConnectPtr or NULL in case of failure.
virStoragePoolGetInfo ()
int virStoragePoolGetInfo (virStoragePoolPtr pool,
virStoragePoolInfoPtr info)
virStorageVolGetConnect ()
virConnectPtr virStorageVolGetConnect (virStorageVolPtr vol)
vol: pointer to a poool Returns: the virConnectPtr or NULL in case of failure. vol: pointer to a pool Returns: the virConnectPtr or NULL in case of failure.
virStorageVolGetInfo ()
int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info)
vol: pointer to storage volume info: pointer at which to store info Returns: 0 on success, or -1 on failure
virStorageVolGetKey ()
const char * virStorageVolGetKey (virStorageVolPtr vol)
-vol: pointer to storage volume Returns: the volume key, or NULL on error
virStorageVolGetName ()
const char * virStorageVolGetName (virStorageVolPtr vol)
diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html
index 43aafbfcfb..a77f843ed0 100644
--- a/docs/html/libvirt-libvirt.html
+++ b/docs/html/libvirt-libvirt.html
@@ -222,7 +222,7 @@ The content of this structure is not made public by the API.
long long rd_req : number of read requests
long long rd_bytes : number of read bytes
long long wr_req : number of write requests
- long long wr_bytes : numbber of written bytes
+ long long wr_bytes : number of written bytes
long long errs : In Xen this returns the mysterious 'oo_
}Enum virDomainCreateFlags
Enum virDomainCreateFlags {
VIR_DOMAIN_NONE = 0
@@ -358,7 +358,7 @@ int virConnectAuthCallbackPtr (
conn: pointer to the hypervisor connection Returns: NULL in case of error, a static zero terminated string otherwise. See also: http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html Function: virConnectGetURI
char * virConnectGetURI (virConnectPtr conn)
conn: pointer to a hypervisor connection Returns: the URI string which must be freed by the caller, or NULL if there was an error. Function: virConnectGetVersion
int virConnectGetVersion (virConnectPtr conn,
unsigned long * hvVer)
-conn: pointer to the hypervisor connection hvVer: return value for the version of the running hypervisor (OUT) Returns: -1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release Function: virConnectListDefinedDomains
int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames)
conn: pointer to the hypervisor connection names: pointer to an array to store the names maxnames: size of the array Returns: the number of names provided in the array or -1 in case of error Function: virConnectListDefinedNetworks
int virConnectListDefinedNetworks (virConnectPtr conn,
char ** const names,
int maxnames)
@@ -386,7 +386,7 @@ int virConnectAuthCallbackPtr (conn: pointer to hypervisor connection Returns: the number of pools found, or -1 on error Function: virConnectOpen
virConnectPtr virConnectOpen (const char * name)
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 Function: virConnectOpenAuth
virConnectPtr virConnectOpenAuth (const char * name,
virConnectAuthPtr auth,
int flags)
-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 Function: virConnectOpenReadOnly
virConnectPtr virConnectOpenReadOnly (const char * name)
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 Function: virDomainAttachDevice
int virDomainAttachDevice (virDomainPtr domain,
const char * xml)
@@ -398,11 +398,11 @@ int virConnectAuthCallbackPtr (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. Function: virDomainCreate
int virDomainCreate (virDomainPtr domain)
domain: pointer to a defined domain Returns: 0 in case of success, -1 in case of error Function: virDomainCreateLinux
virDomainPtr virDomainCreateLinux (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags)
-conn: pointer to the hypervisor connection xmlDesc: an XML description of the domain flags: an optional set of virDomainFlags Returns: a new domain object or NULL in case of failure Function: virDomainDefineXML
virDomainPtr virDomainDefineXML (virConnectPtr conn,
const char * xml)
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 Function: virDomainDestroy
int virDomainDestroy (virDomainPtr domain)
-domain: a domain object Returns: 0 in case of success and -1 in case of failure. Function: virDomainDetachDevice
int virDomainDetachDevice (virDomainPtr domain,
const char * xml)
domain: pointer to domain object xml: pointer to XML description of one device Returns: 0 in case of success, -1 in case of failure. Function: virDomainFree
int virDomainFree (virDomainPtr domain)
@@ -448,29 +448,29 @@ int virConnectAuthCallbackPtr (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. Function: virDomainMigrate
virDomainPtr virDomainMigrate (virDomainPtr domain,
virConnectPtr dconn,
unsigned long flags,
const char * dname,
const char * uri,
unsigned long bandwidth)
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). Function: virDomainPinVcpu
int virDomainPinVcpu (virDomainPtr domain,
unsigned int vcpu,
unsigned char * cpumap,
int maplen)
-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. Function: virDomainReboot
int virDomainReboot (virDomainPtr domain,
unsigned int flags)
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. Function: virDomainRestore
int virDomainRestore (virConnectPtr conn,
const char * from)
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)
-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)
domain: a domain object to: path for the output file Returns: 0 in case of success and -1 in case of failure. Function: virDomainSetAutostart
int virDomainSetAutostart (virDomainPtr domain,
int autostart)
domain: a domain object autostart: whether the domain should be automatically started 0 or 1 Returns: -1 in case of error, 0 in case of success Function: virDomainSetMaxMemory
int virDomainSetMaxMemory (virDomainPtr domain,
unsigned long memory)
-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: virDomainSetMemory
int virDomainSetMemory (virDomainPtr domain,
unsigned long memory)
-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: virDomainSetSchedulerParameters
int virDomainSetSchedulerParameters (virDomainPtr domain,
virSchedParameterPtr params,
int nparams)
domain: pointer to domain object params: pointer to scheduler parameter objects nparams: number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType) Returns: -1 in case of error, 0 in case of success. Function: virDomainSetVcpus
int virDomainSetVcpus (virDomainPtr domain,
unsigned int nvcpus)
-domain: pointer to domain object, or NULL for Domain0 nvcpus: the new number of virtual CPUs for this domain Returns: 0 in case of success, -1 in case of failure. Function: virDomainShutdown
int virDomainShutdown (virDomainPtr domain)
domain: a domain object Returns: 0 in case of success and -1 in case of failure. Function: virDomainSuspend
int virDomainSuspend (virDomainPtr domain)
-domain: a domain object Returns: 0 in case of success and -1 in case of failure. Function: virDomainUndefine
int virDomainUndefine (virDomainPtr domain)
domain: pointer to a defined domain Returns: 0 in case of success, -1 in case of error Function: virGetVersion
int virGetVersion (unsigned long * libVer,
const char * type,
unsigned long * typeVer)
@@ -484,7 +484,7 @@ int virConnectAuthCallbackPtr (conn: pointer to the hypervisor connection xmlDesc: an XML description of the network Returns: a new network object or NULL in case of failure Function: virNetworkDefineXML
virNetworkPtr virNetworkDefineXML (virConnectPtr conn,
const char * xml)
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 Function: virNetworkDestroy
int virNetworkDestroy (virNetworkPtr network)
-network: a network object Returns: 0 in case of success and -1 in case of failure. Function: virNetworkFree
int virNetworkFree (virNetworkPtr network)
network: a network object Returns: 0 in case of success and -1 in case of failure. Function: virNetworkGetAutostart
int virNetworkGetAutostart (virNetworkPtr network,
int * autostart)
@@ -535,7 +535,7 @@ int virConnectAuthCallbackPtr (pool: pointer to storage pool autostart: location in which to store autostart flag Returns: 0 on success, -1 on failure Function: virStoragePoolGetConnect
virConnectPtr virStoragePoolGetConnect (virStoragePoolPtr pool)
pool: pointer to a poool Returns: the virConnectPtr or NULL in case of failure. Function: virStoragePoolGetInfo
int virStoragePoolGetInfo (virStoragePoolPtr pool,
virStoragePoolInfoPtr info)
+pool: pointer to a pool Returns: the virConnectPtr or NULL in case of failure. Function: virStoragePoolGetInfo
int virStoragePoolGetInfo (virStoragePoolPtr pool,
virStoragePoolInfoPtr info)
pool: pointer to storage pool info: pointer at which to store info Returns: 0 on success, or -1 on failure. Function: virStoragePoolGetName
const char * virStoragePoolGetName (virStoragePoolPtr pool)
vol: pointer to storage volume Returns: 0 on success, or -1 on error Function: virStorageVolGetConnect
virConnectPtr virStorageVolGetConnect (virStorageVolPtr vol)
vol: pointer to a poool Returns: the virConnectPtr or NULL in case of failure. Function: virStorageVolGetInfo
int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info)
+vol: pointer to a pool Returns: the virConnectPtr or NULL in case of failure. Function: virStorageVolGetInfo
int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info)
vol: pointer to storage volume info: pointer at which to store info Returns: 0 on success, or -1 on failure Function: virStorageVolGetKey
const char * virStorageVolGetKey (virStorageVolPtr vol)
-vol: pointer to storage volume Returns: the volume key, or NULL on error Function: virStorageVolGetName
const char * virStorageVolGetName (virStorageVolPtr vol)
vol: pointer to storage volume Returns: the volume name, or NULL on error Function: virStorageVolGetPath
char * virStorageVolGetPath (virStorageVolPtr vol)
diff --git a/docs/libvir.html b/docs/libvir.html
index ac29255477..79559f6420 100644
--- a/docs/libvir.html
+++ b/docs/libvir.html
@@ -521,7 +521,7 @@ and check the ChangeLog to gauge progress.
As the previous section explains, libvirt can communicate using different channels with the current hypervisor, and should also be able to use different kind of hypervisor. To simplify the internal design, code, ease -maintainance and simplify the support of other virtualization engine the +maintenance and simplify the support of other virtualization engine the internals have been structured as one core component, the libvirt.c module -acting as a front-end for the library API and a set of hypvisor drivers +acting as a front-end for the library API and a set of hypervisor drivers defining a common set of routines. That way the Xen Daemon accces, the Xen Store one, the Hypervisor hypercall are all isolated in separate C modules implementing at least a subset of the common operations defined by the @@ -1557,7 +1557,7 @@ containing the same field as a virError in C, but cast to Python.
Yes. The LGPL allows you to embed libvirt into a proprietary application. It would be graceful to send-back bug fixes and improvements as patches for possible incorporation in the main development tree. It - will decrease your maintainance costs anyway if you do so.
+ will decrease your maintenance costs anyway if you do so.
-The libvirt daemon allows the adminstrator to choose the authentication
-mechanisms used for client connections on each network socket independantly.
+The libvirt daemon allows the administrator to choose the authentication
+mechanisms used for client connections on each network socket independently.
This is primarily controlled via the libvirt daemon master config file in
/etc/libvirt/libvirtd.conf
. Each of the libvirt sockets can
-have its authentication mechanism configured independantly. There is
+have its authentication mechanism configured independently. There is
currently a choice of none
, polkit
, and sasl
.
The SASL scheme can be further configured to choose between a large
number of different mechanisms.
@@ -2957,7 +2957,7 @@ Default policy will still allow any application to connect to the RO socket.
-The default policy can be overriden by the adminstrator using the PolicyKit
+The default policy can be overriden by the administrator using the PolicyKit
master configuration file in /etc/PolicyKit/PolicyKit.conf
. The
PolicyKit.conf(5)
manual page provides details on the syntax
available. The two libvirt daemon actions available are named org.libvirt.unix.monitor
@@ -3040,7 +3040,7 @@ mechanism provides data encryption of the session.
Some operating systems do not install the SASL kerberos plugin by default. It
-may be neccessary to install a sub-package such as cyrus-sasl-gssapi
.
+may be necessary to install a sub-package such as cyrus-sasl-gssapi
.
To check whether the Kerberos plugin is installed run the pluginviewer
program and verify that gssapi
is listed,eg:
-Next is is neccessary for the adminsitrator of the Kerberos realm to issue a principle
+Next is is necessary for the adminsitrator of the Kerberos realm to issue a principle
for the libvirt server. There needs to be one principle per host running the libvirt
daemon. The principle should be named libvirt/full.hostname@KERBEROS.REALM
.
This is typically done by running the kadmin.local
command on the Kerberos
diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index fb2fa7ddf7..d19025e55a 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -527,7 +527,7 @@