Index: virsh.1 =================================================================== RCS file: /data/cvs/libvirt/virsh.1,v retrieving revision 1.12 diff -u -r1.12 virsh.1 --- virsh.1 14 Mar 2008 11:08:03 -0000 1.12 +++ virsh.1 17 Mar 2008 02:20:55 -0000 @@ -219,7 +219,7 @@ this is used to connect to the local Xen hypervisor, this is the default .IP "qemu:///system" 4 .IX Item "qemu:///system" -allow to connect locally as root to the daemon supervizing QEmu and \s-1KVM\s0 domains +allow to connect locally as root to the daemon supervising QEmu and \s-1KVM\s0 domains .IP "qemu:///session" 4 .IX Item "qemu:///session" allow to connect locally as a normal user to the his own set of QEmu and \s-1KVM\s0 domains Index: docs/FAQ.html =================================================================== RCS file: /data/cvs/libvirt/docs/FAQ.html,v retrieving revision 1.41 diff -u -r1.41 FAQ.html --- docs/FAQ.html 20 Feb 2008 15:58:06 -0000 1.41 +++ docs/FAQ.html 17 Mar 2008 02:20:55 -0000 @@ -14,7 +14,7 @@
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 original distribution comes from ftp://libvirt.org/libvirt/.
@@ -34,8 +34,8 @@make rpm
Large parts of the API may only be accessible with root priviledges, - however the read only access to the xenstore data doesnot have to be +
Large parts of the API may only be accessible with root privileges, + however the read only access to the xenstore data doesn't have to be forbidden to user, at least for monitoring purposes. If "virsh dominfo" fails to run as an user, change the mode of the xenstore read-only socket with:
Index: docs/architecture.html =================================================================== RCS file: /data/cvs/libvirt/docs/architecture.html,v retrieving revision 1.42 diff -u -r1.42 architecture.html --- docs/architecture.html 14 Mar 2008 11:08:03 -0000 1.42 +++ docs/architecture.html 17 Mar 2008 02:20:55 -0000 @@ -14,7 +14,7 @@ drivers, kernels and daemons communicate though a shared system bus implemented in the hypervisor. The figure below tries to provide a view of this environment:The library can be initialized in 2 ways depending on the level of -priviledge of the embedding program. If it runs with root access, +privilege of the embedding program. If it runs with root access, virConnectOpen() can be used, it will use three different ways to connect to the Xen infrastructure:
If it runs without root access virConnectOpenReadOnly() should be used to +privilege access).
If it runs without root access virConnectOpenReadOnly() should be used to connect to initialize the library. It will then fork a libvirt_proxy program running as root and providing read_only access to the API, this is then only useful for reporting and monitoring.
The model for QEmu and KVM is completely similar, basically KVM is based @@ -36,14 +36,14 @@ protocol to the library, and connects to the console of the QEmu process in order to control and report on its status. Libvirt tries to expose all the emulations models of QEmu, the selection is done when creating the new -domain, by specifying the architecture and machine type targetted.
The code controlling the QEmu process is available in the +domain, by specifying the architecture and machine type targeted.
The code controlling the QEmu process is available in the
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 -defining a common set of routines. That way the Xen Daemon accces, the Xen +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 access, 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 drivers present in driver.h:
When connecting to libvirt, some connections may require client authentication before allowing use of the APIs. The set of possible -authentication mechanisms is administrator controlled, independant +authentication mechanisms is administrator controlled, independent 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
/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 @@
auth, but does not require that the client application ultimately run as root.
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 overridden 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
@@ -100,7 +100,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:
@@ -111,7 +111,7 @@ security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
-Next is is neccessary for the adminsitrator of the Kerberos realm to issue a principle
+Next is is necessary for the administrator 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
Index: docs/libvir.html
===================================================================
RCS file: /data/cvs/libvirt/docs/libvir.html,v
retrieving revision 1.111
diff -u -r1.111 libvir.html
--- docs/libvir.html 14 Mar 2008 11:08:03 -0000 1.111
+++ docs/libvir.html 17 Mar 2008 02:20:57 -0000
@@ -521,7 +521,7 @@
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 @@
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. @@ -2912,11 +2912,11 @@
-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 @@
-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 @@
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
Index: docs/libvirt-api.xml
===================================================================
RCS file: /data/cvs/libvirt/docs/libvirt-api.xml,v
retrieving revision 1.45
diff -u -r1.45 libvirt-api.xml
--- docs/libvirt-api.xml 14 Mar 2008 11:08:03 -0000 1.45
+++ docs/libvirt-api.xml 17 Mar 2008 02:20:57 -0000
@@ -527,7 +527,7 @@
0.1.2: Jul 3 2006
0.1.1: Jun 21 2006
conn: pointer to a hypervisor connection Returns: the URI string which must be freed by the caller, or NULL if there was an error.
int virConnectGetVersion (virConnectPtr conn,
unsigned long * hvVer)
-
Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection.
+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.
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 |
int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames)
@@ -652,7 +652,7 @@
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
virConnectPtr virConnectOpenAuth (const char * name,
virConnectAuthPtr auth,
int flags)
-
This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback
+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 |
virConnectPtr virConnectOpenReadOnly (const char * name)
@@ -676,7 +676,7 @@
domain: pointer to a defined domain Returns: 0 in case of success, -1 in case of error
virDomainPtr virDomainCreateLinux (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags)
-
Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires priviledged access to the hypervisor.
+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: | an XML description of the domain |
flags: | an optional set of virDomainFlags |
Returns: | a new domain object or NULL in case of failure |
virDomainPtr virDomainDefineXML (virConnectPtr conn,
const char * xml)
@@ -684,7 +684,7 @@
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
int virDomainDestroy (virDomainPtr domain)
-
Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access
+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. |
int virDomainDetachDevice (virDomainPtr domain,
const char * xml)
@@ -776,7 +776,7 @@
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).
int virDomainPinVcpu (virDomainPtr domain,
unsigned int vcpu,
unsigned char * cpumap,
int maplen)
-
Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor.
+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. |
int virDomainReboot (virDomainPtr domain,
unsigned int flags)
@@ -788,7 +788,7 @@
conn: pointer to the hypervisor connection from: path to the Returns: 0 in case of success and -1 in case of failure.
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
+Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access
domain: | a domain object |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSave (virDomainPtr domain,
const char * to)
@@ -800,11 +800,11 @@
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
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.
+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.
domain: | a domain object or NULL |
memory: | the memory size in kilobytes |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSetMemory (virDomainPtr domain,
unsigned long memory)
-
Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires priviledged access to the hypervisor.
+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.
domain: | a domain object or NULL |
memory: | the memory size in kilobytes |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSetSchedulerParameters (virDomainPtr domain,
virSchedParameterPtr params,
int nparams)
@@ -812,7 +812,7 @@
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.
int virDomainSetVcpus (virDomainPtr domain,
unsigned int nvcpus)
-
Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires priviledged access to the hypervisor.
+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.
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. |
int virDomainShutdown (virDomainPtr domain)
@@ -820,7 +820,7 @@
domain: a domain object Returns: 0 in case of success and -1 in case of failure.
int virDomainSuspend (virDomainPtr domain)
-
Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires priviledged access.
+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.
domain: | a domain object |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainUndefine (virDomainPtr domain)
@@ -848,7 +848,7 @@
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
int virNetworkDestroy (virNetworkPtr network)
-
Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access
+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. |
int virNetworkFree (virNetworkPtr network)
@@ -949,7 +949,7 @@
+virStoragePoolGetConnect ()
virConnectPtr virStoragePoolGetConnect (virStoragePoolPtr pool)
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.
-
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.
int virStoragePoolGetInfo (virStoragePoolPtr pool,
virStoragePoolInfoPtr info)
Get volatile information about the storage pool such as free space / usage summary
@@ -1021,14 +1021,14 @@virConnectPtr virStorageVolGetConnect (virStorageVolPtr vol)
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.
-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. |
int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info)
Fetches volatile information about the storage volume such as its current allocation
vol: | pointer to storage volume |
info: | pointer at which to store info |
Returns: | 0 on success, or -1 on failure |
const char * virStorageVolGetKey (virStorageVolPtr vol)
-
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
vol: | pointer to storage volume |
Returns: | the volume key, or NULL on error |
const char * virStorageVolGetName (virStorageVolPtr vol)
Index: docs/html/libvirt-libvirt.html =================================================================== RCS file: /data/cvs/libvirt/docs/html/libvirt-libvirt.html,v retrieving revision 1.36 diff -u -r1.36 libvirt-libvirt.html --- docs/html/libvirt-libvirt.html 14 Mar 2008 11:08:03 -0000 1.36 +++ docs/html/libvirt-libvirt.html 17 Mar 2008 02:21:08 -0000 @@ -222,7 +222,7 @@ 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 { VIR_DOMAIN_NONE = 0 @@ -358,7 +358,7 @@
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)
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.
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)
-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.
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 |
int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames)
list the defined domains, stores the pointers to the names in @names
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 |
int virConnectListDefinedNetworks (virConnectPtr conn,
char ** const names,
int maxnames)
@@ -386,7 +386,7 @@
conn: pointer to hypervisor connection Returns: the number of pools found, or -1 on 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: 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)
-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
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 |
virConnectPtr virConnectOpenReadOnly (const char * name)
This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.
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 |
int virDomainAttachDevice (virDomainPtr domain,
const char * xml)
@@ -398,11 +398,11 @@
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)
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 Function: virDomainCreateLinux
virDomainPtr virDomainCreateLinux (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags)
-Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires priviledged access to the hypervisor.
+
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: | an XML description of the domain |
flags: | an optional set of virDomainFlags |
Returns: | a new domain object or NULL in case of failure |
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 |
int virDomainDestroy (virDomainPtr domain)
-
Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access
+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. |
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. |
int virDomainFree (virDomainPtr domain)
@@ -448,29 +448,29 @@
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)
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). Function: virDomainPinVcpu
int virDomainPinVcpu (virDomainPtr domain,
unsigned int vcpu,
unsigned char * cpumap,
int maplen)
-Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor.
+
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. |
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. |
int virDomainRestore (virConnectPtr conn,
const char * from)
This method will restore a domain saved to disk by virDomainSave().
conn: | pointer to the hypervisor connection |
from: | path to the |
Returns: | 0 in case of success and -1 in case of failure. |
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
+Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access
domain: | a domain object |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSave (virDomainPtr domain,
const char * to)
This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.
domain: | a domain object |
to: | path for the output file |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSetAutostart (virDomainPtr domain,
int autostart)
Configure the domain to be automatically started when the host machine boots.
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 |
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.
+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.
domain: | a domain object or NULL |
memory: | the memory size in kilobytes |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSetMemory (virDomainPtr domain,
unsigned long memory)
-
Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires priviledged access to the hypervisor.
+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.
domain: | a domain object or NULL |
memory: | the memory size in kilobytes |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSetSchedulerParameters (virDomainPtr domain,
virSchedParameterPtr params,
int nparams)
Change the scheduler parameters
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. |
int virDomainSetVcpus (virDomainPtr domain,
unsigned int nvcpus)
-
Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires priviledged access to the hypervisor.
+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.
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. |
int virDomainShutdown (virDomainPtr domain)
Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?
domain: | a domain object |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainSuspend (virDomainPtr domain)
-
Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires priviledged access.
+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.
domain: | a domain object |
Returns: | 0 in case of success and -1 in case of failure. |
int virDomainUndefine (virDomainPtr domain)
undefine a domain but does not stop it if it is running
domain: | pointer to a defined domain |
Returns: | 0 in case of success, -1 in case of error |
int virGetVersion (unsigned long * libVer,
const char * type,
unsigned long * typeVer)
@@ -484,7 +484,7 @@
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)
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 Function: virNetworkDestroy
int virNetworkDestroy (virNetworkPtr network)
-Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access
+
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. |
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. |
int virNetworkGetAutostart (virNetworkPtr network,
int * autostart)
@@ -535,7 +535,7 @@
Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time
pool: | pointer to storage pool |
autostart: | location in which to store autostart flag |
Returns: | 0 on success, -1 on failure |
virConnectPtr virStoragePoolGetConnect (virStoragePoolPtr pool)
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.
-pool: | pointer to a poool |
Returns: | the virConnectPtr or NULL in case of failure. |
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)
Get volatile information about the storage pool such as free space / usage summary
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)
Fetch the locally unique name of the storage pool
@@ -571,10 +571,10 @@
Release the storage volume handle. The underlying storage volume contains to exist
vol: | pointer to storage volume |
Returns: | 0 on success, or -1 on error |
virConnectPtr virStorageVolGetConnect (virStorageVolPtr vol)
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.
-vol: | pointer to a poool |
Returns: | the virConnectPtr or NULL in case of failure. |
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)
Fetches volatile information about the storage volume such as its current allocation
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)
-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
vol: | pointer to storage volume |
Returns: | the volume key, or NULL on error |
const char * virStorageVolGetName (virStorageVolPtr vol)
Fetch the storage volume name. This is unique within the scope of a pool
vol: | pointer to storage volume |
Returns: | the volume name, or NULL on error |
char * virStorageVolGetPath (virStorageVolPtr vol)
Index: include/libvirt/libvirt.h =================================================================== RCS file: /data/cvs/libvirt/include/libvirt/libvirt.h,v retrieving revision 1.69 diff -u -r1.69 libvirt.h --- include/libvirt/libvirt.h 14 Mar 2008 11:08:03 -0000 1.69 +++ include/libvirt/libvirt.h 17 Mar 2008 02:21:09 -0000 @@ -204,7 +204,7 @@ 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'. */ }; Index: include/libvirt/libvirt.h.in =================================================================== RCS file: /data/cvs/libvirt/include/libvirt/libvirt.h.in,v retrieving revision 1.45 diff -u -r1.45 libvirt.h.in --- include/libvirt/libvirt.h.in 14 Mar 2008 11:08:03 -0000 1.45 +++ include/libvirt/libvirt.h.in 17 Mar 2008 02:21:09 -0000 @@ -204,7 +204,7 @@ 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'. */ }; Index: qemud/mdns.h =================================================================== RCS file: /data/cvs/libvirt/qemud/mdns.h,v retrieving revision 1.3 diff -u -r1.3 mdns.h --- qemud/mdns.h 29 Feb 2008 12:53:11 -0000 1.3 +++ qemud/mdns.h 17 Mar 2008 02:21:09 -0000 @@ -37,9 +37,9 @@ struct libvirtd_mdns *libvirtd_mdns_new(void); /** - * Starts the mdns client, advertizing any groups/entries currently registered + * Starts the mdns client, advertising any groups/entries currently registered * - * @mdns: manager to start advertizing + * @mdns: manager to start advertising * * Starts the mdns client. Services may not be immediately visible, since * it may asynchronously wait for the mdns service to startup @@ -49,15 +49,15 @@ int libvirtd_mdns_start(struct libvirtd_mdns *mdns); /** - * Stops the mdns client, removing any advertizements + * Stops the mdns client, removing any advertisements * - * @mdns: manager to start advertizing + * @mdns: manager to start advertising * */ void libvirtd_mdns_stop(struct libvirtd_mdns *mdns); /** - * Adds a group container for advertizement + * Adds a group container for advertisement * * @mdns manager to attach the group to * @name unique human readable service name @@ -67,7 +67,7 @@ struct libvirtd_mdns_group *libvirtd_mdns_add_group(struct libvirtd_mdns *mdns, const char *name); /** - * Removes a group container from advertizement + * Removes a group container from advertisement * * @mdns amanger to detach group from * @group group to remove Index: src/libvirt.c =================================================================== RCS file: /data/cvs/libvirt/src/libvirt.c,v retrieving revision 1.128 diff -u -r1.128 libvirt.c --- src/libvirt.c 13 Mar 2008 09:27:46 -0000 1.128 +++ src/libvirt.c 17 Mar 2008 02:21:12 -0000 @@ -870,7 +870,7 @@ * @flags: Open flags * * This function should be called first to get a connection to the - * Hypervisor. If neccessary, authentication will be performed fetching + * Hypervisor. If necessary, authentication will be performed fetching * credentials via the callback * * Returns a pointer to the hypervisor connection or NULL in case of error @@ -969,7 +969,7 @@ * @hvVer: return value for the version of the running hypervisor (OUT) * * Get the version level of the Hypervisor running. This may work only with - * hypervisor call, i.e. with priviledged access to the hypervisor, not + * hypervisor call, i.e. with privileged access to the hypervisor, not * with a Read-Only connection. * * Returns -1 in case of error, 0 otherwise. if the version can't be @@ -1188,7 +1188,7 @@ * * 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. + * This function may requires privileged access to the hypervisor. * * Returns a new domain object or NULL in case of failure */ @@ -1372,7 +1372,7 @@ * 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 + * This function may requires privileged access * * Returns 0 in case of success and -1 in case of failure. */ @@ -1432,7 +1432,7 @@ * 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. + * This function may requires privileged access. * * Returns 0 in case of success and -1 in case of failure. */ @@ -1466,7 +1466,7 @@ * * Resume an suspended domain, the process is restarted from the state where * it was frozen by calling virSuspendDomain(). - * This function may requires priviledged access + * This function may requires privileged access * * Returns 0 in case of success and -1 in case of failure. */ @@ -1911,7 +1911,7 @@ * 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. + * This function requires privileged access to the hypervisor. * * Returns 0 in case of success and -1 in case of failure. */ @@ -1954,7 +1954,7 @@ * 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. + * This function may requires privileged access to the hypervisor. * * Returns 0 in case of success and -1 in case of failure. */ @@ -2805,7 +2805,7 @@ * 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. + * This function requires privileged access to the hypervisor. * * Returns 0 in case of success, -1 in case of failure. */ @@ -2856,7 +2856,7 @@ * If maplen > size, failure code is returned. * * Dynamically change the real CPUs which can be allocated to a virtual CPU. - * This function requires priviledged access to the hypervisor. + * This function requires privileged access to the hypervisor. * * Returns 0 in case of success, -1 in case of failure. */ @@ -3486,7 +3486,7 @@ * 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 + * This function may requires privileged access * * Returns 0 in case of success and -1 in case of failure. */ @@ -3753,7 +3753,7 @@ /** * virStoragePoolGetConnect: - * @pool: pointer to a poool + * @pool: pointer to a pool * * Provides the connection pointer associated with a storage pool. The * reference counter on the connection is not increased by this @@ -4638,7 +4638,7 @@ /** * virStorageVolGetConnect: - * @vol: pointer to a poool + * @vol: pointer to a pool * * Provides the connection pointer associated with a storage volume. The * reference counter on the connection is not increased by this @@ -4789,7 +4789,7 @@ * @vol: pointer to storage volume * * Fetch the storage volume key. This is globally - * unique, so the same volume will hve the same + * unique, so the same volume will have the same * key no matter what host it is accessed from * * return the volume key, or NULL on error Index: src/qemu.conf =================================================================== RCS file: /data/cvs/libvirt/src/qemu.conf,v retrieving revision 1.2 diff -u -r1.2 qemu.conf --- src/qemu.conf 5 Feb 2008 19:27:37 -0000 1.2 +++ src/qemu.conf 17 Mar 2008 02:21:12 -0000 @@ -17,7 +17,7 @@ # Examples include vinagre, virt-viewer, virt-manager and vencrypt # itself. UltraVNC, RealVNC, TightVNC do not support this # -# It is neccessary to setup CA and issue a server certificate +# It is necessary to setup CA and issue a server certificate # before enabling this. # # vnc_tls = 1 Index: src/remote_internal.c =================================================================== RCS file: /data/cvs/libvirt/src/remote_internal.c,v retrieving revision 1.61 diff -u -r1.61 remote_internal.c --- src/remote_internal.c 26 Feb 2008 07:05:18 -0000 1.61 +++ src/remote_internal.c 17 Mar 2008 02:21:14 -0000 @@ -4071,7 +4071,7 @@ DEBUG0("Client initialize PolicyKit authentication"); if (auth && auth->cb) { - /* Check if the neccessary credential type for PolicyKit is supported */ + /* Check if the necessary credential type for PolicyKit is supported */ for (i = 0 ; i < auth->ncredtype ; i++) { if (auth->credtype[i] == VIR_CRED_EXTERNAL) allowcb = 1; Index: src/xend_internal.c =================================================================== RCS file: /data/cvs/libvirt/src/xend_internal.c,v retrieving revision 1.173 diff -u -r1.173 xend_internal.c --- src/xend_internal.c 7 Mar 2008 09:23:30 -0000 1.173 +++ src/xend_internal.c 17 Mar 2008 02:21:15 -0000 @@ -3189,7 +3189,7 @@ * * 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. + * This function may requires privileged access to the hypervisor. * * Returns a new domain object or NULL in case of failure */ Index: tests/confdata/libvirtd.conf =================================================================== RCS file: /data/cvs/libvirt/tests/confdata/libvirtd.conf,v retrieving revision 1.1 diff -u -r1.1 libvirtd.conf --- tests/confdata/libvirtd.conf 7 Jan 2008 15:21:33 -0000 1.1 +++ tests/confdata/libvirtd.conf 17 Mar 2008 02:21:15 -0000 @@ -12,7 +12,7 @@ # NB, must pass the --listen flag to the libvirtd process for this to # have any effect. # -# It is neccessary to setup a CA and issue server certificates before +# It is necessary to setup a CA and issue server certificates before # using this capability. # # This is enabled by default, uncomment this to disable it Index: tests/confdata/libvirtd.out =================================================================== RCS file: /data/cvs/libvirt/tests/confdata/libvirtd.out,v retrieving revision 1.1 diff -u -r1.1 libvirtd.out --- tests/confdata/libvirtd.out 7 Jan 2008 15:21:33 -0000 1.1 +++ tests/confdata/libvirtd.out 17 Mar 2008 02:21:15 -0000 @@ -9,7 +9,7 @@ # NB, must pass the --listen flag to the libvirtd process for this to # have any effect. # -# It is neccessary to setup a CA and issue server certificates before +# It is necessary to setup a CA and issue server certificates before # using this capability. # # This is enabled by default, uncomment this to disable it