From 108a82576e8f747e5f7fd7207c99acaf57d5c1a1 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Thu, 8 Dec 2005 15:19:20 +0000 Subject: [PATCH] Rebuilt the docs, Daniel --- docs/APIchunk0.html | 87 ++++++++-------- docs/APIchunk1.html | 99 +++++++++++++++--- docs/APIconstructors.html | 3 +- docs/APIfiles.html | 5 +- docs/APIfunctions.html | 3 + docs/APIsymbols.html | 5 +- docs/html/libxml-libvir.html | 21 ++-- docs/libvir-api.xml | 33 ++++-- docs/libvir-refs.xml | 188 +++++++++++++++++++++++++++++++++-- 9 files changed, 366 insertions(+), 78 deletions(-) diff --git a/docs/APIchunk0.html b/docs/APIchunk0.html index 2f41e5ba77..62f18f09fd 100644 --- a/docs/APIchunk0.html +++ b/docs/APIchunk0.html @@ -7,8 +7,9 @@ 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-m for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index A-m for libvir

Developer Menu
API Indexes
Related links

A-m -n-x +API Alphabetic Index A-h for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index A-h for libvir

Developer Menu
API Indexes
Related links

A-h +i-w +x-z

Letter A:

ABI
_virDomainInfo
APIs
virConnectOpenReadOnly

Letter C:

CPU
virDomainSuspend
@@ -18,10 +19,12 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSetMaxMemory
Dynamically
virDomainSetMaxMemory

Letter E:

Extract
virDomainGetInfo
-

Letter G:

Get
virConnectGetVersion
+

Letter G:

Get
virConnectGetType
+virConnectGetVersion
virDomainGetID
virDomainGetName

Letter H:

Hypervisor
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectOpen

Letter I:

IDs
virConnectListDomains
@@ -29,7 +32,9 @@ A:link, A:visited, A:active { text-decoration: underline }

Letter K:

KBytes
_virDomainInfo

Letter L:

Launch
virDomainCreateLinux
Linux
virDomainCreateLinux
-

Letter N:

NULL
virConnectOpen
+

Letter M:

Macro
LIBVIR_VERSION_NUMBER
+

Letter N:

NULL
virConnectGetType
+virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
virDomainGetInfo
@@ -38,23 +43,34 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByID
virDomainLookupByName
virDomainSetMaxMemory
+virGetVersion
Note
virDomainGetInfo
-

Letter R:

Resume
virDomainResume
+

Letter O:

OUT
virConnectGetVersion
+virGetVersion
+

Letter P:

Provides
virConnectNumOfDomains
+virGetVersion
+

Letter R:

Read-Only
virConnectGetVersion
+
Resume
virDomainResume
Retrieve
virDomainGetMaxMemory

Letter S:

Suspends
virDomainSuspend

Letter T:

TODO:
_virDomainInfo
This
virConnectClose
+virConnectGetVersion
virConnectOpen
virConnectOpenReadOnly
Try
virDomainLookupByID
virDomainLookupByName

Letter U:

Use
virDomainSuspend
+

Letter X:

Xen
virGetVersion

Letter a:

about
virDomainGetInfo
access
_virDomainInfo
+virConnectGetVersion
virDomainSuspend
active
virConnectListDomains
+virConnectNumOfDomains
virDomainSuspend
add
_virDomainInfo
+
against
virGetVersion
all
virDomainDestroy
allocated
virDomainGetInfo
virDomainGetMaxMemory
@@ -74,19 +90,26 @@ A:link, A:visited, A:active { text-decoration: underline }
argument
virConnectOpen
virConnectOpenReadOnly
array
virConnectListDomains
+
assumed
virGetVersion
available
_virDomainInfo
+
availble
virGetVersion

Letter b:

back
virDomainDestroy
+virGetVersion
based
virDomainLookupByID
below
_virDomainInfo
but
virDomainSuspend

Letter c:

call
_virDomainInfo
+virConnectGetVersion
called
virConnectClose
virConnectOpen
virConnectOpenReadOnly
calling
virDomainResume
can
_virDomainInfo
+virConnectGetVersion
virDomainGetInfo
+
capacities
virConnectGetVersion
case
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -102,14 +125,18 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainResume
virDomainSetMaxMemory
virDomainSuspend
+virGetVersion
change
virDomainSetMaxMemory
check
_virDomainInfo
clients
_virDomainInfo
closes
virConnectClose
+
code
virGetVersion
collect
virConnectListDomains
command
virDomainCreateLinux
+
compiled
virGetVersion
connection
_virDomainInfo
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -123,8 +150,10 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectOpenReadOnly

Letter d:

deallocated
virDomainGetName
domains
virConnectListDomains
+virConnectNumOfDomains
down
virDomainDestroy

Letter e:

error
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -132,8 +161,10 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectOpenReadOnly
virDomainGetID
virDomainGetMaxMemory
+virGetVersion
especially
virConnectClose
extracted
_virDomainInfo
+virConnectGetVersion
virDomainGetInfo

Letter f:

failure
virDomainCreateLinux
virDomainDestroy
@@ -143,15 +174,19 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainResume
virDomainSetMaxMemory
virDomainSuspend
+virGetVersion
file
virDomainCreateLinux
find
virDomainLookupByID
first
virConnectOpen
virConnectOpenReadOnly
for
_virDomainInfo
+virConnectGetVersion
virDomainCreateLinux
virDomainGetID
virDomainGetName
virDomainLookupByName
+virGetVersion
+
format
virGetVersion
found
virConnectListDomains
virConnectNumOfDomains
from
_virDomainInfo
@@ -171,8 +206,10 @@ A:link, A:visited, A:active { text-decoration: underline }
given
virDomainDestroy
virDomainLookupByName
guest
virDomainCreateLinux
-

Letter h:

hypervisor
_virDomainInfo
+

Letter h:

have
virGetVersion
+
hypervisor
_virDomainInfo
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -184,38 +221,8 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByID
virDomainLookupByName
virDomainSuspend
-

Letter i:

image
virDomainCreateLinux
-
information
virDomainGetInfo
-
informations
virDomainGetInfo
-
initrd
virDomainCreateLinux
-
instance
virDomainDestroy
-
int
virDomainGetID
-
interaction
virConnectClose
-
its
virDomainGetName
-

Letter k:

kernel
virDomainCreateLinux
-
kilobytes
virDomainCreateLinux
-virDomainGetMaxMemory
-virDomainSetMaxMemory
-

Letter l:

level
virConnectGetVersion
-virDomainSuspend
-
lifetime
virDomainGetName
-
limited
_virDomainInfo
-virDomainGetInfo
-
line
virDomainCreateLinux
-
list
virConnectListDomains
-
long
_virDomainInfo
-
lookup
virDomainLookupByName
-

Letter m:

major
virConnectGetVersion
-
maximum
_virDomainInfo
-virDomainGetMaxMemory
-virDomainSetMaxMemory
-
memory
_virDomainInfo
-virDomainCreateLinux
-virDomainGetMaxMemory
-virDomainSetMaxMemory
-virDomainSuspend
-
minor
virConnectGetVersion
-
monitoring
virConnectClose
-

A-m -n-x +virGetVersion
+

A-h +i-w +x-z

Daniel Veillard

diff --git a/docs/APIchunk1.html b/docs/APIchunk1.html index ad65a1021b..e906726ce1 100644 --- a/docs/APIchunk1.html +++ b/docs/APIchunk1.html @@ -7,9 +7,52 @@ 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 n-x for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index n-x for libvir

Developer Menu
API Indexes
Related links

A-m -n-x -

Letter n:

name
virDomainGetName
+API Alphabetic Index i-w for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index i-w for libvir

Developer Menu
API Indexes
Related links

A-h +i-w +x-z +

Letter i:

image
virDomainCreateLinux
+
information
virDomainGetInfo
+virGetVersion
+
informations
virDomainGetInfo
+
initrd
virDomainCreateLinux
+
instance
virDomainDestroy
+
int
virDomainGetID
+
interaction
virConnectClose
+
its
virDomainGetName
+

Letter k:

kernel
virDomainCreateLinux
+
kilobytes
virDomainCreateLinux
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+

Letter l:

lack
virConnectGetVersion
+
level
virConnectGetVersion
+virDomainSuspend
+
library
LIBVIR_VERSION_NUMBER
+virGetVersion
+
lifetime
virDomainGetName
+
limited
_virDomainInfo
+virDomainGetInfo
+
line
virDomainCreateLinux
+
list
virConnectListDomains
+
long
_virDomainInfo
+
lookup
virDomainLookupByName
+

Letter m:

major
virConnectGetVersion
+virGetVersion
+
maximum
_virDomainInfo
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+
may
virConnectGetVersion
+
memory
_virDomainInfo
+virDomainCreateLinux
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+virDomainSuspend
+
micro
LIBVIR_VERSION_NUMBER
+
minor
LIBVIR_VERSION_NUMBER
+virConnectGetVersion
+virGetVersion
+
monitoring
virConnectClose
+

Letter n:

name
virConnectGetType
+virDomainGetName
virDomainLookupByName
need
virConnectClose
virDomainGetName
@@ -18,8 +61,10 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByID
virDomainLookupByName
not
virConnectClose
+virConnectGetVersion
virDomainDestroy
virDomainGetName
+virGetVersion
number
virConnectListDomains
virConnectNumOfDomains
virDomainGetID
@@ -37,11 +82,14 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSuspend
one
_virDomainInfo
only
_virDomainInfo
+virConnectGetVersion
virDomainGetInfo
optional
virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
-
otherwise
virConnectGetVersion
+
otherwise
virConnectGetType
+virConnectGetVersion
+virGetVersion

Letter p:

padding
_virDomainInfo
parameters
virDomainCreateLinux
partial
virDomainGetInfo
@@ -51,6 +99,7 @@ A:link, A:visited, A:active { text-decoration: underline }
physical
virDomainGetMaxMemory
virDomainSetMaxMemory
pointer
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -62,20 +111,27 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByID
virDomainLookupByName
private
_virDomainInfo
+
priviledged
virConnectGetVersion
process
virDomainResume
virDomainSuspend
protection
_virDomainInfo
+
providing
LIBVIR_VERSION_NUMBER
public
virDomainGetName
publicly
_virDomainInfo

Letter r:

reactivate
virDomainSuspend
read-only
virConnectOpenReadOnly
+
release
virConnectGetVersion
+virGetVersion
reserved
virDomainGetMaxMemory
virDomainSetMaxMemory
resources
virDomainDestroy
virDomainSuspend
restarted
virDomainResume
restricted
virConnectOpenReadOnly
-
rev
virConnectGetVersion
+
return
virConnectGetVersion
+virGetVersion
+
returned
virGetVersion
+
returns
virConnectGetVersion
running
_virDomainInfo
virConnectClose
virConnectGetVersion
@@ -94,13 +150,16 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainCreateLinux
virDomainGetMaxMemory
virDomainSetMaxMemory
+
software
virConnectGetType
state
_virDomainInfo
virDomainResume
+
static
virConnectGetType
stay
virDomainSuspend
store
virConnectListDomains
virConnectOpen
virConnectOpenReadOnly
-
string
virDomainGetName
+
string
virConnectGetType
+virDomainGetName
structure
_virDomainInfo
virDomainGetInfo
success
virConnectClose
@@ -111,6 +170,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSuspend
suspended
virDomainResume

Letter t:

term
_virDomainInfo
+
terminated
virConnectGetType
that
virDomainGetInfo
virDomainGetName
their
virConnectListDomains
@@ -121,35 +181,48 @@ A:link, A:visited, A:active { text-decoration: underline }
this
_virDomainInfo
virDomainGetMaxMemory
virDomainSetMaxMemory
-

Letter u:

unsigned
virDomainGetID
+
two
virGetVersion
+
type
virGetVersion
+

Letter u:

unknown
virGetVersion
+
unsigned
virDomainGetID
unused
virConnectOpen
virConnectOpenReadOnly
usable
virConnectOpenReadOnly
used
_virDomainInfo
+virConnectGetType
virDomainDestroy
virDomainGetInfo
virDomainSuspend
user
virDomainGetInfo
-

Letter v:

version
virConnectGetVersion
+

Letter v:

value
virConnectGetVersion
+virGetVersion
+
values
virGetVersion
+
version
LIBVIR_VERSION_NUMBER
+virConnectGetVersion
+virGetVersion
virDomainFlags
_virDomainInfo
virDomainCreateLinux
virDomainInfo
virDomainGetInfo
virDomainResume
virDomainSuspend
virSuspendDomain
virDomainResume

Letter w:

was
virDomainResume
+virGetVersion
what
_virDomainInfo
where
virDomainGetMaxMemory
virDomainResume
virDomainSetMaxMemory
which
virConnectClose
+virGetVersion
+
while
virGetVersion
will
virDomainGetName
virDomainSuspend
+virGetVersion
with
_virDomainInfo
virConnectClose
+virConnectGetVersion
without
virDomainSuspend
-

Letter x:

xen
virConnectOpen
-virConnectOpenReadOnly
-
xenstore
_virDomainInfo
-

A-m -n-x +
work
virConnectGetVersion
+

A-h +i-w +x-z

Daniel Veillard

diff --git a/docs/APIconstructors.html b/docs/APIconstructors.html index 0cea63a8fc..b940da11e6 100644 --- a/docs/APIconstructors.html +++ b/docs/APIconstructors.html @@ -8,8 +8,7 @@ H2 {font-family: Verdana,Arial,Helvetica} H3 {font-family: Verdana,Arial,Helvetica} A:link, A:visited, A:active { text-decoration: underline } List of constructors for libvir
Red Hat Logo

Libvir the Linux virtualization API

List of constructors for libvir

Developer Menu
API Indexes
Related links

Type unsigned int:

virDomainGetID
-

Type unsigned long:

virConnectGetVersion
-virDomainGetMaxMemory
+

Type unsigned long:

virDomainGetMaxMemory

Type virConnectPtr:

virConnectOpen
virConnectOpenReadOnly

Type virDomainPtr:

virDomainCreateLinux
diff --git a/docs/APIfiles.html b/docs/APIfiles.html index 3ada12167c..cb60c57c1c 100644 --- a/docs/APIfiles.html +++ b/docs/APIfiles.html @@ -7,7 +7,8 @@ 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 } -List of Symbols per Module for libvir
Red Hat Logo

Libvir the Linux virtualization API

List of Symbols per Module for libvir

Developer Menu
API Indexes
Related links

Module libvir:

VIR_DOMAIN_BLOCKED
+List of Symbols per Module for libvir
Red Hat Logo

Libvir the Linux virtualization API

List of Symbols per Module for libvir

Developer Menu
API Indexes
Related links

Module libvir:

LIBVIR_VERSION_NUMBER
+VIR_DOMAIN_BLOCKED
VIR_DOMAIN_NONE
VIR_DOMAIN_NOSTATE
VIR_DOMAIN_PAUSED
@@ -17,6 +18,7 @@ A:link, A:visited, A:active { text-decoration: underline } _virDomainInfo
virConnect
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -40,4 +42,5 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSetMaxMemory
virDomainState
virDomainSuspend
+virGetVersion

Daniel Veillard

diff --git a/docs/APIfunctions.html b/docs/APIfunctions.html index d1deaffac3..2d52812a76 100644 --- a/docs/APIfunctions.html +++ b/docs/APIfunctions.html @@ -11,7 +11,10 @@ A:link, A:visited, A:active { text-decoration: underline }

Type unsigned int:

virDomainCreateLinux

Type unsigned long:

virDomainCreateLinux
virDomainSetMaxMemory
+

Type unsigned long *:

virConnectGetVersion
+virGetVersion

Type virConnectPtr:

virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
diff --git a/docs/APIsymbols.html b/docs/APIsymbols.html index c1b8be3758..22822e5548 100644 --- a/docs/APIsymbols.html +++ b/docs/APIsymbols.html @@ -7,7 +7,8 @@ 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 } -Alphabetic List of Symbols in libvir
Red Hat Logo

Libvir the Linux virtualization API

Alphabetic List of Symbols in libvir

Developer Menu
API Indexes
Related links

Letter V:

VIR_DOMAIN_BLOCKED
+Alphabetic List of Symbols in libvir
Red Hat Logo

Libvir the Linux virtualization API

Alphabetic List of Symbols in libvir

Developer Menu
API Indexes
Related links

Letter L:

LIBVIR_VERSION_NUMBER
+

Letter V:

VIR_DOMAIN_BLOCKED
VIR_DOMAIN_NONE
VIR_DOMAIN_NOSTATE
VIR_DOMAIN_PAUSED
@@ -17,6 +18,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Letter _:

_virDomainInfo

Letter v:

virConnect
virConnectClose
+virConnectGetType
virConnectGetVersion
virConnectListDomains
virConnectNumOfDomains
@@ -40,4 +42,5 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSetMaxMemory
virDomainState
virDomainSuspend
+virGetVersion

Daniel Veillard

diff --git a/docs/html/libxml-libvir.html b/docs/html/libxml-libvir.html index 21c732c486..d1ec48cb22 100644 --- a/docs/html/libxml-libvir.html +++ b/docs/html/libxml-libvir.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } Module libvir from libvir
Red Hat Logo

Module libvir from libvir

API Menu
API Indexes
Related links
UpAPI documentationHomeThe XML C parser and toolkit of Gnome

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

Table of Contents

Structure virConnect
struct _virConnect
+    Module libvir from libvir
Red Hat Logo
Module libvir from libvir
API Menu
API Indexes
Related links
UpAPI documentationHomeThe XML C parser and toolkit of Gnome
Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0 
Table of Contents
#define LIBVIR_VERSION_NUMBER
Structure virConnect
struct _virConnect
 The content of this structure is not made public by the API.
 
Typedef virConnect * virConnectPtr
 
Structure virDomain
struct _virDomain
@@ -21,7 +21,8 @@ The content of this structure is not made public by the API.
 
Typedef virDomain * virDomainPtr
 
Enum virDomainState
 
int	virConnectClose			(virConnectPtr conn)

-
unsigned long	virConnectGetVersion	(virConnectPtr conn)

+
const char *	virConnectGetType	(virConnectPtr conn)

+
int	virConnectGetVersion		(virConnectPtr conn, 
					 unsigned long * hvVer)

 
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

 
int	virConnectNumOfDomains		(virConnectPtr conn)

 
virConnectPtr	virConnectOpen		(const char * name)

@@ -37,7 +38,9 @@ The content of this structure is not made public by the API.
 
int	virDomainResume			(virDomainPtr domain)

 
int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)

 
int	virDomainSuspend		(virDomainPtr domain)

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

 
Description

+
Macro: LIBVIR_VERSION_NUMBER
#define LIBVIR_VERSION_NUMBER
Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro

 
Structure virConnect
Structure virConnect
struct _virConnect {
 The content of this structure is not made public by the API.
 }

@@ -67,12 +70,14 @@ The content of this structure is not made public by the API.
 }
 
Function: virConnectClose
int	virConnectClose			(virConnectPtr conn)

 
This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.

-
conn:pointer to the hypervisor connection
Returns:0 in case of success or -1 in case of error.
Function: virConnectGetVersion
unsigned long	virConnectGetVersion	(virConnectPtr conn)

-
Get the version level of the Hypervisor running.

-
conn:pointer to the hypervisor connection
Returns:-1 in case of error or major * 10,000 + minor * 100 + rev otherwise
Function: virConnectListDomains
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

+
conn:pointer to the hypervisor connection
Returns:0 in case of success or -1 in case of error.
Function: virConnectGetType
const char *	virConnectGetType	(virConnectPtr conn)

+
Get the name of the Hypervisor software used.

+
conn:pointer to the hypervisor connection
Returns:NULL in case of error, a static zero terminated string otherwise.
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.

+
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: virConnectListDomains
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

 
Collect the list of active domains, and store their ID in @maxids

 
conn:pointer to the hypervisor connection
ids:array to collect the list of IDs of active domains
maxids:size of @ids
Returns:the number of domain found or -1 in case of error
Function: virConnectNumOfDomains
int	virConnectNumOfDomains		(virConnectPtr conn)

-

+
Provides the number of active domains.

 
conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error
Function: virConnectOpen
virConnectPtr	virConnectOpen		(const char * name)

 
This function should be called first to get a connection to the Hypervisor and xen store

 
name:optional argument currently unused, pass NULL
Returns:a pointer to the hypervisor connection or NULL in case of error
Function: virConnectOpenReadOnly
virConnectPtr	virConnectOpenReadOnly	(const char * name)

@@ -99,4 +104,6 @@ The content of this structure is not made public by the API.
 
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.

 
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.

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

+
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 e91f167308..70ad4a12f0 100644 --- a/docs/libvir-api.xml +++ b/docs/libvir-api.xml @@ -5,6 +5,7 @@

core interfaces for the libvir library Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0 Daniel Veillard <veillard@redhat.com> + @@ -23,9 +24,11 @@ + + @@ -34,13 +37,16 @@ - - - + + + + + Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro + @@ -79,11 +85,17 @@ - - Get the version level of the Hypervisor running. - + + Get the name of the Hypervisor software used. + + + 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. + + + + Collect the list of active domains, and store their ID in @maxids @@ -92,7 +104,7 @@ - + Provides the number of active domains. @@ -170,5 +182,12 @@ + + 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. + + + + + diff --git a/docs/libvir-refs.xml b/docs/libvir-refs.xml index 60852eaf06..89b97dce93 100644 --- a/docs/libvir-refs.xml +++ b/docs/libvir-refs.xml @@ -1,6 +1,7 @@ + @@ -11,6 +12,7 @@ + @@ -34,8 +36,12 @@ + + + + @@ -51,6 +57,7 @@ + @@ -74,6 +81,7 @@ + @@ -81,7 +89,6 @@ - @@ -105,8 +112,13 @@ + + + + + @@ -130,6 +142,7 @@ + @@ -140,6 +153,7 @@ + @@ -163,6 +177,7 @@ + @@ -202,6 +217,7 @@ + @@ -210,6 +226,7 @@ + @@ -235,8 +252,14 @@ + + + + + + @@ -246,12 +269,28 @@ + + + + + + + + + + + + + + + + @@ -270,6 +309,7 @@ + @@ -283,21 +323,31 @@ + + + + + + + + + + @@ -335,13 +385,20 @@ + + + + + + + @@ -356,6 +413,7 @@ + @@ -367,10 +425,15 @@ + + + + + @@ -386,6 +449,7 @@ + @@ -399,15 +463,22 @@ + + + + + + + @@ -429,6 +500,7 @@ + @@ -437,6 +509,7 @@ + @@ -444,12 +517,14 @@ + + @@ -463,6 +538,7 @@ + @@ -476,10 +552,15 @@ + + + + + @@ -522,9 +603,13 @@ + + + + @@ -536,14 +621,18 @@ + + + + @@ -575,10 +664,17 @@ + + + + + + + @@ -602,12 +698,16 @@ + + + + @@ -615,17 +715,21 @@ + + + + + - - + @@ -643,8 +747,10 @@ + + @@ -672,6 +778,7 @@ + @@ -680,7 +787,9 @@ + + @@ -706,6 +815,7 @@ + @@ -720,6 +830,9 @@ + + + @@ -727,6 +840,9 @@ + + + @@ -741,6 +857,10 @@ + + + + @@ -755,7 +875,14 @@ - + + + + + + + + @@ -792,10 +919,16 @@ + + + + + + @@ -805,6 +938,7 @@ + @@ -827,6 +961,9 @@ + + + @@ -847,8 +984,17 @@ + + + + + + + + + @@ -861,6 +1007,7 @@ + @@ -870,8 +1017,17 @@ - + + + + + + + + + + @@ -890,6 +1046,7 @@ + @@ -901,19 +1058,30 @@ + + + + + + + + + + + @@ -923,10 +1091,16 @@ + + + + + - - + + +