NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

api: Reword objects exposed section

Browse Source
This commit is contained in:
John Ferlan 2013-02-12 12:48:46 -05:00
parent b421c35c98
commit b8a0b631dc
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/api.html.in
View File

@ -8,26 +8,28 @@
<ul id="toc"></ul> <ul id="toc"></ul>
<h2><a name="Objects">Objects exposed</a></h2> <h2><a name="Objects">Objects Exposed</a></h2>
<p> As defined in the <a href="goals.html">goals section</a>, libvirt <p> As defined in the <a href="goals.html">goals section</a>, the libvirt
API need to expose all the resources needed to manage the virtualization API is designed to expose all the resources needed to manage the
support of recent operating systems. The first object manipulated though virtualization support of recent operating systems. The first object
the API is <code>virConnectPtr</code> which represent a connection to manipulated through the API is the <code>virConnectPtr</code>, which
an hypervisor. Any application using libvirt is likely to start using the represents the connection to a hypervisor. Any application using libvirt
is likely to start using the
API by calling one of <a href="html/libvirt-libvirt.html#virConnectOpen" API by calling one of <a href="html/libvirt-libvirt.html#virConnectOpen"
>the virConnectOpen functions</a>. You will note that those functions take >the virConnectOpen functions</a>. You will note that those functions take
a name argument which is actually an URI to select the right hypervisor to a name argument which is actually a <a href="uri.html">connection URI</a>
open, this is needed to allow remote connections and also select between to select the right hypervisor to open.
different possible hypervisors (for example on a Linux system it may be A URI is needed to allow remote connections and also select between
possible to use both KVM and LinuxContainers on the same node). A NULL different possible hypervisors. For example, on a Linux system it may be
name will default to a preselected hypervisor but it's probably not a possible to use both KVM and LinuxContainers on the same node. A NULL
name will default to a preselected hypervisor, but it's probably not a
wise thing to do in most cases. See the <a href="uri.html">connection wise thing to do in most cases. See the <a href="uri.html">connection
URI</a> page for a full descriptions of the values allowed.</p> URI</a> page for a full descriptions of the values allowed.</p>
<p> Once the application obtained a <code class='docref'>virConnectPtr</code> <p> Once the application obtains a <code class='docref'>virConnectPtr</code>
connection to the connection to the hypervisor it can then use it to manage the hypervisor's
hypervisor it can then use it to manage domains and related resources available domains and related virtualization
available for virtualization like storage and networking. All those are resources, such as storage and networking. All those are
exposed as first class objects, and connected to the hypervisor connection exposed as first class objects and connected to the hypervisor connection
(and the node or cluster where it is available).</p> (and the node or cluster where it is available).</p>
<p class="image"> <p class="image">
<img alt="first class objects exposed by the API" <img alt="first class objects exposed by the API"