diff --git a/docs/api.html.in b/docs/api.html.in index 0f01aed86ed81167dde1c2b0ca5840b16e22571b..09fe4f05d5fde7df5c5cd029493deae917ca5c72 100644 --- a/docs/api.html.in +++ b/docs/api.html.in @@ -37,43 +37,56 @@
The figure above shows the five main objects exported by the API:
virConnectListDomains
- allows to list all the IDs for the domains active on this hypervisor.virConnectListNetworks
- allows to list all the virtualization networks activated on this node.virConnectPtr
+ Represents the connection to a hypervisor. Use one of the + virConnectOpen + functions to obtain connection to the hypervisor which is then used + as a parameter to other connection API's.
virDomainPtr
+ Represents one domain either active or defined (i.e. existing as
+ permanent config file and storage but not currently running on that
+ node). The function virConnectListAllDomains
+ lists all the domains for the hypervisor.
virNetworkPtr
+ Represents one network either active or defined (i.e. existing
+ as permanent config file and storage but not currently activated).
+ The function virConnectListAllNetworks
+ lists all the virtualization networks for the hypervisor.
virStorageVolPtr
+ Represents one storage volume generally used
as a block device available to one of the domains. The function
- virStorageVolLookupByPath
allows to find
- the object based on its path on the node.
virStoragePoolLookupByVolume
allows to find
- the storage pool containing a given storage volume.virStorageVolLookupByPath
finds
+ the storage volume object based on its path on the node.
+ virStoragePoolPtr
+ Represents a storage pool, which is a logical area
+ used to allocate and store storage volumes. The function
+ virConnectListAllStoragePools
lists
+ all of the virtualization storage pools on the hypervisor. The function
+ virStoragePoolLookupByVolume
finds
+ the storage pool containing a given storage volume.
Most object manipulated by the library can also be represented using +
Most objects manipulated by the library can also be represented using XML descriptions. This is used primarily to create those object, but is also helpful to modify or save their description back.
- Domains, network and storage pools can be either active
+
Domains, networks, and storage pools can be either active
i.e. either running or available for immediate use, or
defined
in which case they are inactive but there is
a permanent definition available in the system for them. Based on this
- thay can be activated dynamically in order to be used.
Most kind of object can also be named in various ways:
+ they can be activated dynamically in order to be used. +Most objects can also be named in various ways:
name
, an user friendly identifier but
- whose unicity cannot be guaranteed between two nodes.ID
, which is a runtime unique identifier
- provided by the hypervisor for one given activation of the object,
- but it becomes invalid once the resource is deactivated.UUID
, a 16 bytes unique identifier
+ name
+ A user friendly identifier but whose uniqueness + cannot be guaranteed between two nodes.
ID
+ A runtime unique identifier + provided by the hypervisor for one given activation of the object; + however, it becomes invalid once the resource is deactivated.
UUID
+ A 16 byte unique identifier as defined in RFC 4122, which is guaranteed to be unique for long term usage and across a - set of nodes.