diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html
index e3e91aa08c8ee7c01af0137bb6d3a91eab557e86..4cabeb94c5d7e2848ea0b209940bd3c15e4781f6 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.
+
+
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.
- 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 28e184ef7ff67d354fc622a14b9d33fec28bf313..686522429e274fb588f63e3e7bcdabe58b9e738d 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 5772fbef43962f178e64d00094597b0d419e5686..0f2cb8aa3efe5ea58aca2637b7b7dead6f2a55dd 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 |
}
+
enum virSecretUsageType {
+
}
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 |
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 |
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. |
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. |
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. |
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. |
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. |
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 |
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. |
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 |
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.
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. |
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.
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. |
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 |
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 |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
int virStoragePoolBuild (virStoragePoolPtr pool,
unsigned int flags)
diff --git a/docs/html/libvirt-virterror.html b/docs/html/libvirt-virterror.html
index b4d74be84753689c40212386aea9380a8c6f8c3a..aac55a047cb4de60911a3e3e33f5f0cace9f4bd3 100644
--- a/docs/html/libvirt-virterror.html
+++ b/docs/html/libvirt-virterror.html
@@ -31,7 +31,7 @@ void virSetErrorFunc (void * userData,
enum virErrorNumber {
-
}
+
}
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. |
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. |
void virConnResetLastError (virConnectPtr conn)
diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml
index ceca3ff1a8c1aa45c91d2943e07a6d6a13d85d97..4fc976f96f4f771ebf6f7a3051f5687086d09e1a 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 1c2f858e6defe15219e9934672e26e5050a7ccb9..058e3bb0ff2d0e4998817d843749c66585bd1be5 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 @@
-
-
-
+
+
+