@@ -656,7 +656,7 @@ The content of this structure is not made public by the API.
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><spanclass="term"><i><tt>auth</tt></i>:</span></td><td>Authenticate callback parameters</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>Open flags</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div></div>
</pre><p>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p>
</pre><p>This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div></div>
@@ -676,7 +676,7 @@ The content of this structure is not made public by the API.
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div></div>
</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires riviledged access to the hypervisor.</p>
</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xmlDesc</tt></i>:</span></td><td>an XML description of the domain</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div></div>
@@ -917,19 +917,19 @@ The content of this structure is not made public by the API.
<hr/>
<divclass="refsect2"lang="en"><h3><aname="virStoragePoolBuild"/>virStoragePoolBuild ()</h3><preclass="programlisting">int virStoragePoolBuild (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Build the underlying storage pool</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div></div>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div></div>
<hr/>
<divclass="refsect2"lang="en"><h3><aname="virStoragePoolCreate"/>virStoragePoolCreate ()</h3><preclass="programlisting">int virStoragePoolCreate (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Starts an inactive storage pool</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div></div>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div></div>
</pre><p>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
</pre><p>Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
</pre><p>Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
<hr/>
<divclass="refsect2"lang="en"><h3><aname="virStoragePoolDelete"/>virStoragePoolDelete ()</h3><preclass="programlisting">int virStoragePoolDelete (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p>
...
...
@@ -969,7 +969,7 @@ The content of this structure is not made public by the API.
<hr/>
<divclass="refsect2"lang="en"><h3><aname="virStoragePoolGetXMLDesc"/>virStoragePoolGetXMLDesc ()</h3><preclass="programlisting">char * virStoragePoolGetXMLDesc (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <ahref="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (unused, pass 0)</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div></div>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (set of virDomainXMLFlags)</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div></div>
<hr/>
<divclass="refsect2"lang="en"><h3><aname="virStoragePoolListVolumes"/>virStoragePoolListVolumes ()</h3><preclass="programlisting">int virStoragePoolListVolumes (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> char ** const names, <br/> int maxnames)<br/>
</pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p>
...
...
@@ -1013,7 +1013,7 @@ The content of this structure is not made public by the API.
<hr/>
<divclass="refsect2"lang="en"><h3><aname="virStorageVolDelete"/>virStorageVolDelete ()</h3><preclass="programlisting">int virStorageVolDelete (<ahref="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/> unsigned int flags)<br/>
</pre><p>Delete the storage volume from the pool</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div></div>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div></div>
@@ -519,13 +519,13 @@ int virConnectAuthCallbackPtr (<a href="libvirt-libvirt.html#virConnectCredentia
</pre><p>Extract hardware information about the node.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <ahref="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> structure allocated by the user</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><aname="virStoragePoolBuild"id="virStoragePoolBuild"></a>Function: virStoragePoolBuild</h3><preclass="programlisting">int virStoragePoolBuild (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Build the underlying storage pool</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div><h3><aname="virStoragePoolCreate"id="virStoragePoolCreate"></a>Function: virStoragePoolCreate</h3><preclass="programlisting">int virStoragePoolCreate (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div><h3><aname="virStoragePoolCreate"id="virStoragePoolCreate"></a>Function: virStoragePoolCreate</h3><preclass="programlisting">int virStoragePoolCreate (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Starts an inactive storage pool</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div><h3><aname="virStoragePoolCreateXML"id="virStoragePoolCreateXML"></a>Function: virStoragePoolCreateXML</h3><preclass="programlisting"><ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolCreateXML (<ahref="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * xmlDesc, <br/> unsigned int flags)<br/>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div><h3><aname="virStoragePoolCreateXML"id="virStoragePoolCreateXML"></a>Function: virStoragePoolCreateXML</h3><preclass="programlisting"><ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolCreateXML (<ahref="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * xmlDesc, <br/> unsigned int flags)<br/>
</pre><p>Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><aname="virStoragePoolDefineXML"id="virStoragePoolDefineXML"></a>Function: virStoragePoolDefineXML</h3><preclass="programlisting"><ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolDefineXML (<ahref="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * xml, <br/> unsigned int flags)<br/>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><aname="virStoragePoolDefineXML"id="virStoragePoolDefineXML"></a>Function: virStoragePoolDefineXML</h3><preclass="programlisting"><ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolDefineXML (<ahref="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * xml, <br/> unsigned int flags)<br/>
</pre><p>Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><aname="virStoragePoolDelete"id="virStoragePoolDelete"></a>Function: virStoragePoolDelete</h3><preclass="programlisting">int virStoragePoolDelete (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><spanclass="term"><i><tt>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><aname="virStoragePoolDelete"id="virStoragePoolDelete"></a>Function: virStoragePoolDelete</h3><preclass="programlisting">int virStoragePoolDelete (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>flags for obliteration process</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be obliterate</td></tr></tbody></table></div><h3><aname="virStoragePoolDestroy"id="virStoragePoolDestroy"></a>Function: virStoragePoolDestroy</h3><preclass="programlisting">int virStoragePoolDestroy (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br/>
</pre><p>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated <ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object.</p>
...
...
@@ -545,7 +545,7 @@ int virConnectAuthCallbackPtr (<a href="libvirt-libvirt.html#virConnectCredentia
</pre><p>Fetch the globally unique ID of the storage pool as a string</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>buf</tt></i>:</span></td><td>buffer of <ahref="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes in size</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><aname="virStoragePoolGetXMLDesc"id="virStoragePoolGetXMLDesc"></a>Function: virStoragePoolGetXMLDesc</h3><preclass="programlisting">char * virStoragePoolGetXMLDesc (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> unsigned int flags)<br/>
</pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <ahref="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (unused, pass 0)</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div><h3><aname="virStoragePoolListVolumes"id="virStoragePoolListVolumes"></a>Function: virStoragePoolListVolumes</h3><preclass="programlisting">int virStoragePoolListVolumes (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> char ** const names, <br/> int maxnames)<br/>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (set of virDomainXMLFlags)</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div><h3><aname="virStoragePoolListVolumes"id="virStoragePoolListVolumes"></a>Function: virStoragePoolListVolumes</h3><preclass="programlisting">int virStoragePoolListVolumes (<ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/> char ** const names, <br/> int maxnames)<br/>
</pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>names</tt></i>:</span></td><td>array in which to storage volume names</td></tr><tr><td><spanclass="term"><i><tt>maxnames</tt></i>:</span></td><td>size of names array</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names fetched, or -1 on error</td></tr></tbody></table></div><h3><aname="virStoragePoolLookupByName"id="virStoragePoolLookupByName"></a>Function: virStoragePoolLookupByName</h3><preclass="programlisting"><ahref="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> virStoragePoolLookupByName (<ahref="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * name)<br/>
</pre><p>Fetch a storage pool based on its unique name</p>
...
...
@@ -567,7 +567,7 @@ int virConnectAuthCallbackPtr (<a href="libvirt-libvirt.html#virConnectCredentia
</pre><p>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><spanclass="term"><i><tt>xmldesc</tt></i>:</span></td><td>description of volume to create</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>flags for creation (unused, pass 0)</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume, or NULL on error</td></tr></tbody></table></div><h3><aname="virStorageVolDelete"id="virStorageVolDelete"></a>Function: virStorageVolDelete</h3><preclass="programlisting">int virStorageVolDelete (<ahref="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/> unsigned int flags)<br/>
</pre><p>Delete the storage volume from the pool</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><aname="virStorageVolFree"id="virStorageVolFree"></a>Function: virStorageVolFree</h3><preclass="programlisting">int virStorageVolFree (<ahref="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><spanclass="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><aname="virStorageVolFree"id="virStorageVolFree"></a>Function: virStorageVolFree</h3><preclass="programlisting">int virStorageVolFree (<ahref="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>
</pre><p>Release the storage volume handle. The underlying storage volume contains to exist</p>
<divclass="variablelist"><tableborder="0"><colalign="left"/><tbody><tr><td><spanclass="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><spanclass="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><aname="virStorageVolGetConnect"id="virStorageVolGetConnect"></a>Function: virStorageVolGetConnect</h3><preclass="programlisting"><ahref="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> virStorageVolGetConnect (<ahref="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>
</pre><p>Provides the connection pointer associated with a storage volume. 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 volume object together.</p>
<info>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</info>
<info>This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</info>
<returntype='virConnectPtr'info='a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html'/>
<argname='name'type='const char *'info='URI of the hypervisor'/>
</function>
...
...
@@ -831,7 +831,7 @@
<argname='domain'type='virDomainPtr'info='pointer to a defined domain'/>
<info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires riviledged access to the hypervisor.</info>
<info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</info>
<returntype='virDomainPtr'info='a new domain object or NULL in case of failure'/>
<argname='conn'type='virConnectPtr'info='pointer to the hypervisor connection'/>
<argname='xmlDesc'type='const char *'info='an XML description of the domain'/>
...
...
@@ -1214,27 +1214,27 @@
<info>Build the underlying storage pool</info>
<returntype='int'info='0 on success, or -1 upon failure'/>
<argname='pool'type='virStoragePoolPtr'info='pointer to storage pool'/>
<argname='flags'type='unsigned int'info=''/>
<argname='flags'type='unsigned int'info='future flags, use 0 for now'/>
<info>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</info>
<info>Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted</info>
<returntype='virStoragePoolPtr'info='a virStoragePoolPtr object, or NULL if creation failed'/>
<argname='conn'type='virConnectPtr'info='pointer to hypervisor connection'/>
<argname='xmlDesc'type='const char *'info='XML description for new pool'/>
<argname='flags'type='unsigned int'info=''/>
<argname='flags'type='unsigned int'info='future flags, use 0 for now'/>
<info>Delete the underlying pool resources. This is a non-recoverable operation. The virStoragePoolPtr object itself is not free'd.</info>
...
...
@@ -1290,7 +1290,7 @@
<info>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the virStoragePoolCreateXML method.</info>
<returntype='char *'info='a XML document, or NULL on error'/>
<argname='pool'type='virStoragePoolPtr'info='pointer to storage pool'/>
<argname='flags'type='unsigned int'info='flags for XML format options (unused, pass 0)'/>
<argname='flags'type='unsigned int'info='flags for XML format options (set of virDomainXMLFlags)'/>