diff --git a/docs/APIchunk0.html b/docs/APIchunk0.html index 438f7c513b..3eb3fd7af6 100644 --- a/docs/APIchunk0.html +++ b/docs/APIchunk0.html @@ -7,10 +7,12 @@ H1 {font-family: Verdana,Arial,Helvetica} H2 {font-family: Verdana,Arial,Helvetica} H3 {font-family: Verdana,Arial,Helvetica} A:link, A:visited, A:active { text-decoration: underline } -API Alphabetic Index A-g for libvir
Red Hat Logo

Libvir the virtualization API

API Alphabetic Index A-g for libvir

Developer Menu
API Indexes
Related links

A-g -h-t -u-z +API Alphabetic Index A-f for libvir
Red Hat Logo

Libvir the virtualization API

API Alphabetic Index A-f for libvir

Developer Menu
API Indexes
Related links

A-f +g-s +t-z

Letter A:

ABI
_virDomainInfo
+
API
virDomainCreateLinux
+virDomainGetXMLDesc
APIs
virConnectOpenReadOnly

Letter C:

CPU
virDomainSuspend
Collect
virConnectListDomains
@@ -34,13 +36,14 @@ A:link, A:visited, A:active { text-decoration: underline }

Letter L:

Launch
virDomainCreateLinux
Linux
virDomainCreateLinux

Letter M:

Macro
LIBVIR_VERSION_NUMBER
-

Letter N:

NULL
virConnectGetType
+

Letter N:

NOTE:
virDomainGetXMLDesc
+
NULL
virConnectGetType
virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
-virDomainGetInfo
virDomainGetMaxMemory
virDomainGetName
+virDomainGetXMLDesc
virDomainLookupByID
virDomainLookupByName
virDomainSetMaxMemory
@@ -48,7 +51,8 @@ A:link, A:visited, A:active { text-decoration: underline }
Note
virDomainGetInfo

Letter O:

OUT
virConnectGetVersion
virGetVersion
-

Letter P:

Provides
virConnectNumOfDomains
+

Letter P:

Provide
virDomainGetXMLDesc
+
Provides
virConnectNumOfDomains
virGetVersion

Letter R:

Read-Only
virConnectGetVersion
Resume
virDomainResume
@@ -59,13 +63,24 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectGetVersion
virConnectOpen
virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainDestroy
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
Try
virDomainLookupByID
virDomainLookupByName
-

Letter U:

Use
virDomainSuspend
-

Letter X:

Xen
virGetVersion
+

Letter U:

UTF-8
virDomainGetXMLDesc
+
Use
virDomainSuspend
+

Letter X:

XML
virDomainGetXMLDesc
+
Xen
virGetVersion

Letter a:

about
virDomainGetInfo
access
_virDomainInfo
virConnectGetVersion
+virDomainCreateLinux
+virDomainDestroy
+virDomainResume
+virDomainSetMaxMemory
virDomainSuspend
active
virConnectListDomains
virConnectNumOfDomains
@@ -98,6 +113,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Letter b:

back
virDomainDestroy
virGetVersion
based
virDomainLookupByID
+virDomainLookupByName
below
_virDomainInfo
but
virDomainSuspend

Letter c:

call
_virDomainInfo
@@ -106,6 +122,7 @@ A:link, A:visited, A:active { text-decoration: underline }
called
virConnectClose
virConnectOpen
virConnectOpenReadOnly
+
caller
virDomainGetXMLDesc
calling
virDomainResume
can
_virDomainInfo
virConnectGetVersion
@@ -124,6 +141,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetID
virDomainGetInfo
virDomainGetMaxMemory
+virDomainGetXMLDesc
virDomainLookupByID
virDomainLookupByName
virDomainResume
@@ -131,6 +149,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSuspend
virGetVersion
change
virDomainSetMaxMemory
+
changes
virDomainGetXMLDesc
check
_virDomainInfo
clients
_virDomainInfo
closes
virConnectClose
@@ -155,11 +174,14 @@ A:link, A:visited, A:active { text-decoration: underline }

Letter d:

data
virDomainDestroy
virDomainFree
deallocated
virDomainGetName
+
defined
virDomainCreateLinux
+
description
virDomainGetXMLDesc
does
virDomainDestroy
domains
virConnectListDomains
virConnectNumOfDomains
down
virDomainDestroy
-

Letter e:

error
virConnectClose
+

Letter e:

encoded
virDomainGetXMLDesc
+
error
virConnectClose
virConnectGetType
virConnectGetVersion
virConnectListDomains
@@ -169,11 +191,13 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainDestroy
virDomainGetID
virDomainGetMaxMemory
+virDomainGetXMLDesc
virGetVersion
especially
virConnectClose
extracted
_virDomainInfo
virConnectGetVersion
virDomainGetInfo
+
extraction
virDomainGetXMLDesc

Letter f:

failure
virDomainCreateLinux
virDomainDestroy
virDomainFree
@@ -188,6 +212,7 @@ A:link, A:visited, A:active { text-decoration: underline }
find
virDomainLookupByID
first
virConnectOpen
virConnectOpenReadOnly
+
flags
virDomainGetXMLDesc
for
_virDomainInfo
virConnectGetVersion
virDomainCreateLinux
@@ -198,6 +223,7 @@ A:link, A:visited, A:active { text-decoration: underline }
format
virGetVersion
found
virConnectListDomains
virConnectNumOfDomains
+
free
virDomainGetXMLDesc
freed
virDomainDestroy
virDomainFree
from
_virDomainInfo
@@ -208,16 +234,14 @@ A:link, A:visited, A:active { text-decoration: underline }
function
virConnectClose
virConnectOpen
virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainDestroy
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
further
virConnectClose
virDomainSuspend
-

Letter g:

get
virConnectOpen
-virConnectOpenReadOnly
-virDomainGetInfo
-virDomainGetMaxMemory
-
given
virDomainDestroy
-virDomainLookupByName
-
guest
virDomainCreateLinux
-

A-g -h-t -u-z +

A-f +g-s +t-z

Daniel Veillard

diff --git a/docs/APIchunk1.html b/docs/APIchunk1.html index c1e6c17a7f..be05b8d9ec 100644 --- a/docs/APIchunk1.html +++ b/docs/APIchunk1.html @@ -7,10 +7,17 @@ H1 {font-family: Verdana,Arial,Helvetica} H2 {font-family: Verdana,Arial,Helvetica} H3 {font-family: Verdana,Arial,Helvetica} A:link, A:visited, A:active { text-decoration: underline } -API Alphabetic Index h-t for libvir
Red Hat Logo

Libvir the virtualization API

API Alphabetic Index h-t for libvir

Developer Menu
API Indexes
Related links

A-g -h-t -u-z -

Letter h:

have
virGetVersion
+API Alphabetic Index g-s for libvir
Red Hat Logo

Libvir the virtualization API

API Alphabetic Index g-s for libvir

Developer Menu
API Indexes
Related links

A-f +g-s +t-z +

Letter g:

get
virConnectOpen
+virConnectOpenReadOnly
+virDomainGetInfo
+virDomainGetMaxMemory
+
given
virDomainDestroy
+virDomainLookupByName
+
guest
virDomainCreateLinux
+

Letter h:

have
virGetVersion
hypervisor
_virDomainInfo
virConnectClose
virConnectGetType
@@ -24,6 +31,8 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetID
virDomainLookupByID
virDomainLookupByName
+virDomainResume
+virDomainSetMaxMemory
virDomainSuspend
virGetVersion

Letter i:

image
virDomainCreateLinux
@@ -33,9 +42,11 @@ A:link, A:visited, A:active { text-decoration: underline }
initrd
virDomainCreateLinux
instance
virDomainDestroy
virDomainFree
+virDomainGetXMLDesc
int
virDomainGetID
interaction
virConnectClose
its
virDomainGetName
+virDomainLookupByName

Letter k:

kept
virDomainFree
kernel
virDomainCreateLinux
kilobytes
virDomainCreateLinux
@@ -69,6 +80,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectGetVersion
virGetVersion
monitoring
virConnectClose
+
must
virDomainGetXMLDesc

Letter n:

name
virConnectGetType
virDomainGetName
virDomainLookupByName
@@ -83,6 +95,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainDestroy
virDomainFree
virDomainGetName
+virDomainGetXMLDesc
virGetVersion
number
virConnectListDomains
virConnectNumOfDomains
@@ -95,6 +108,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetInfo
virDomainGetMaxMemory
virDomainGetName
+virDomainGetXMLDesc
virDomainLookupByID
virDomainLookupByName
virDomainResume
@@ -132,6 +146,11 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByName
private
_virDomainInfo
priviledged
virConnectGetVersion
+virDomainCreateLinux
+virDomainDestroy
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
process
virDomainResume
virDomainSuspend
protection
_virDomainInfo
@@ -142,6 +161,11 @@ A:link, A:visited, A:active { text-decoration: underline }
read-only
virConnectOpenReadOnly
release
virConnectGetVersion
virGetVersion
+
requires
virDomainCreateLinux
+virDomainDestroy
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
reserved
virDomainGetMaxMemory
virDomainSetMaxMemory
resources
virDomainDestroy
@@ -151,7 +175,8 @@ A:link, A:visited, A:active { text-decoration: underline }
return
virConnectGetVersion
virDomainDestroy
virGetVersion
-
returned
virGetVersion
+
returned
virDomainGetXMLDesc
+virGetVersion
returns
virConnectGetVersion
running
_virDomainInfo
virConnectClose
@@ -164,6 +189,7 @@ A:link, A:visited, A:active { text-decoration: underline }
set
virConnectOpenReadOnly
virDomainCreateLinux
virDomainGetInfo
+virDomainGetXMLDesc
should
virConnectClose
virConnectOpen
virConnectOpenReadOnly
@@ -188,6 +214,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainDestroy
virDomainFree
virDomainGetInfo
+
subject
virDomainGetXMLDesc
success
virConnectClose
virDomainDestroy
virDomainFree
@@ -196,23 +223,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSetMaxMemory
virDomainSuspend
suspended
virDomainResume
-

Letter t:

term
_virDomainInfo
-
terminated
virConnectGetType
-
that
virDomainGetInfo
-virDomainGetName
-
their
virConnectListDomains
-
then
virConnectOpenReadOnly
-virDomainGetMaxMemory
-virDomainSetMaxMemory
-
there
virConnectClose
-
thereafter
virDomainDestroy
-virDomainFree
-
this
_virDomainInfo
-virDomainGetMaxMemory
-virDomainSetMaxMemory
-
two
virGetVersion
-
type
virGetVersion
-

A-g -h-t -u-z +

A-f +g-s +t-z

Daniel Veillard

diff --git a/docs/APIchunk2.html b/docs/APIchunk2.html index ef4642eb4b..3dd0abe6cd 100644 --- a/docs/APIchunk2.html +++ b/docs/APIchunk2.html @@ -7,10 +7,29 @@ H1 {font-family: Verdana,Arial,Helvetica} H2 {font-family: Verdana,Arial,Helvetica} H3 {font-family: Verdana,Arial,Helvetica} A:link, A:visited, A:active { text-decoration: underline } -API Alphabetic Index u-z for libvir
Red Hat Logo

Libvir the virtualization API

API Alphabetic Index u-z for libvir

Developer Menu
API Indexes
Related links

A-g -h-t -u-z -

Letter u:

unknown
virGetVersion
+API Alphabetic Index t-z for libvir
Red Hat Logo

Libvir the virtualization API

API Alphabetic Index t-z for libvir

Developer Menu
API Indexes
Related links

A-f +g-s +t-z +

Letter t:

term
_virDomainInfo
+
terminated
virConnectGetType
+virDomainGetXMLDesc
+
that
virDomainGetInfo
+virDomainGetName
+
their
virConnectListDomains
+
then
virConnectOpenReadOnly
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+
there
virConnectClose
+
thereafter
virDomainDestroy
+virDomainFree
+
this
_virDomainInfo
+virDomainGetMaxMemory
+virDomainGetXMLDesc
+virDomainSetMaxMemory
+
two
virGetVersion
+
type
virGetVersion
+

Letter u:

unimplemented
virDomainCreateLinux
+
unknown
virGetVersion
unsigned
virDomainGetID
unused
virConnectOpen
virConnectOpenReadOnly
@@ -20,9 +39,11 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainDestroy
virDomainFree
virDomainGetInfo
+virDomainGetXMLDesc
virDomainSuspend
user
virDomainGetInfo

Letter v:

value
virConnectGetVersion
+virDomainGetXMLDesc
virGetVersion
values
virGetVersion
version
LIBVIR_VERSION_NUMBER
@@ -50,11 +71,14 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectGetVersion
without
virDomainSuspend
work
virConnectGetVersion
+
would
virDomainCreateLinux

Letter x:

xen
virConnectOpen
virConnectOpenReadOnly
xenstore
_virDomainInfo
+

Letter y:

yet
virDomainCreateLinux
+virDomainGetXMLDesc

Letter z:

zero
virConnectGetType
-

A-g -h-t -u-z +

A-f +g-s +t-z

Daniel Veillard

diff --git a/docs/APIfiles.html b/docs/APIfiles.html index 148f041fad..a57f7c865d 100644 --- a/docs/APIfiles.html +++ b/docs/APIfiles.html @@ -34,6 +34,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetInfo
virDomainGetMaxMemory
virDomainGetName
+virDomainGetXMLDesc
virDomainInfo
virDomainInfoPtr
virDomainLookupByID
diff --git a/docs/APIfunctions.html b/docs/APIfunctions.html index ca3094986e..6c9d9f86e4 100644 --- a/docs/APIfunctions.html +++ b/docs/APIfunctions.html @@ -28,6 +28,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetInfo
virDomainGetMaxMemory
virDomainGetName
+virDomainGetXMLDesc
virDomainResume
virDomainSetMaxMemory
virDomainSuspend
diff --git a/docs/APIsymbols.html b/docs/APIsymbols.html index 8552693e7c..069896aa05 100644 --- a/docs/APIsymbols.html +++ b/docs/APIsymbols.html @@ -34,6 +34,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetInfo
virDomainGetMaxMemory
virDomainGetName
+virDomainGetXMLDesc
virDomainInfo
virDomainInfoPtr
virDomainLookupByID
diff --git a/docs/html/libvir-libvir.html b/docs/html/libvir-libvir.html index 54c4575347..08841a3998 100644 --- a/docs/html/libvir-libvir.html +++ b/docs/html/libvir-libvir.html @@ -34,6 +34,7 @@ The content of this structure is not made public by the API. 
int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)
unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)
const char *	virDomainGetName	(virDomainPtr domain)
+
char *	virDomainGetXMLDesc		(virDomainPtr domain, 
					 int flags)
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)
int	virDomainResume			(virDomainPtr domain)
@@ -84,29 +85,31 @@ The content of this structure is not made public by the API.
name:optional argument currently unused, pass NULL
Returns:a pointer to the hypervisor connection or NULL in case of error

Function: virConnectOpenReadOnly

virConnectPtr	virConnectOpenReadOnly	(const char * name)

This function should be called first to get a read-only connection to the xen store. The set of APIs usable are then restricted.

name:optional argument currently unused, pass NULL
Returns:a pointer to the hypervisor connection or NULL in case of error

Function: virDomainCreateLinux

virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * kernel_path, 
					 const char * initrd_path, 
					 const char * cmdline, 
					 unsigned long memory, 
					 unsigned int flags)

-

Launch a new Linux guest domain

+

Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged access to the hypervisor.

conn:pointer to the hypervisor connection
kernel_path:the file path to the kernel image
initrd_path:an optional file path to an initrd
cmdline:optional command line parameters for the kernel
memory:the memory size in kilobytes
flags:an optional set of virDomainFlags
Returns:a new domain object or NULL in case of failure

Function: virDomainDestroy

int	virDomainDestroy		(virDomainPtr domain)

-

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.

+

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 requires priviledged access to the hypervisor.

domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Function: virDomainFree

int	virDomainFree			(virDomainPtr domain)

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

domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Function: virDomainGetID

unsigned int	virDomainGetID		(virDomainPtr domain)

Get the hypervisor ID number for the domain

domain:a domain object
Returns:the domain ID number or (unsigned int) -1 in case of error

Function: virDomainGetInfo

int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)

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

-
domain:a domain object or NULL
info:pointer to a virDomainInfo structure allocated by the user
Returns:0 in case of success and -1 in case of failure.

Function: virDomainGetMaxMemory

unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)

+
domain:a domain object
info:pointer to a virDomainInfo structure allocated by the user
Returns:0 in case of success and -1 in case of failure.
Function: virDomainGetMaxMemory
unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)

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

 
domain:a domain object or NULL
Returns:the memory size in kilobytes or 0 in case of error.
Function: virDomainGetName
const char *	virDomainGetName	(virDomainPtr domain)

 
Get the public name for that domain

-
domain:a domain object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.
Function: virDomainLookupByID
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)

+
domain:a domain object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.
Function: virDomainGetXMLDesc
char *	virDomainGetXMLDesc		(virDomainPtr domain, 
					 int flags)

+
Provide an XML description of the domain. NOTE: this API is subject to changes.

+
domain:a domain object
flags:and OR'ed set of extraction flags, not used yet
Returns:a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.
Function: virDomainLookupByID
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)

 
Try to find a domain based on the hypervisor ID number

 
conn:pointer to the hypervisor connection
id:the domain ID number
Returns:a new domain object or NULL in case of failure
Function: virDomainLookupByName
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)

-
Try to lookup a domain on the given hypervisor

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

 
conn:pointer to the hypervisor connection
name:name for the domain
Returns:a new domain object or NULL in case of failure
Function: virDomainResume
int	virDomainResume			(virDomainPtr domain)

-
Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain().

+

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

domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Function: virDomainSetMaxMemory

int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)

-

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

+

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

domain:a domain object or NULL
memory:the memory size in kilobytes
Returns:0 in case of success and -1 in case of failure.

Function: virDomainSuspend

int	virDomainSuspend		(virDomainPtr domain)

-

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

+

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 requires priviledged access to the hypervisor.

domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Function: virGetVersion

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

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

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

Daniel Veillard

diff --git a/docs/libvir-api.xml b/docs/libvir-api.xml index 06974d0c55..879cbdd18f 100644 --- a/docs/libvir-api.xml +++ b/docs/libvir-api.xml @@ -33,6 +33,7 @@ + @@ -120,7 +121,7 @@ - Launch a new Linux guest domain + Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged access to the hypervisor. @@ -130,7 +131,7 @@ - Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. + 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 requires priviledged access to the hypervisor. @@ -147,7 +148,7 @@ Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the informations can be extracted. - + @@ -160,6 +161,12 @@ + + Provide an XML description of the domain. NOTE: this API is subject to changes. + + + + Try to find a domain based on the hypervisor ID number @@ -167,24 +174,24 @@ - Try to lookup a domain on the given hypervisor + Try to lookup a domain on the given hypervisor based on its name. - Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). + Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). 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. + 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. - 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. + 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 requires priviledged access to the hypervisor. diff --git a/docs/libvir-refs.xml b/docs/libvir-refs.xml index 9f2cf04e6c..57a0213d97 100644 --- a/docs/libvir-refs.xml +++ b/docs/libvir-refs.xml @@ -28,6 +28,7 @@ + @@ -74,6 +75,7 @@ + @@ -138,6 +140,7 @@ + @@ -172,6 +175,7 @@ + @@ -190,6 +194,10 @@ + + + + @@ -267,14 +275,17 @@ + + + - + @@ -291,6 +302,9 @@ + + + @@ -321,6 +335,11 @@ + + + + + @@ -328,11 +347,17 @@ + + + + + + @@ -344,6 +369,10 @@ + + + + @@ -414,6 +443,7 @@ + @@ -433,6 +463,9 @@ + + + @@ -458,6 +491,7 @@ + @@ -468,6 +502,9 @@ + + + @@ -516,6 +553,12 @@ + + + + + + @@ -528,6 +571,9 @@ + + + @@ -539,6 +585,7 @@ + @@ -549,6 +596,9 @@ + + + @@ -573,6 +623,9 @@ + + + @@ -589,6 +642,9 @@ + + + @@ -608,12 +664,19 @@ + + + + + + + @@ -629,8 +692,6 @@ - - @@ -649,6 +710,8 @@ + + @@ -670,6 +733,7 @@ + @@ -679,6 +743,7 @@ + @@ -757,6 +822,9 @@ + + + @@ -782,6 +850,7 @@ + @@ -800,6 +869,7 @@ + @@ -865,6 +935,11 @@ + + + + + @@ -894,6 +969,13 @@ + + + + + + + @@ -914,6 +996,7 @@ + @@ -939,6 +1022,7 @@ + @@ -984,6 +1068,9 @@ + + + @@ -997,12 +1084,15 @@ + + + @@ -1026,6 +1116,7 @@ + @@ -1035,9 +1126,10 @@ - - + + + @@ -1057,6 +1149,7 @@ + @@ -1066,6 +1159,7 @@ + @@ -1126,6 +1220,9 @@ + + + @@ -1136,6 +1233,12 @@ + + + + + + @@ -1143,9 +1246,9 @@ - - - + + + diff --git a/src/libvir.c b/src/libvir.c index 07ad35495e..4e50e7e460 100644 --- a/src/libvir.c +++ b/src/libvir.c @@ -360,9 +360,8 @@ virConnectNumOfDomains(virConnectPtr conn) { * @memory: the memory size in kilobytes * @flags: an optional set of virDomainFlags * - * Launch a new Linux guest domain - * Not implemented yet. Very likely to be modified in order to express - * hardware informations in a convenient way. + * Launch a new Linux guest domain, unimplemented yet, API to be defined. + * This would function requires priviledged access to the hypervisor. * * Returns a new domain object or NULL in case of failure */ @@ -583,6 +582,7 @@ done: * 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 requires priviledged access to the hypervisor. * * Returns 0 in case of success and -1 in case of failure. */ @@ -632,6 +632,7 @@ virDomainFree(virDomainPtr domain) { * 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 requires priviledged access to the hypervisor. * * Returns 0 in case of success and -1 in case of failure. */ @@ -650,6 +651,7 @@ virDomainSuspend(virDomainPtr domain) { * * Resume an suspended domain, the process is restarted from the state where * it was frozen by calling virSuspendDomain(). + * This function requires priviledged access to the hypervisor. * * Returns 0 in case of success and -1 in case of failure. */ @@ -738,6 +740,7 @@ virDomainGetMaxMemory(virDomainPtr domain) { * 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. * * Returns 0 in case of success and -1 in case of failure. */