<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Libvirt.Network.html">
<link rel="next" href="Libvirt.Volume.html">
<link rel="Up" href="Libvirt.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Libvirt" rel="Chapter" href="Libvirt.html">
<link title="Libvirt_version" rel="Chapter" href="Libvirt_version.html"><title>Libvirt.Pool</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Libvirt.Network.html" title="Libvirt.Network">Previous</a>
<a class="up" href="Libvirt.html" title="Libvirt">Up</a>
<a class="post" href="Libvirt.Volume.html" title="Libvirt.Volume">Next</a>
</div>
<h1>Module <a href="type_Libvirt.Pool.html">Libvirt.Pool</a></h1>
<pre><span class="keyword">module</span> Pool: <code class="code">sig</code> <a href="Libvirt.Pool.html">..</a> <code class="code">end</code></pre><div class="info">
Module dealing with storage pools.<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'rw</code> t</span> </pre>
<div class="info">
Storage pool handle.<br>
</div>
<pre><code><span id="TYPEpool_state"><span class="keyword">type</span> <code class="type"></code>pool_state</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_state.Inactive"><span class="constructor">Inactive</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_state.Building"><span class="constructor">Building</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_state.Running"><span class="constructor">Running</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_state.Degraded"><span class="constructor">Degraded</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >State of the storage pool.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><code><span id="TYPEpool_build_flags"><span class="keyword">type</span> <code class="type"></code>pool_build_flags</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_build_flags.New"><span class="constructor">New</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_build_flags.Repair"><span class="constructor">Repair</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_build_flags.Resize"><span class="constructor">Resize</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Flags for creating a storage pool.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><code><span id="TYPEpool_delete_flags"><span class="keyword">type</span> <code class="type"></code>pool_delete_flags</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_delete_flags.Normal"><span class="constructor">Normal</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_delete_flags.Zeroed"><span class="constructor">Zeroed</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Flags for deleting a storage pool.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><code><span id="TYPEpool_info"><span class="keyword">type</span> <code class="type"></code>pool_info</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_info.state">state</span> :<code class="type"><a href="Libvirt.Pool.html#TYPEpool_state">pool_state</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Pool state.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_info.capacity">capacity</span> :<code class="type">int64</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Logical size in bytes.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_info.allocation">allocation</span> :<code class="type">int64</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Currently allocated in bytes.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpool_info.available">available</span> :<code class="type">int64</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Remaining free space bytes.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<pre><span id="VALlookup_by_name"><span class="keyword">val</span> lookup_by_name</span> : <code class="type">'a <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> string -> 'a <a href="Libvirt.Pool.html#TYPEt">t</a></code></pre><pre><span id="VALlookup_by_uuid"><span class="keyword">val</span> lookup_by_uuid</span> : <code class="type">'a <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> <a href="Libvirt.html#TYPEuuid">Libvirt.uuid</a> -> 'a <a href="Libvirt.Pool.html#TYPEt">t</a></code></pre><pre><span id="VALlookup_by_uuid_string"><span class="keyword">val</span> lookup_by_uuid_string</span> : <code class="type">'a <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> string -> 'a <a href="Libvirt.Pool.html#TYPEt">t</a></code></pre><div class="info">
Look up a storage pool by name, UUID or UUID string.<br>
</div>
<pre><span id="VALcreate_xml"><span class="keyword">val</span> create_xml</span> : <code class="type">[> `W ] <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> <a href="Libvirt.html#TYPExml">Libvirt.xml</a> -> <a href="Libvirt.html#TYPErw">Libvirt.rw</a> <a href="Libvirt.Pool.html#TYPEt">t</a></code></pre><div class="info">
Create a storage pool.<br>
</div>
<pre><span id="VALdefine_xml"><span class="keyword">val</span> define_xml</span> : <code class="type">[> `W ] <a href="Libvirt.Connect.html#TYPEt">Libvirt.Connect.t</a> -> <a href="Libvirt.html#TYPExml">Libvirt.xml</a> -> <a href="Libvirt.html#TYPErw">Libvirt.rw</a> <a href="Libvirt.Pool.html#TYPEt">t</a></code></pre><div class="info">
Define but don't activate a storage pool.<br>
</div>
<pre><span id="VALbuild"><span class="keyword">val</span> build</span> : <code class="type">[> `W ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> <a href="Libvirt.Pool.html#TYPEpool_build_flags">pool_build_flags</a> -> unit</code></pre><div class="info">
Build a storage pool.<br>
</div>
<pre><span id="VALundefine"><span class="keyword">val</span> undefine</span> : <code class="type">[> `W ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Undefine configuration of a storage pool.<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">[> `W ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Start up a defined (inactive) storage pool.<br>
</div>
<pre><span id="VALdestroy"><span class="keyword">val</span> destroy</span> : <code class="type">[> `W ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Destroy a storage pool.<br>
</div>
<pre><span id="VALdelete"><span class="keyword">val</span> delete</span> : <code class="type">[> `W ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Delete a storage pool.<br>
</div>
<pre><span id="VALfree"><span class="keyword">val</span> free</span> : <code class="type">[> `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Free a storage pool object in memory.
<p>
The storage pool object is automatically freed if it is garbage
collected. This function just forces it to be freed right
away.<br>
</div>
<pre><span id="VALrefresh"><span class="keyword">val</span> refresh</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Refresh the list of volumes in the storage pool.<br>
</div>
<pre><span id="VALget_name"><span class="keyword">val</span> get_name</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> string</code></pre><div class="info">
Name of the pool.<br>
</div>
<pre><span id="VALget_uuid"><span class="keyword">val</span> get_uuid</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPEuuid">Libvirt.uuid</a></code></pre><div class="info">
Get the UUID (as a packed byte array).<br>
</div>
<pre><span id="VALget_uuid_string"><span class="keyword">val</span> get_uuid_string</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> string</code></pre><div class="info">
Get the UUID (as a printable string).<br>
</div>
<pre><span id="VALget_info"><span class="keyword">val</span> get_info</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> <a href="Libvirt.Pool.html#TYPEpool_info">pool_info</a></code></pre><div class="info">
Get information about the pool.<br>
</div>
<pre><span id="VALget_xml_desc"><span class="keyword">val</span> get_xml_desc</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPExml">Libvirt.xml</a></code></pre><div class="info">
Get the XML description.<br>
</div>
<pre><span id="VALget_autostart"><span class="keyword">val</span> get_autostart</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> bool</code></pre><div class="info">
Get the autostart flag for the storage pool.<br>
</div>
<pre><span id="VALset_autostart"><span class="keyword">val</span> set_autostart</span> : <code class="type">[ `W ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> bool -> unit</code></pre><div class="info">
Set the autostart flag for the storage pool.<br>
</div>
<pre><span id="VALnum_of_volumes"><span class="keyword">val</span> num_of_volumes</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> int</code></pre><div class="info">
Returns the number of storage volumes within the storage pool.<br>
</div>
<pre><span id="VALlist_volumes"><span class="keyword">val</span> list_volumes</span> : <code class="type">[ `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> int -> string array</code></pre><div class="info">
Return list of storage volumes.<br>
</div>
<pre><span id="VALconst"><span class="keyword">val</span> const</span> : <code class="type">[> `R ] <a href="Libvirt.Pool.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPEro">Libvirt.ro</a> <a href="Libvirt.Pool.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">const conn</code> turns a read/write storage pool into a read-only
pool. Note that the opposite operation is impossible.<br>
</div>
</body></html>
