From e784908cfe386ab186b7f4edb7435f01370b8888 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Fri, 9 Dec 2005 14:33:38 +0000 Subject: [PATCH] Fixing doc generation stylesheets, daniel --- docs/APIchunk0.html | 16 ++-- docs/APIchunk1.html | 32 ++++---- docs/APIchunk2.html | 24 ++++-- docs/APIconstructors.html | 2 +- docs/APIfiles.html | 3 +- docs/APIfunctions.html | 3 +- docs/APIsymbols.html | 3 +- docs/html/book1.html | 2 +- docs/html/index.html | 2 +- .../html/{libxml-lib.html => libvir-lib.html} | 2 +- ...{libxml-libvir.html => libvir-libvir.html} | 81 ++++++++++--------- docs/libvir-api.xml | 6 ++ docs/libvir-refs.xml | 36 ++++++++- docs/newapi.xsl | 16 ++-- 14 files changed, 142 insertions(+), 86 deletions(-) rename docs/html/{libxml-lib.html => libvir-lib.html} (98%) rename docs/html/{libxml-libvir.html => libvir-libvir.html} (86%) diff --git a/docs/APIchunk0.html b/docs/APIchunk0.html index 9e13c49b5a..438f7c513b 100644 --- a/docs/APIchunk0.html +++ b/docs/APIchunk0.html @@ -7,9 +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-g for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index A-g for libvir

Developer Menu
API Indexes
Related links

A-g -h-u -v-z +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

Letter A:

ABI
_virDomainInfo
APIs
virConnectOpenReadOnly

Letter C:

CPU
virDomainSuspend
@@ -19,6 +19,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSetMaxMemory
Dynamically
virDomainSetMaxMemory

Letter E:

Extract
virDomainGetInfo
+

Letter F:

Free
virDomainFree

Letter G:

Get
virConnectGetType
virConnectGetVersion
virDomainGetID
@@ -71,6 +72,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSuspend
add
_virDomainInfo
against
virGetVersion
+
alive
virDomainFree
all
virDomainDestroy
allocated
virDomainGetInfo
virDomainGetMaxMemory
@@ -118,6 +120,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectOpenReadOnly
virDomainCreateLinux
virDomainDestroy
+virDomainFree
virDomainGetID
virDomainGetInfo
virDomainGetMaxMemory
@@ -150,6 +153,7 @@ A:link, A:visited, A:active { text-decoration: underline }
currently
virConnectOpen
virConnectOpenReadOnly

Letter d:

data
virDomainDestroy
+virDomainFree
deallocated
virDomainGetName
does
virDomainDestroy
domains
virConnectListDomains
@@ -172,6 +176,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetInfo

Letter f:

failure
virDomainCreateLinux
virDomainDestroy
+virDomainFree
virDomainGetInfo
virDomainLookupByID
virDomainLookupByName
@@ -194,6 +199,7 @@ A:link, A:visited, A:active { text-decoration: underline }
found
virConnectListDomains
virConnectNumOfDomains
freed
virDomainDestroy
+virDomainFree
from
_virDomainInfo
virDomainResume
frozen
virDomainResume
@@ -212,6 +218,6 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByName
guest
virDomainCreateLinux

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

Daniel Veillard

diff --git a/docs/APIchunk1.html b/docs/APIchunk1.html index 30e77b5d99..c1e6c17a7f 100644 --- a/docs/APIchunk1.html +++ b/docs/APIchunk1.html @@ -7,9 +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 h-u for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index h-u for libvir

Developer Menu
API Indexes
Related links

A-g -h-u -v-z +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
hypervisor
_virDomainInfo
virConnectClose
@@ -32,10 +32,12 @@ A:link, A:visited, A:active { text-decoration: underline }
informations
virDomainGetInfo
initrd
virDomainCreateLinux
instance
virDomainDestroy
+virDomainFree
int
virDomainGetID
interaction
virConnectClose
its
virDomainGetName
-

Letter k:

kernel
virDomainCreateLinux
+

Letter k:

kept
virDomainFree
+
kernel
virDomainCreateLinux
kilobytes
virDomainCreateLinux
virDomainGetMaxMemory
virDomainSetMaxMemory
@@ -79,6 +81,7 @@ A:link, A:visited, A:active { text-decoration: underline }
not
virConnectClose
virConnectGetVersion
virDomainDestroy
+virDomainFree
virDomainGetName
virGetVersion
number
virConnectListDomains
@@ -87,6 +90,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByID

Letter o:

object
virDomainCreateLinux
virDomainDestroy
+virDomainFree
virDomainGetID
virDomainGetInfo
virDomainGetMaxMemory
@@ -153,6 +157,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectClose
virConnectGetVersion
virDomainDestroy
+virDomainFree
runs
virDomainGetMaxMemory
virDomainSetMaxMemory

Letter s:

same
virDomainGetName
@@ -163,6 +168,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectOpen
virConnectOpenReadOnly
virDomainDestroy
+virDomainFree
shutdown
virDomainDestroy
size
virConnectListDomains
virDomainCreateLinux
@@ -180,9 +186,11 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetName
structure
_virDomainInfo
virDomainDestroy
+virDomainFree
virDomainGetInfo
success
virConnectClose
virDomainDestroy
+virDomainFree
virDomainGetInfo
virDomainResume
virDomainSetMaxMemory
@@ -198,23 +206,13 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainSetMaxMemory
there
virConnectClose
thereafter
virDomainDestroy
+virDomainFree
this
_virDomainInfo
virDomainGetMaxMemory
virDomainSetMaxMemory
two
virGetVersion
type
virGetVersion
-

Letter u:

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

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

Daniel Veillard

diff --git a/docs/APIchunk2.html b/docs/APIchunk2.html index e96a0a01b3..ef4642eb4b 100644 --- a/docs/APIchunk2.html +++ b/docs/APIchunk2.html @@ -7,10 +7,22 @@ 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 v-z for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index v-z for libvir

Developer Menu
API Indexes
Related links

A-g -h-u -v-z -

Letter v:

value
virConnectGetVersion
+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
+
unsigned
virDomainGetID
+
unused
virConnectOpen
+virConnectOpenReadOnly
+
usable
virConnectOpenReadOnly
+
used
_virDomainInfo
+virConnectGetType
+virDomainDestroy
+virDomainFree
+virDomainGetInfo
+virDomainSuspend
+
user
virDomainGetInfo
+

Letter v:

value
virConnectGetVersion
virGetVersion
values
virGetVersion
version
LIBVIR_VERSION_NUMBER
@@ -43,6 +55,6 @@ A:link, A:visited, A:active { text-decoration: underline }
xenstore
_virDomainInfo

Letter z:

zero
virConnectGetType

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

Daniel Veillard

diff --git a/docs/APIconstructors.html b/docs/APIconstructors.html index b940da11e6..3562b0c0a6 100644 --- a/docs/APIconstructors.html +++ b/docs/APIconstructors.html @@ -7,7 +7,7 @@ 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 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
+List of constructors for libvir
Red Hat Logo

Libvir the virtualization API

List of constructors for libvir

Developer Menu
API Indexes
Related links

Type unsigned int:

virDomainGetID

Type unsigned long:

virDomainGetMaxMemory

Type virConnectPtr:

virConnectOpen
virConnectOpenReadOnly
diff --git a/docs/APIfiles.html b/docs/APIfiles.html index cb60c57c1c..148f041fad 100644 --- a/docs/APIfiles.html +++ b/docs/APIfiles.html @@ -7,7 +7,7 @@ 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:

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

Libvir the 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
@@ -29,6 +29,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainCreateLinux
virDomainDestroy
virDomainFlags
+virDomainFree
virDomainGetID
virDomainGetInfo
virDomainGetMaxMemory
diff --git a/docs/APIfunctions.html b/docs/APIfunctions.html index 2d52812a76..ca3094986e 100644 --- a/docs/APIfunctions.html +++ b/docs/APIfunctions.html @@ -7,7 +7,7 @@ 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 function manipulating types in libvir
Red Hat Logo

Libvir the Linux virtualization API

List of function manipulating types in libvir

Developer Menu
API Indexes
Related links

Type int *:

virConnectListDomains
+List of function manipulating types in libvir
Red Hat Logo

Libvir the virtualization API

List of function manipulating types in libvir

Developer Menu
API Indexes
Related links

Type int *:

virConnectListDomains

Type unsigned int:

virDomainCreateLinux

Type unsigned long:

virDomainCreateLinux
virDomainSetMaxMemory
@@ -23,6 +23,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainLookupByName

Type virDomainInfoPtr:

virDomainGetInfo

Type virDomainPtr:

virDomainDestroy
+virDomainFree
virDomainGetID
virDomainGetInfo
virDomainGetMaxMemory
diff --git a/docs/APIsymbols.html b/docs/APIsymbols.html index 22822e5548..8552693e7c 100644 --- a/docs/APIsymbols.html +++ b/docs/APIsymbols.html @@ -7,7 +7,7 @@ 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 L:

LIBVIR_VERSION_NUMBER
+Alphabetic List of Symbols in libvir
Red Hat Logo

Libvir the 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
@@ -29,6 +29,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainCreateLinux
virDomainDestroy
virDomainFlags
+virDomainFree
virDomainGetID
virDomainGetInfo
virDomainGetMaxMemory
diff --git a/docs/html/book1.html b/docs/html/book1.html index 5b1cd9d013..bbc299cb47 100644 --- a/docs/html/book1.html +++ b/docs/html/book1.html @@ -10,4 +10,4 @@ A:link, A:visited, A:active { text-decoration: underline } Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

+ Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

diff --git a/docs/html/index.html b/docs/html/index.html index 5b1cd9d013..bbc299cb47 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -10,4 +10,4 @@ A:link, A:visited, A:active { text-decoration: underline } Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

+ Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

diff --git a/docs/html/libxml-lib.html b/docs/html/libvir-lib.html similarity index 98% rename from docs/html/libxml-lib.html rename to docs/html/libvir-lib.html index 5b1cd9d013..bbc299cb47 100644 --- a/docs/html/libxml-lib.html +++ b/docs/html/libvir-lib.html @@ -10,4 +10,4 @@ A:link, A:visited, A:active { text-decoration: underline } Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

+ Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

diff --git a/docs/html/libxml-libvir.html b/docs/html/libvir-libvir.html similarity index 86% rename from docs/html/libxml-libvir.html rename to docs/html/libvir-libvir.html index 221b807d83..54c4575347 100644 --- a/docs/html/libxml-libvir.html +++ b/docs/html/libvir-libvir.html @@ -12,32 +12,33 @@ A:link, A:visited, A:active { text-decoration: underline } pre.programlisting {border-style: double;background: #EECFA1} Module libvir from libvir
Red Hat Logo

Module libvir from libvir

API Menu
API Indexes
Related links
- - + + - - + +
UpAPI documentationHomeThe virtualization API

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

Table of Contents

#define LIBVIR_VERSION_NUMBER
Structure virConnect
struct _virConnect
 The content of this structure is not made public by the API.
-
Typedef virConnect * virConnectPtr
+
Typedef virConnect * virConnectPtr
 
Structure virDomain
struct _virDomain
 The content of this structure is not made public by the API.
 
Enum virDomainFlags
 
Structure virDomainInfo
struct _virDomainInfo
-
Typedef virDomainInfo * virDomainInfoPtr
-
Typedef virDomain * virDomainPtr
+
Typedef virDomainInfo * virDomainInfoPtr
+
Typedef virDomain * virDomainPtr
 
Enum virDomainState
-
int	virConnectClose			(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)
-
virConnectPtr	virConnectOpenReadOnly	(const char * name)
-
virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * kernel_path, 
					 const char * initrd_path, 
					 const char * cmdline, 
					 unsigned long memory, 
					 unsigned int flags)
-
int	virDomainDestroy		(virDomainPtr domain)
-
unsigned int	virDomainGetID		(virDomainPtr domain)
-
int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)
-
unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)
-
const char *	virDomainGetName	(virDomainPtr domain)
-
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)
-
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)
-
int	virDomainResume			(virDomainPtr domain)
-
int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)
-
int	virDomainSuspend		(virDomainPtr domain)
+
int	virConnectClose			(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)
+
virConnectPtr	virConnectOpenReadOnly	(const char * name)
+
virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * kernel_path, 
					 const char * initrd_path, 
					 const char * cmdline, 
					 unsigned long memory, 
					 unsigned int flags)
+
int	virDomainDestroy		(virDomainPtr domain)
+
int	virDomainFree			(virDomainPtr domain)
+
unsigned int	virDomainGetID		(virDomainPtr domain)
+
int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)
+
unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)
+
const char *	virDomainGetName	(virDomainPtr domain)
+
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)
+
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)
+
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

@@ -68,41 +69,43 @@ The content of this structure is not made public by the API. VIR_DOMAIN_SHUTDOWN = 4 : the domain is being shut down VIR_DOMAIN_SHUTOFF = 5 : the domain is shut off } -

Function: virConnectClose

int	virConnectClose			(virConnectPtr conn)

+

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: virConnectGetType

const char *	virConnectGetType	(virConnectPtr conn)

+
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)

+
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)

+
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)

+
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)

+
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)

+
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)

+
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

-
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)

+
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.

-
domain:a domain object
Returns:0 in case of success and -1 in case of failure.
Function: virDomainGetID
unsigned int	virDomainGetID		(virDomainPtr domain)

+
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)

+
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 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)

 
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)

+
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: 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)

+
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

-
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)

+
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().

-
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)

+
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.

-
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)

+
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.
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.

diff --git a/docs/libvir-api.xml b/docs/libvir-api.xml
index e835d10521..06974d0c55 100644
--- a/docs/libvir-api.xml
+++ b/docs/libvir-api.xml
@@ -26,6 +26,7 @@
      
      
      
+     
      
      
      
@@ -133,6 +134,11 @@
       
       
     
+    
+      Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.
+      
+      
+    
     
       Get the hypervisor ID number for the domain
       
diff --git a/docs/libvir-refs.xml b/docs/libvir-refs.xml
index 706bc6efd6..9f2cf04e6c 100644
--- a/docs/libvir-refs.xml
+++ b/docs/libvir-refs.xml
@@ -23,6 +23,7 @@
     
     
     
+    
     
     
     
@@ -68,6 +69,7 @@
       
       
       
+      
       
       
       
@@ -131,6 +133,7 @@
     
     
       
+      
       
       
       
@@ -164,6 +167,7 @@
       
       
       
+      
       
       
       
@@ -215,6 +219,11 @@
           
         
       
+      
+        
+          
+        
+      
       
         
           
@@ -348,6 +357,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -442,6 +454,7 @@
           
           
           
+          
           
           
           
@@ -498,6 +511,7 @@
       
         
           
+          
         
         
           
@@ -540,6 +554,7 @@
         
           
           
+          
           
           
           
@@ -576,6 +591,7 @@
         
         
           
+          
         
         
           
@@ -653,6 +669,7 @@
         
         
           
+          
         
         
           
@@ -665,6 +682,9 @@
         
       
       
+        
+          
+        
         
           
         
@@ -760,6 +780,7 @@
           
           
           
+          
           
           
         
@@ -774,6 +795,7 @@
         
           
           
+          
           
           
           
@@ -902,6 +924,7 @@
           
           
           
+          
         
         
           
@@ -922,6 +945,7 @@
           
           
           
+          
         
         
           
@@ -957,11 +981,13 @@
         
           
           
+          
           
         
         
           
           
+          
           
           
           
@@ -995,6 +1021,7 @@
         
         
           
+          
         
         
           
@@ -1008,6 +1035,8 @@
           
         
       
+    
+    
       
         
           
@@ -1026,6 +1055,7 @@
           
           
           
+          
           
           
         
@@ -1033,8 +1063,6 @@
           
         
       
-    
-    
       
         
           
@@ -1116,8 +1144,8 @@
     
     
       
-      
-      
+      
+      
     
   
 
diff --git a/docs/newapi.xsl b/docs/newapi.xsl
index 418df71491..4680bae9ba 100644
--- a/docs/newapi.xsl
+++ b/docs/newapi.xsl
@@ -107,16 +107,16 @@
            cellpadding="2" cellspacing="2">
PrevPrev Up API documentation Home The virtualization API NextNext
@@ -130,7 +130,7 @@ - + @@ -570,7 +570,7 @@ Module from - @@ -675,7 +675,7 @@
  • - + :
    • @@ -747,7 +747,7 @@ - + -- 2.39.5