From e1d715ef7d517f1a16e6f651784bfbfc56b6bdc3 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Fri, 11 Sep 2009 15:49:35 +0100 Subject: [PATCH] Rebuild API docs --- docs/devhelp/libvirt-libvirt.html | 69 +++++++++--- docs/devhelp/libvirt-virterror.html | 3 +- docs/html/libvirt-libvirt.html | 39 ++++--- docs/html/libvirt-virterror.html | 2 +- docs/libvirt-api.xml | 85 ++++++++++---- docs/libvirt-refs.xml | 165 +++++++++++++++++++--------- 6 files changed, 259 insertions(+), 104 deletions(-) diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html index e3e91aa08c..4cabeb94c5 100644 --- a/docs/devhelp/libvirt-libvirt.html +++ b/docs/devhelp/libvirt-libvirt.html @@ -114,8 +114,9 @@ typedef virStoragePoolInfo typedef enum virDomainCreateFlags; typedef virSecurityLabel * virSecurityLabelPtr; typedef struct _virSecurityModel virSecurityModel; +typedef enum virSecretUsageType; char * virStoragePoolGetXMLDesc (virStoragePoolPtr pool,
unsigned int flags); -char * virSecretGetUUIDString (virSecretPtr secret); +int virSecretGetUUIDString (virSecretPtr secret,
char * buf); const char * virStorageVolGetKey (virStorageVolPtr vol); typedef void virEventUpdateTimeoutFunc (int timer,
int timeout); int virDomainUndefine (virDomainPtr domain); @@ -148,6 +149,7 @@ int virDomainSetAutostart (virStorageVolPtr virStorageVolLookupByPath (virConnectPtr conn,
const char * path); virStorageVolPtr virStorageVolLookupByName (virStoragePoolPtr pool,
const char * name); int virNetworkCreate (virNetworkPtr network); +virSecretPtr virSecretLookupByUUID (virConnectPtr conn,
const unsigned char * uuid); int virDomainSetMaxMemory (virDomainPtr domain,
unsigned long memory); void virEventRegisterImpl (virEventAddHandleFunc addHandle,
virEventUpdateHandleFunc updateHandle,
virEventRemoveHandleFunc removeHandle,
virEventAddTimeoutFunc addTimeout,
virEventUpdateTimeoutFunc updateTimeout,
virEventRemoveTimeoutFunc removeTimeout); virInterfacePtr virInterfaceDefineXML (virConnectPtr conn,
const char * xml,
unsigned int flags); @@ -162,9 +164,10 @@ int virConnectNumOfNetworks (virConnectPtr virSecretGetConnect (virSecretPtr secret); int virInterfaceCreate (virInterfacePtr iface,
unsigned int flags); char * virDomainGetXMLDesc (virDomainPtr domain,
int flags); +virSecretPtr virSecretLookupByUsage (virConnectPtr conn,
int usageType,
const char * usageID); int virStoragePoolGetUUID (virStoragePoolPtr pool,
unsigned char * uuid); int virNodeDeviceFree (virNodeDevicePtr dev); -int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info); +int virSecretGetUsageType (virSecretPtr secret); int virDomainGetInfo (virDomainPtr domain,
virDomainInfoPtr info); virNodeDevicePtr virNodeDeviceCreateXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags); int virNetworkDestroy (virNetworkPtr network); @@ -186,7 +189,7 @@ const char * virInterfaceGetName (virStoragePoolCreate (virStoragePoolPtr pool,
unsigned int flags); int virNodeGetInfo (virConnectPtr conn,
virNodeInfoPtr info); int virNetworkSetAutostart (virNetworkPtr network,
int autostart); -virSecretPtr virSecretLookupByUUIDString (virConnectPtr conn,
const char * uuid); +virSecretPtr virSecretLookupByUUIDString (virConnectPtr conn,
const char * uuidstr); unsigned long virDomainGetMaxMemory (virDomainPtr domain); int virStoragePoolFree (virStoragePoolPtr pool); int virConnectNumOfDefinedInterfaces (virConnectPtr conn); @@ -203,11 +206,13 @@ int virDomainGetAutostart (virStoragePoolListVolumes (virStoragePoolPtr pool,
char ** const names,
int maxnames); char * virConnectGetHostname (virConnectPtr conn); typedef int virEventRemoveTimeoutFunc (int timer); +int virStorageVolGetInfo (virStorageVolPtr vol,
virStorageVolInfoPtr info); const char * virDomainGetName (virDomainPtr domain); int virStoragePoolRef (virStoragePoolPtr pool); char * virNetworkGetXMLDesc (virNetworkPtr network,
int flags); int virConnectNumOfStoragePools (virConnectPtr conn); virConnectPtr virInterfaceGetConnect (virInterfacePtr iface); +int virStoragePoolNumOfVolumes (virStoragePoolPtr pool); const char * virNetworkGetName (virNetworkPtr network); char * virSecretGetXMLDesc (virSecretPtr secret,
unsigned int flags); int virConnectListDefinedDomains (virConnectPtr conn,
char ** const names,
int maxnames); @@ -218,6 +223,7 @@ int virStorageVolFree (virDomainPinVcpu (virDomainPtr domain,
unsigned int vcpu,
unsigned char * cpumap,
int maplen); int virNodeGetSecurityModel (virConnectPtr conn,
virSecurityModelPtr secmodel); int virDomainRestore (virConnectPtr conn,
const char * from); +int virSecretGetUUID (virSecretPtr secret,
unsigned char * uuid); int virNodeDeviceDestroy (virNodeDevicePtr dev); char * virStorageVolGetPath (virStorageVolPtr vol); virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn,
const char * uuidstr); @@ -253,7 +259,7 @@ typedef void virEventHandleCallback (int char * virDomainGetSchedulerType (virDomainPtr domain,
int * nparams); int virNodeDeviceReset (virNodeDevicePtr dev); int virDomainDetachDevice (virDomainPtr domain,
const char * xml); -int virStoragePoolNumOfVolumes (virStoragePoolPtr pool); +const char * virSecretGetUsageID (virSecretPtr secret); int virStoragePoolGetUUIDString (virStoragePoolPtr pool,
char * buf); int virNodeDeviceReAttach (virNodeDevicePtr dev); int virStoragePoolUndefine (virStoragePoolPtr pool); @@ -664,6 +670,13 @@ The content of this structure is not made public by the API.

Typedef virSecretPtr

virSecret * virSecretPtr;

+

+
+

Enum virSecretUsageType

enum virSecretUsageType {
+    VIR_SECRET_USAGE_TYPE_NONE = 0
+    VIR_SECRET_USAGE_TYPE_VOLUME = 1 /*  Expect more owner types later... */
+};
+

Structure virSecurityLabel

struct _virSecurityLabel {
@@ -1188,23 +1201,23 @@ The content of this structure is not made public by the API.
         

         
virInterfaceFree ()
int	virInterfaceFree		(virInterfacePtr iface)

 
Free the interface object. The interface itself is unaltered. The data structure is freed and should not be used thereafter.

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

+
iface:an interface object
Returns:0 in case of success and -1 in case of failure.

virInterfaceGetConnect ()

virConnectPtr	virInterfaceGetConnect	(virInterfacePtr iface)

Provides the connection pointer associated with an interface. 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 interface object together.

-
iface:pointer to a interface
Returns:the virConnectPtr or NULL in case of failure.
+
iface:pointer to an interface
Returns:the virConnectPtr or NULL in case of failure.

virInterfaceGetMACString ()

const char *	virInterfaceGetMACString	(virInterfacePtr iface)

-

Get the MAC for a interface as string. For more information about MAC see RFC4122.

-
iface:a interface object
Returns:a pointer to the MAC address (in null-terminated ASCII format) or NULL, the string need not be deallocated its lifetime will be the same as the interface object.
+

Get the MAC for an interface as string. For more information about MAC see RFC4122.

+
iface:an interface object
Returns:a pointer to the MAC address (in null-terminated ASCII format) or NULL, the string need not be deallocated its lifetime will be the same as the interface object.

virInterfaceGetName ()

const char *	virInterfaceGetName	(virInterfacePtr iface)

Get the public name for that interface

-
iface:a interface object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the interface object.
+
iface:an interface object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the interface object.

virInterfaceGetXMLDesc ()

char *	virInterfaceGetXMLDesc		(virInterfacePtr iface, 
					 unsigned int flags)

-

Provide an XML description of the interface. The description may be reused later to recreate the interface with virInterfaceCreateXML().

-
iface:a interface 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.
+

Provide an XML description of the interface. The description may be reused later to redefine the interface with virInterfaceDefineXML().

+
iface:an interface object
flags:an 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.

virInterfaceLookupByMACString ()

virInterfacePtr	virInterfaceLookupByMACString	(virConnectPtr conn, 
						 const char * macstr)

Try to lookup an interface on the given hypervisor based on its MAC.

@@ -1215,7 +1228,7 @@ The content of this structure is not made public by the API.
conn:pointer to the hypervisor connection
name:name for the interface
Returns:a new interface object or NULL in case of failure. If the interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.

virInterfaceRef ()

int	virInterfaceRef			(virInterfacePtr iface)

-

Increment the reference count on the interface. For each additional call to this method, there shall be a corresponding call to virInterfaceFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a interface would increment the reference count.

+

Increment the reference count on the interface. For each additional call to this method, there shall be a corresponding call to virInterfaceFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using an interface would increment the reference count.

iface:the interface to hold a reference on
Returns:0 in case of success, -1 in case of failure.

virInterfaceUndefine ()

int	virInterfaceUndefine		(virInterfacePtr iface)

@@ -1268,7 +1281,7 @@ The content of this structure is not made public by the API.
         

         
virNetworkGetXMLDesc ()
char *	virNetworkGetXMLDesc		(virNetworkPtr network, 
					 int flags)

 
Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().

-
network:a network 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.

+
network:a network object
flags:an 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.

virNetworkLookupByName ()

virNetworkPtr	virNetworkLookupByName	(virConnectPtr conn, 
					 const char * name)

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

@@ -1382,9 +1395,21 @@ The content of this structure is not made public by the API.

Provides the connection pointer associated with a secret. 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 secret object together.

secret:A virSecret secret
Returns:the virConnectPtr or NULL in case of failure.
-

virSecretGetUUIDString ()

char *	virSecretGetUUIDString		(virSecretPtr secret)

+        
virSecretGetUUID ()
int	virSecretGetUUID		(virSecretPtr secret, 
					 unsigned char * uuid)

 
Fetches the UUID of the secret.

-
secret:A virSecret secret
Returns:ID of the secret (not necessarily in the UUID format) on success, NULL on failure. The caller must free() the ID.

+
secret:A virSecret secret
uuid:buffer of VIR_UUID_BUFLEN bytes in size
Returns:0 on success with the uuid buffer being filled, or -1 upon failure.
+
+

virSecretGetUUIDString ()

int	virSecretGetUUIDString		(virSecretPtr secret, 
					 char * buf)

+

Get the UUID for a secret as string. For more information about UUID see RFC4122.

+
secret:a secret object
buf:pointer to a VIR_UUID_STRING_BUFLEN bytes array
Returns:-1 in case of error, 0 in case of success
+
+

virSecretGetUsageID ()

const char *	virSecretGetUsageID	(virSecretPtr secret)

+

Get the unique identifier of the object with which this secret is to be used

+
secret:a secret object
Returns:a string identifying the object using the secret, or NULL upon error
+
+

virSecretGetUsageType ()

int	virSecretGetUsageType		(virSecretPtr secret)

+

Get the type of object which uses this secret

+
secret:a secret object
Returns:a positive integer identifying the type of object, or -1 upon error.

virSecretGetValue ()

unsigned char *	virSecretGetValue	(virSecretPtr secret, 
					 size_t * value_size, 
					 unsigned int flags)

Fetches the value of a secret.

@@ -1394,9 +1419,17 @@ The content of this structure is not made public by the API.

Fetches an XML document describing attributes of the secret.

secret:A virSecret secret
flags:flags, use 0 for now
Returns:the XML document on success, NULL on failure. The caller must free() the XML.
-

virSecretLookupByUUIDString ()

virSecretPtr	virSecretLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuid)

-

Fetches a secret based on uuid.

-
conn:virConnect connection
uuid:ID of a secret
Returns:the secret on success, or NULL on failure.
+

virSecretLookupByUUID ()

virSecretPtr	virSecretLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)

+

Try to lookup a secret on the given hypervisor based on its UUID.

+
conn:pointer to the hypervisor connection
uuid:the raw UUID for the secret
Returns:a new secret object or NULL in case of failure. If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
+
+

virSecretLookupByUUIDString ()

virSecretPtr	virSecretLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

+

Try to lookup a secret on the given hypervisor based on its UUID.

+
conn:pointer to the hypervisor connection
uuidstr:the string UUID for the secret
Returns:a new secret object or NULL in case of failure. If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
+
+

virSecretLookupByUsage ()

virSecretPtr	virSecretLookupByUsage	(virConnectPtr conn, 
					 int usageType, 
					 const char * usageID)

+

Try to lookup a secret on the given hypervisor based on its usage

+
conn:pointer to the hypervisor connection
usageType:the type of secret usage
usageID:identifier of the object using the secret
Returns:a new secret object or NULL in case of failure. If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.

virSecretRef ()

int	virSecretRef			(virSecretPtr secret)

Increment the reference count on the secret. For each additional call to this method, there shall be a corresponding call to virSecretFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a secret would increment the reference count.

diff --git a/docs/devhelp/libvirt-virterror.html b/docs/devhelp/libvirt-virterror.html index 28e184ef7f..686522429e 100644 --- a/docs/devhelp/libvirt-virterror.html +++ b/docs/devhelp/libvirt-virterror.html @@ -187,7 +187,8 @@ void virConnResetLastError (VIR_ERR_INVALID_INTERFACE = 58 /* invalid interface object */ VIR_ERR_MULTIPLE_INTERFACES = 59 /* more than one matching interface found */ VIR_WAR_NO_SECRET = 60 /* failed to start secret storage */ - VIR_ERR_INVALID_SECRET = 61 /* invalid secret */ + VIR_ERR_INVALID_SECRET = 61 /* invalid secret */ + VIR_ERR_NO_SECRET = 62 /* secret not found */ };

diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html index 5772fbef43..0f2cb8aa3e 100644 --- a/docs/html/libvirt-libvirt.html +++ b/docs/html/libvirt-libvirt.html @@ -59,6 +59,7 @@ typedef virSchedParameter * typedef enum virSchedParameterType typedef struct _virSecret virSecret typedef virSecret * virSecretPtr +typedef enum virSecretUsageType typedef struct _virSecurityLabel virSecurityLabel typedef virSecurityLabel * virSecurityLabelPtr typedef struct _virSecurityModel virSecurityModel @@ -248,10 +249,15 @@ int virNodeNumOfDevices (virSecretPtr virSecretDefineXML (virConnectPtr conn,
const char * xml,
unsigned int flags) int virSecretFree (virSecretPtr secret) virConnectPtr virSecretGetConnect (virSecretPtr secret) -char * virSecretGetUUIDString (virSecretPtr secret) +int virSecretGetUUID (virSecretPtr secret,
unsigned char * uuid) +int virSecretGetUUIDString (virSecretPtr secret,
char * buf) +const char * virSecretGetUsageID (virSecretPtr secret) +int virSecretGetUsageType (virSecretPtr secret) unsigned char * virSecretGetValue (virSecretPtr secret,
size_t * value_size,
unsigned int flags) char * virSecretGetXMLDesc (virSecretPtr secret,
unsigned int flags) -virSecretPtr virSecretLookupByUUIDString (virConnectPtr conn,
const char * uuid) +virSecretPtr virSecretLookupByUUID (virConnectPtr conn,
const unsigned char * uuid) +virSecretPtr virSecretLookupByUUIDString (virConnectPtr conn,
const char * uuidstr) +virSecretPtr virSecretLookupByUsage (virConnectPtr conn,
int usageType,
const char * usageID) int virSecretRef (virSecretPtr secret) int virSecretSetValue (virSecretPtr secret,
const unsigned char * value,
size_t value_size,
unsigned int flags) int virSecretUndefine (virSecretPtr secret) @@ -364,6 +370,8 @@ int virStorageVolRef (virSecret
struct virSecret{
The content of this structure is not made public by the API
 }
+

virSecretUsageType

enum virSecretUsageType {
+
VIR_SECRET_USAGE_TYPE_NONE = 0
VIR_SECRET_USAGE_TYPE_VOLUME = 1 : Expect more owner types later...
}

virSecurityLabel

struct virSecurityLabel{
The content of this structure is not made public by the API
 }
@@ -496,14 +504,14 @@ int	virStorageVolRef		(
iface:pointer to a defined interface
flags:and OR'ed set of extraction flags, not used yet
Returns:0 in case of success, -1 in case of error
virInterfaceDefineXML
virInterfacePtr	virInterfaceDefineXML	(virConnectPtr conn, 
					 const char * xml, 
					 unsigned int flags)

 
Define an interface (or modify existing interface configuration)
conn:pointer to the hypervisor connection
xml:the XML description for the interface, preferably in UTF-8
flags:and OR'ed set of extraction flags, not used yet
Returns:NULL in case of error, a pointer to the interface otherwise
virInterfaceDestroy
int	virInterfaceDestroy		(virInterfacePtr iface, 
					 unsigned int flags)

 
deactivate an interface (ie call "ifdown") This does not remove the interface from the config, and does not free the associated virInterfacePtr object.
iface:an interface object
flags:and OR'ed set of extraction flags, not used yet
Returns:0 in case of success and -1 in case of failure.
virInterfaceFree
int	virInterfaceFree		(virInterfacePtr iface)

-
Free the interface object. The interface itself is unaltered. The data structure is freed and should not be used thereafter.
iface:a interface object
Returns:0 in case of success and -1 in case of failure.
virInterfaceGetConnect
virConnectPtr	virInterfaceGetConnect	(virInterfacePtr iface)

-
Provides the connection pointer associated with an interface. 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 interface object together.
iface:pointer to a interface
Returns:the virConnectPtr or NULL in case of failure.
virInterfaceGetMACString
const char *	virInterfaceGetMACString	(virInterfacePtr iface)

-
Get the MAC for a interface as string. For more information about MAC see RFC4122.
iface:a interface object
Returns:a pointer to the MAC address (in null-terminated ASCII format) or NULL, the string need not be deallocated its lifetime will be the same as the interface object.
virInterfaceGetName
const char *	virInterfaceGetName	(virInterfacePtr iface)

-
Get the public name for that interface
iface:a interface object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the interface object.
virInterfaceGetXMLDesc
char *	virInterfaceGetXMLDesc		(virInterfacePtr iface, 
					 unsigned int flags)

-
Provide an XML description of the interface. The description may be reused later to recreate the interface with virInterfaceCreateXML().
iface:a interface 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.
virInterfaceLookupByMACString
virInterfacePtr	virInterfaceLookupByMACString	(virConnectPtr conn, 
						 const char * macstr)

+
Free the interface object. The interface itself is unaltered. The data structure is freed and should not be used thereafter.
iface:an interface object
Returns:0 in case of success and -1 in case of failure.
virInterfaceGetConnect
virConnectPtr	virInterfaceGetConnect	(virInterfacePtr iface)

+
Provides the connection pointer associated with an interface. 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 interface object together.
iface:pointer to an interface
Returns:the virConnectPtr or NULL in case of failure.
virInterfaceGetMACString
const char *	virInterfaceGetMACString	(virInterfacePtr iface)

+
Get the MAC for an interface as string. For more information about MAC see RFC4122.
iface:an interface object
Returns:a pointer to the MAC address (in null-terminated ASCII format) or NULL, the string need not be deallocated its lifetime will be the same as the interface object.
virInterfaceGetName
const char *	virInterfaceGetName	(virInterfacePtr iface)

+
Get the public name for that interface
iface:an interface object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the interface object.
virInterfaceGetXMLDesc
char *	virInterfaceGetXMLDesc		(virInterfacePtr iface, 
					 unsigned int flags)

+
Provide an XML description of the interface. The description may be reused later to redefine the interface with virInterfaceDefineXML().
iface:an interface object
flags:an 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.
virInterfaceLookupByMACString
virInterfacePtr	virInterfaceLookupByMACString	(virConnectPtr conn, 
						 const char * macstr)

 
Try to lookup an interface on the given hypervisor based on its MAC.
conn:pointer to the hypervisor connection
macstr:the MAC for the interface (null-terminated ASCII format)
Returns:a new interface object or NULL in case of failure. If the interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
virInterfaceLookupByName
virInterfacePtr	virInterfaceLookupByName	(virConnectPtr conn, 
						 const char * name)

 
Try to lookup an interface on the given hypervisor based on its name.
conn:pointer to the hypervisor connection
name:name for the interface
Returns:a new interface object or NULL in case of failure. If the interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
virInterfaceRef
int	virInterfaceRef			(virInterfacePtr iface)

-
Increment the reference count on the interface. For each additional call to this method, there shall be a corresponding call to virInterfaceFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a interface would increment the reference count.
iface:the interface to hold a reference on
Returns:0 in case of success, -1 in case of failure.
virInterfaceUndefine
int	virInterfaceUndefine		(virInterfacePtr iface)

+
Increment the reference count on the interface. For each additional call to this method, there shall be a corresponding call to virInterfaceFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using an interface would increment the reference count.
iface:the interface to hold a reference on
Returns:0 in case of success, -1 in case of failure.
virInterfaceUndefine
int	virInterfaceUndefine		(virInterfacePtr iface)

 
Undefine an interface, ie remove it from the config. This does not free the associated virInterfacePtr object.
iface:pointer to a defined interface
Returns:0 in case of success, -1 in case of error
virNetworkCreate
int	virNetworkCreate		(virNetworkPtr network)

 
Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.
network:pointer to a defined network
Returns:0 in case of success, -1 in case of error
virNetworkCreateXML
virNetworkPtr	virNetworkCreateXML	(virConnectPtr conn, 
					 const char * xmlDesc)

 
Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()
conn:pointer to the hypervisor connection
xmlDesc:an XML description of the network
Returns:a new network object or NULL in case of failure
virNetworkDefineXML
virNetworkPtr	virNetworkDefineXML	(virConnectPtr conn, 
					 const char * xml)

@@ -516,7 +524,7 @@ int	virStorageVolRef		(
network:a network object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.

virNetworkGetUUID

int	virNetworkGetUUID		(virNetworkPtr network, 
					 unsigned char * uuid)

Get the UUID for a network

network:a network object
uuid:pointer to a VIR_UUID_BUFLEN bytes array
Returns:-1 in case of error, 0 in case of success

virNetworkGetUUIDString

int	virNetworkGetUUIDString		(virNetworkPtr network, 
					 char * buf)

Get the UUID for a network as string. For more information about UUID see RFC4122.

network:a network object
buf:pointer to a VIR_UUID_STRING_BUFLEN bytes array
Returns:-1 in case of error, 0 in case of success

virNetworkGetXMLDesc

char *	virNetworkGetXMLDesc		(virNetworkPtr network, 
					 int flags)

-

Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().

network:a network 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.

virNetworkLookupByName

virNetworkPtr	virNetworkLookupByName	(virConnectPtr conn, 
					 const char * name)

+

Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().

network:a network object
flags:an 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.

virNetworkLookupByName

virNetworkPtr	virNetworkLookupByName	(virConnectPtr conn, 
					 const char * name)

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

conn:pointer to the hypervisor connection
name:name for the network
Returns:a new network object or NULL in case of failure. If the network cannot be found, then VIR_ERR_NO_NETWORK error is raised.

virNetworkLookupByUUID

virNetworkPtr	virNetworkLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)

Try to lookup a network on the given hypervisor based on its UUID.

conn:pointer to the hypervisor connection
uuid:the raw UUID for the network
Returns:a new network object or NULL in case of failure. If the network cannot be found, then VIR_ERR_NO_NETWORK error is raised.

virNetworkLookupByUUIDString

virNetworkPtr	virNetworkLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

Try to lookup a network on the given hypervisor based on its UUID.

conn:pointer to the hypervisor connection
uuidstr:the string UUID for the network
Returns:a new network object or NULL in case of failure. If the network cannot be found, then VIR_ERR_NO_NETWORK error is raised.

virNetworkRef

int	virNetworkRef			(virNetworkPtr network)

@@ -544,11 +552,16 @@ int	virStorageVolRef		(
conn:pointer to the hypervisor connection
cap:capability name
flags:flags (unused, pass 0)
Returns:the number of node devices or -1 in case of error
virSecretDefineXML
virSecretPtr	virSecretDefineXML	(virConnectPtr conn, 
					 const char * xml, 
					 unsigned int flags)

 
If XML specifies an UUID, locates the specified secret and replaces all attributes of the secret specified by UUID by attributes specified in xml (any attributes not specified in xml are discarded). Otherwise, creates a new secret with an automatically chosen UUID, and initializes its attributes from xml.
conn:virConnect connection
xml:XML describing the secret.
flags:flags, use 0 for now
Returns:a the secret on success, NULL on failure.
virSecretFree
int	virSecretFree			(virSecretPtr secret)

 
Release the secret handle. The underlying secret continues to exist.
secret:pointer to a secret
Returns:0 on success, or -1 on error
virSecretGetConnect
virConnectPtr	virSecretGetConnect	(virSecretPtr secret)

-
Provides the connection pointer associated with a secret. 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 secret object together.
secret:A virSecret secret
Returns:the virConnectPtr or NULL in case of failure.
virSecretGetUUIDString
char *	virSecretGetUUIDString		(virSecretPtr secret)

-
Fetches the UUID of the secret.
secret:A virSecret secret
Returns:ID of the secret (not necessarily in the UUID format) on success, NULL on failure. The caller must free() the ID.
virSecretGetValue
unsigned char *	virSecretGetValue	(virSecretPtr secret, 
					 size_t * value_size, 
					 unsigned int flags)

+
Provides the connection pointer associated with a secret. 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 secret object together.
secret:A virSecret secret
Returns:the virConnectPtr or NULL in case of failure.
virSecretGetUUID
int	virSecretGetUUID		(virSecretPtr secret, 
					 unsigned char * uuid)

+
Fetches the UUID of the secret.
secret:A virSecret secret
uuid:buffer of VIR_UUID_BUFLEN bytes in size
Returns:0 on success with the uuid buffer being filled, or -1 upon failure.
virSecretGetUUIDString
int	virSecretGetUUIDString		(virSecretPtr secret, 
					 char * buf)

+
Get the UUID for a secret as string. For more information about UUID see RFC4122.
secret:a secret object
buf:pointer to a VIR_UUID_STRING_BUFLEN bytes array
Returns:-1 in case of error, 0 in case of success
virSecretGetUsageID
const char *	virSecretGetUsageID	(virSecretPtr secret)

+
Get the unique identifier of the object with which this secret is to be used
secret:a secret object
Returns:a string identifying the object using the secret, or NULL upon error
virSecretGetUsageType
int	virSecretGetUsageType		(virSecretPtr secret)

+
Get the type of object which uses this secret
secret:a secret object
Returns:a positive integer identifying the type of object, or -1 upon error.
virSecretGetValue
unsigned char *	virSecretGetValue	(virSecretPtr secret, 
					 size_t * value_size, 
					 unsigned int flags)

 
Fetches the value of a secret.
secret:A virSecret connection
value_size:Place for storing size of the secret value
flags:flags, use 0 for now
Returns:the secret value on success, NULL on failure. The caller must free() the secret value.
virSecretGetXMLDesc
char *	virSecretGetXMLDesc		(virSecretPtr secret, 
					 unsigned int flags)

-
Fetches an XML document describing attributes of the secret.
secret:A virSecret secret
flags:flags, use 0 for now
Returns:the XML document on success, NULL on failure. The caller must free() the XML.
virSecretLookupByUUIDString
virSecretPtr	virSecretLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuid)

-
Fetches a secret based on uuid.
conn:virConnect connection
uuid:ID of a secret
Returns:the secret on success, or NULL on failure.
virSecretRef
int	virSecretRef			(virSecretPtr secret)

+
Fetches an XML document describing attributes of the secret.
secret:A virSecret secret
flags:flags, use 0 for now
Returns:the XML document on success, NULL on failure. The caller must free() the XML.
virSecretLookupByUUID
virSecretPtr	virSecretLookupByUUID	(virConnectPtr conn, 
					 const unsigned char * uuid)

+
Try to lookup a secret on the given hypervisor based on its UUID.
conn:pointer to the hypervisor connection
uuid:the raw UUID for the secret
Returns:a new secret object or NULL in case of failure. If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
virSecretLookupByUUIDString
virSecretPtr	virSecretLookupByUUIDString	(virConnectPtr conn, 
						 const char * uuidstr)

+
Try to lookup a secret on the given hypervisor based on its UUID.
conn:pointer to the hypervisor connection
uuidstr:the string UUID for the secret
Returns:a new secret object or NULL in case of failure. If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
virSecretLookupByUsage
virSecretPtr	virSecretLookupByUsage	(virConnectPtr conn, 
					 int usageType, 
					 const char * usageID)

+
Try to lookup a secret on the given hypervisor based on its usage
conn:pointer to the hypervisor connection
usageType:the type of secret usage
usageID:identifier of the object using the secret
Returns:a new secret object or NULL in case of failure. If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
virSecretRef
int	virSecretRef			(virSecretPtr secret)

 
Increment the reference count on the secret. For each additional call to this method, there shall be a corresponding call to virSecretFree to release the reference count, once the caller no longer needs the reference to this object. This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a secret would increment the reference count.
secret:the secret to hold a reference on
Returns:0 in case of success, -1 in case of failure.
virSecretSetValue
int	virSecretSetValue		(virSecretPtr secret, 
					 const unsigned char * value, 
					 size_t value_size, 
					 unsigned int flags)

 
Sets the value of a secret.
secret:A virSecret secret
value:Value of the secret
value_size:Size of the value
flags:flags, use 0 for now
Returns:0 on success, -1 on failure.
virSecretUndefine
int	virSecretUndefine		(virSecretPtr secret)

 
Deletes the specified secret. This does not free the associated virSecretPtr object.
secret:A virSecret secret
Returns:0 on success, -1 on failure.
virStoragePoolBuild
int	virStoragePoolBuild		(virStoragePoolPtr pool, 
					 unsigned int flags)

diff --git a/docs/html/libvirt-virterror.html b/docs/html/libvirt-virterror.html
index b4d74be847..aac55a047c 100644
--- a/docs/html/libvirt-virterror.html
+++ b/docs/html/libvirt-virterror.html
@@ -31,7 +31,7 @@ void	virSetErrorFunc			(void * userData, 

 
virErrorLevel
enum virErrorLevel {
 
VIR_ERR_NONE = 0
VIR_ERR_WARNING = 1 : A simple warning
VIR_ERR_ERROR = 2 : An error
}
 
virErrorNumber
enum virErrorNumber {
-
VIR_ERR_OK = 0
VIR_ERR_INTERNAL_ERROR = 1 : internal error
VIR_ERR_NO_MEMORY = 2 : memory allocation failure
VIR_ERR_NO_SUPPORT = 3 : no support for this function
VIR_ERR_UNKNOWN_HOST = 4 : could not resolve hostname
VIR_ERR_NO_CONNECT = 5 : can't connect to hypervisor
VIR_ERR_INVALID_CONN = 6 : invalid connection object
VIR_ERR_INVALID_DOMAIN = 7 : invalid domain object
VIR_ERR_INVALID_ARG = 8 : invalid function argument
VIR_ERR_OPERATION_FAILED = 9 : a command to hypervisor failed
VIR_ERR_GET_FAILED = 10 : a HTTP GET command to failed
VIR_ERR_POST_FAILED = 11 : a HTTP POST command to failed
VIR_ERR_HTTP_ERROR = 12 : unexpected HTTP error code
VIR_ERR_SEXPR_SERIAL = 13 : failure to serialize an S-Expr
VIR_ERR_NO_XEN = 14 : could not open Xen hypervisor control
VIR_ERR_XEN_CALL = 15 : failure doing an hypervisor call
VIR_ERR_OS_TYPE = 16 : unknown OS type
VIR_ERR_NO_KERNEL = 17 : missing kernel information
VIR_ERR_NO_ROOT = 18 : missing root device information
VIR_ERR_NO_SOURCE = 19 : missing source device information
VIR_ERR_NO_TARGET = 20 : missing target device information
VIR_ERR_NO_NAME = 21 : missing domain name information
VIR_ERR_NO_OS = 22 : missing domain OS information
VIR_ERR_NO_DEVICE = 23 : missing domain devices information
VIR_ERR_NO_XENSTORE = 24 : could not open Xen Store control
VIR_ERR_DRIVER_FULL = 25 : too many drivers registered
VIR_ERR_CALL_FAILED = 26 : not supported by the drivers (DEPRECATED)
VIR_ERR_XML_ERROR = 27 : an XML description is not well formed or broken
VIR_ERR_DOM_EXIST = 28 : the domain already exist
VIR_ERR_OPERATION_DENIED = 29 : operation forbidden on read-only connections
VIR_ERR_OPEN_FAILED = 30 : failed to open a conf file
VIR_ERR_READ_FAILED = 31 : failed to read a conf file
VIR_ERR_PARSE_FAILED = 32 : failed to parse a conf file
VIR_ERR_CONF_SYNTAX = 33 : failed to parse the syntax of a conf file
VIR_ERR_WRITE_FAILED = 34 : failed to write a conf file
VIR_ERR_XML_DETAIL = 35 : detail of an XML error
VIR_ERR_INVALID_NETWORK = 36 : invalid network object
VIR_ERR_NETWORK_EXIST = 37 : the network already exist
VIR_ERR_SYSTEM_ERROR = 38 : general system call failure
VIR_ERR_RPC = 39 : some sort of RPC error
VIR_ERR_GNUTLS_ERROR = 40 : error from a GNUTLS call
VIR_WAR_NO_NETWORK = 41 : failed to start network
VIR_ERR_NO_DOMAIN = 42 : domain not found or unexpectedly disappeared
VIR_ERR_NO_NETWORK = 43 : network not found
VIR_ERR_INVALID_MAC = 44 : invalid MAC address
VIR_ERR_AUTH_FAILED = 45 : authentication failed
VIR_ERR_INVALID_STORAGE_POOL = 46 : invalid storage pool object
VIR_ERR_INVALID_STORAGE_VOL = 47 : invalid storage vol object
VIR_WAR_NO_STORAGE = 48 : failed to start storage
VIR_ERR_NO_STORAGE_POOL = 49 : storage pool not found
VIR_ERR_NO_STORAGE_VOL = 50 : storage pool not found
VIR_WAR_NO_NODE = 51 : failed to start node driver
VIR_ERR_INVALID_NODE_DEVICE = 52 : invalid node device object
VIR_ERR_NO_NODE_DEVICE = 53 : node device not found
VIR_ERR_NO_SECURITY_MODEL = 54 : security model not found
VIR_ERR_OPERATION_INVALID = 55 : operation is not applicable at this time
VIR_WAR_NO_INTERFACE = 56 : failed to start interface driver
VIR_ERR_NO_INTERFACE = 57 : interface driver not running
VIR_ERR_INVALID_INTERFACE = 58 : invalid interface object
VIR_ERR_MULTIPLE_INTERFACES = 59 : more than one matching interface found
VIR_WAR_NO_SECRET = 60 : failed to start secret storage
VIR_ERR_INVALID_SECRET = 61 : invalid secret
}
+
VIR_ERR_OK = 0
VIR_ERR_INTERNAL_ERROR = 1 : internal error
VIR_ERR_NO_MEMORY = 2 : memory allocation failure
VIR_ERR_NO_SUPPORT = 3 : no support for this function
VIR_ERR_UNKNOWN_HOST = 4 : could not resolve hostname
VIR_ERR_NO_CONNECT = 5 : can't connect to hypervisor
VIR_ERR_INVALID_CONN = 6 : invalid connection object
VIR_ERR_INVALID_DOMAIN = 7 : invalid domain object
VIR_ERR_INVALID_ARG = 8 : invalid function argument
VIR_ERR_OPERATION_FAILED = 9 : a command to hypervisor failed
VIR_ERR_GET_FAILED = 10 : a HTTP GET command to failed
VIR_ERR_POST_FAILED = 11 : a HTTP POST command to failed
VIR_ERR_HTTP_ERROR = 12 : unexpected HTTP error code
VIR_ERR_SEXPR_SERIAL = 13 : failure to serialize an S-Expr
VIR_ERR_NO_XEN = 14 : could not open Xen hypervisor control
VIR_ERR_XEN_CALL = 15 : failure doing an hypervisor call
VIR_ERR_OS_TYPE = 16 : unknown OS type
VIR_ERR_NO_KERNEL = 17 : missing kernel information
VIR_ERR_NO_ROOT = 18 : missing root device information
VIR_ERR_NO_SOURCE = 19 : missing source device information
VIR_ERR_NO_TARGET = 20 : missing target device information
VIR_ERR_NO_NAME = 21 : missing domain name information
VIR_ERR_NO_OS = 22 : missing domain OS information
VIR_ERR_NO_DEVICE = 23 : missing domain devices information
VIR_ERR_NO_XENSTORE = 24 : could not open Xen Store control
VIR_ERR_DRIVER_FULL = 25 : too many drivers registered
VIR_ERR_CALL_FAILED = 26 : not supported by the drivers (DEPRECATED)
VIR_ERR_XML_ERROR = 27 : an XML description is not well formed or broken
VIR_ERR_DOM_EXIST = 28 : the domain already exist
VIR_ERR_OPERATION_DENIED = 29 : operation forbidden on read-only connections
VIR_ERR_OPEN_FAILED = 30 : failed to open a conf file
VIR_ERR_READ_FAILED = 31 : failed to read a conf file
VIR_ERR_PARSE_FAILED = 32 : failed to parse a conf file
VIR_ERR_CONF_SYNTAX = 33 : failed to parse the syntax of a conf file
VIR_ERR_WRITE_FAILED = 34 : failed to write a conf file
VIR_ERR_XML_DETAIL = 35 : detail of an XML error
VIR_ERR_INVALID_NETWORK = 36 : invalid network object
VIR_ERR_NETWORK_EXIST = 37 : the network already exist
VIR_ERR_SYSTEM_ERROR = 38 : general system call failure
VIR_ERR_RPC = 39 : some sort of RPC error
VIR_ERR_GNUTLS_ERROR = 40 : error from a GNUTLS call
VIR_WAR_NO_NETWORK = 41 : failed to start network
VIR_ERR_NO_DOMAIN = 42 : domain not found or unexpectedly disappeared
VIR_ERR_NO_NETWORK = 43 : network not found
VIR_ERR_INVALID_MAC = 44 : invalid MAC address
VIR_ERR_AUTH_FAILED = 45 : authentication failed
VIR_ERR_INVALID_STORAGE_POOL = 46 : invalid storage pool object
VIR_ERR_INVALID_STORAGE_VOL = 47 : invalid storage vol object
VIR_WAR_NO_STORAGE = 48 : failed to start storage
VIR_ERR_NO_STORAGE_POOL = 49 : storage pool not found
VIR_ERR_NO_STORAGE_VOL = 50 : storage pool not found
VIR_WAR_NO_NODE = 51 : failed to start node driver
VIR_ERR_INVALID_NODE_DEVICE = 52 : invalid node device object
VIR_ERR_NO_NODE_DEVICE = 53 : node device not found
VIR_ERR_NO_SECURITY_MODEL = 54 : security model not found
VIR_ERR_OPERATION_INVALID = 55 : operation is not applicable at this time
VIR_WAR_NO_INTERFACE = 56 : failed to start interface driver
VIR_ERR_NO_INTERFACE = 57 : interface driver not running
VIR_ERR_INVALID_INTERFACE = 58 : invalid interface object
VIR_ERR_MULTIPLE_INTERFACES = 59 : more than one matching interface found
VIR_WAR_NO_SECRET = 60 : failed to start secret storage
VIR_ERR_INVALID_SECRET = 61 : invalid secret
VIR_ERR_NO_SECRET = 62 : secret not found
}
 
Functions
virConnCopyLastError
int	virConnCopyLastError		(virConnectPtr conn, 
					 virErrorPtr to)

 
Copy the content of the last error caught on that connection This method is not protected against access from multiple threads. In a multi-threaded application, always use the global virGetLastError() API which is backed by thread local storage. If the connection object was discovered to be invalid by an API call, then the error will be reported against the global error object. Since 0.6.0, all errors reported in the per-connection object are also duplicated in the global error object. As such an application can always use virGetLastError(). This method remains for backwards compatability. One will need to free the result with virResetError()
conn:pointer to the hypervisor connection
to:target to receive the copy
Returns:0 if no error was found and the error code otherwise and -1 in case of parameter error.
virConnGetLastError
virErrorPtr	virConnGetLastError	(virConnectPtr conn)

 
Provide a pointer to the last error caught on that connection This method is not protected against access from multiple threads. In a multi-threaded application, always use the global virGetLastError() API which is backed by thread local storage. If the connection object was discovered to be invalid by an API call, then the error will be reported against the global error object. Since 0.6.0, all errors reported in the per-connection object are also duplicated in the global error object. As such an application can always use virGetLastError(). This method remains for backwards compatability.
conn:pointer to the hypervisor connection
Returns:a pointer to the last error or NULL if none occurred.
virConnResetLastError
void	virConnResetLastError		(virConnectPtr conn)

diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index ceca3ff1a8..4fc976f96f 100644
--- a/docs/libvirt-api.xml
+++ b/docs/libvirt-api.xml
@@ -45,6 +45,7 @@
      
      
      
+     
      
      
      
@@ -68,6 +69,7 @@
      
      
      
+     
      
      
      
@@ -152,6 +154,7 @@
      
      
      
+     
      
      
      
@@ -199,6 +202,7 @@
      
      
      
+     
      
      
      
@@ -213,9 +217,10 @@
      
      
      
+     
      
      
-     
+     
      
      
      
@@ -254,11 +259,13 @@
      
      
      
+     
      
      
      
      
      
+     
      
      
      
@@ -269,6 +276,7 @@
      
      
      
+     
      
      
      
@@ -304,7 +312,7 @@
      
      
      
-     
+     
      
      
      
@@ -376,6 +384,7 @@
      
      
      
+     
      
      
      
@@ -424,7 +433,6 @@
      
      
      
-     
      
      
      
@@ -434,12 +442,13 @@
      
      
      
-     
+     
      
      
      
      
      
+     
      
      
      
@@ -604,7 +613,7 @@
     
     
     
-    
+    
     
     
     
@@ -621,6 +630,7 @@
     
     
     
+    
     
     
     
@@ -685,6 +695,8 @@
     
     
     
+    
+    
     
     
     
@@ -834,6 +846,7 @@ see note above'/>
     
     
     
+    
     
     
       a virSecurityLabelPtr is a pointer to a virSecurityLabel.
@@ -1540,28 +1553,28 @@ see note above'/>
     
       Free the interface object. The interface itself is unaltered. The data structure is freed and should not be used thereafter.
       
-      
+      
     
     
       Provides the connection pointer associated with an interface.  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 interface object together.
       
-      
+      
     
     
-      Get the MAC for a interface as string. For more information about MAC see RFC4122.
+      Get the MAC for an interface as string. For more information about MAC see RFC4122.
       
-      
+      
     
     
       Get the public name for that interface
       
-      
+      
     
     
-      Provide an XML description of the interface. The description may be reused later to recreate the interface with virInterfaceCreateXML().
+      Provide an XML description of the interface. The description may be reused later to redefine the interface with virInterfaceDefineXML().
       
-      
-      
+      
+      
     
     
       Try to lookup an interface on the given hypervisor based on its MAC.
@@ -1576,7 +1589,7 @@ see note above'/>
       
     
     
-      Increment the reference count on the interface. For each additional call to this method, there shall be a corresponding call to virInterfaceFree to release the reference count, once the caller no longer needs the reference to this object.  This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a interface would increment the reference count.
+      Increment the reference count on the interface. For each additional call to this method, there shall be a corresponding call to virInterfaceFree to release the reference count, once the caller no longer needs the reference to this object.  This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using an interface would increment the reference count.
       
       
     
@@ -1649,7 +1662,7 @@ see note above'/>
       Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().
       
       
-      
+      
     
     
       Try to lookup a network on the given hypervisor based on its name.
@@ -1827,10 +1840,27 @@ see note above'/>
       
       
     
-    
+    
       Fetches the UUID of the secret.
-      
+      
       
+      
+    
+    
+      Get the UUID for a secret as string. For more information about UUID see RFC4122.
+      
+      
+      
+    
+    
+      Get the unique identifier of the object with which this secret is to be used
+      
+      
+    
+    
+      Get the type of object which uses this secret
+      
+      
     
     
       Fetches the value of a secret.
@@ -1845,11 +1875,24 @@ see note above'/>
       
       
     
+    
+      Try to lookup a secret on the given hypervisor based on its UUID.
+      
+      
+      
+    
     
-      Fetches a secret based on uuid.
-      
-      
-      
+      Try to lookup a secret on the given hypervisor based on its UUID.
+      
+      
+      
+    
+    
+      Try to lookup a secret on the given hypervisor based on its usage
+      
+      
+      
+      
     
     
       Increment the reference count on the secret. For each additional call to this method, there shall be a corresponding call to virSecretFree to release the reference count, once the caller no longer needs the reference to this object.  This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a secret would increment the reference count.
diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml
index 1c2f858e6d..058e3bb0ff 100644
--- a/docs/libvirt-refs.xml
+++ b/docs/libvirt-refs.xml
@@ -88,6 +88,7 @@
     
     
     
+    
     
     
     
@@ -154,6 +155,8 @@
     
     
     
+    
+    
     
     
     
@@ -401,14 +404,20 @@
     
     
     
+    
     
+    
+    
     
     
+    
     
+    
     
     
     
     
+    
     
     
     
@@ -560,6 +569,7 @@
       
       
       
+      
       
       
       
@@ -626,6 +636,8 @@
       
       
       
+      
+      
       
       
       
@@ -877,14 +889,20 @@
       
       
       
+      
       
+      
+      
       
       
+      
       
+      
       
       
       
       
+      
       
       
       
@@ -1003,7 +1021,9 @@
     
     
       
+      
       
+      
     
     
       
@@ -1040,6 +1060,7 @@
     
       
       
+      
       
       
     
@@ -1066,6 +1087,7 @@
       
       
       
+      
       
     
     
@@ -1193,7 +1215,9 @@
       
       
       
+      
       
+      
       
       
       
@@ -1343,7 +1367,10 @@
     
       
       
+      
       
+      
+      
       
       
       
@@ -1481,6 +1508,8 @@
       
       
       
+      
+      
       
       
       
@@ -1705,14 +1734,20 @@
       
       
       
+      
       
+      
+      
       
       
+      
       
+      
       
       
       
       
+      
       
       
       
@@ -1807,6 +1842,7 @@
       
       
       
+      
       
       
       
@@ -2151,10 +2187,9 @@
           
         
         
-          
+          
           
           
-          
           
           
         
@@ -2174,6 +2209,7 @@
           
           
           
+          
           
           
           
@@ -2205,6 +2241,9 @@
           
           
           
+          
+          
+          
           
         
       
@@ -2223,6 +2262,8 @@
           
         
       
+    
+    
       
         
           
@@ -2256,8 +2297,6 @@
           
         
       
-    
-    
       
         
           
@@ -2461,6 +2500,7 @@
           
           
           
+          
         
         
           
@@ -2589,6 +2629,9 @@
           
           
           
+          
+          
+          
         
         
           
@@ -2632,7 +2675,10 @@
           
           
           
+          
           
+          
+          
         
         
           
@@ -2654,6 +2700,8 @@
           
         
       
+    
+    
       
         
           
@@ -2676,6 +2724,11 @@
           
           
         
+        
+          
+          
+          
+        
         
           
         
@@ -2688,19 +2741,19 @@
         
           
           
+          
           
         
         
           
           
+          
           
         
         
           
         
       
-    
-    
       
         
           
@@ -2745,6 +2798,7 @@
           
           
           
+          
           
           
         
@@ -3101,7 +3155,9 @@
           
           
           
+          
           
+          
           
           
           
@@ -3130,6 +3186,7 @@
           
           
           
+          
         
         
           
@@ -3203,6 +3260,7 @@
           
           
           
+          
           
           
         
@@ -3264,7 +3322,6 @@
           
           
           
-          
           
           
           
@@ -3320,6 +3377,9 @@
           
           
           
+          
+          
+          
         
         
           
@@ -4151,6 +4211,7 @@
           
           
           
+          
         
         
           
@@ -4195,7 +4256,6 @@
           
           
           
-          
           
         
         
@@ -4309,6 +4369,9 @@
           
           
           
+          
+          
+          
         
         
           
@@ -4473,6 +4536,14 @@
         
           
         
+        
+          
+          
+        
+        
+          
+          
+        
         
           
           
@@ -4573,6 +4644,7 @@
           
           
           
+          
           
           
           
@@ -4622,6 +4694,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -4664,36 +4739,6 @@
         
           
         
-        
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
         
           
           
@@ -4959,6 +5004,9 @@
           
           
           
+          
+          
+          
         
         
           
@@ -5140,6 +5188,7 @@
           
           
           
+          
         
         
           
@@ -5192,7 +5241,6 @@
           
           
           
-          
           
           
         
@@ -5225,9 +5273,6 @@
           
           
         
-        
-          
-        
         
           
           
@@ -5644,6 +5689,9 @@
         
           
         
+        
+          
+        
         
           
         
@@ -5769,11 +5817,15 @@
           
           
           
+          
+          
+          
           
         
         
           
           
+          
         
         
           
@@ -5808,7 +5860,7 @@
           
           
         
-        
+        
           
         
         
@@ -6158,6 +6210,7 @@
           
           
           
+          
         
         
           
@@ -6572,6 +6625,9 @@
           
           
           
+          
+          
+          
         
         
           
@@ -6695,6 +6751,8 @@
           
           
           
+          
+          
         
         
           
@@ -6745,6 +6803,7 @@
         
         
           
+          
           
           
           
@@ -6808,6 +6867,9 @@
         
         
           
+          
+          
+          
           
         
         
@@ -6830,6 +6892,7 @@
           
         
         
+          
           
         
         
@@ -6895,6 +6958,7 @@
         
         
           
+          
         
         
           
@@ -6904,6 +6968,8 @@
           
           
           
+          
+          
           
           
           
@@ -6913,7 +6979,7 @@
           
         
         
-          
+          
         
         
           
@@ -6959,7 +7025,6 @@
           
           
           
-          
         
         
           
@@ -7083,7 +7148,7 @@
           
           
         
-        
+        
           
         
         
@@ -7127,7 +7192,7 @@
         
         
           
-          
+          
           
           
           
@@ -7403,9 +7468,9 @@
       
     
     
-      
-      
-      
+      
+      
+