<!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.Domain.html">
<link rel="next" href="Libvirt.Pool.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.Network</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Libvirt.Domain.html" title="Libvirt.Domain">Previous</a>
<a class="up" href="Libvirt.html" title="Libvirt">Up</a>
<a class="post" href="Libvirt.Pool.html" title="Libvirt.Pool">Next</a>
</div>
<h1>Module <a href="type_Libvirt.Network.html">Libvirt.Network</a></h1>
<pre><span class="keyword">module</span> Network: <code class="code">sig</code> <a href="Libvirt.Network.html">..</a> <code class="code">end</code></pre><div class="info">
Module dealing with networks. <code class="code">Network.t</code> is the
network object.<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">
Network handle. Read-only handles have type <code class="code">ro Network.t</code> and
read-write handles have type <code class="code">rw Network.t</code>.<br>
</div>
<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.Network.html#TYPEt">t</a></code></pre><div class="info">
Lookup a network by name.<br>
</div>
<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.Network.html#TYPEt">t</a></code></pre><div class="info">
Lookup a network by (packed) UUID.<br>
</div>
<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.Network.html#TYPEt">t</a></code></pre><div class="info">
Lookup a network by 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.Network.html#TYPEt">t</a></code></pre><div class="info">
Create a network.<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.Network.html#TYPEt">t</a></code></pre><div class="info">
Define but don't activate a network.<br>
</div>
<pre><span id="VALundefine"><span class="keyword">val</span> undefine</span> : <code class="type">[> `W ] <a href="Libvirt.Network.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Undefine configuration of a network.<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">[> `W ] <a href="Libvirt.Network.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Start up a defined (inactive) network.<br>
</div>
<pre><span id="VALdestroy"><span class="keyword">val</span> destroy</span> : <code class="type">[> `W ] <a href="Libvirt.Network.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Destroy a network.<br>
</div>
<pre><span id="VALfree"><span class="keyword">val</span> free</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">free network</code> frees the network object in memory.
<p>
The network object is automatically freed if it is garbage
collected. This function just forces it to be freed right
away.<br>
</div>
<pre><span id="VALget_name"><span class="keyword">val</span> get_name</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> string</code></pre><div class="info">
Get network name.<br>
</div>
<pre><span id="VALget_uuid"><span class="keyword">val</span> get_uuid</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPEuuid">Libvirt.uuid</a></code></pre><div class="info">
Get network packed UUID.<br>
</div>
<pre><span id="VALget_uuid_string"><span class="keyword">val</span> get_uuid_string</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> string</code></pre><div class="info">
Get network UUID as a printable string.<br>
</div>
<pre><span id="VALget_xml_desc"><span class="keyword">val</span> get_xml_desc</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPExml">Libvirt.xml</a></code></pre><div class="info">
Get XML description of a network.<br>
</div>
<pre><span id="VALget_bridge_name"><span class="keyword">val</span> get_bridge_name</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> string</code></pre><div class="info">
Get bridge device name of a network.<br>
</div>
<pre><span id="VALget_autostart"><span class="keyword">val</span> get_autostart</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> bool</code></pre><div class="info">
Get the autostart flag for a network.<br>
</div>
<pre><span id="VALset_autostart"><span class="keyword">val</span> set_autostart</span> : <code class="type">[> `W ] <a href="Libvirt.Network.html#TYPEt">t</a> -> bool -> unit</code></pre><div class="info">
Set the autostart flag for a network.<br>
</div>
<pre><span id="VALconst"><span class="keyword">val</span> const</span> : <code class="type">[> `R ] <a href="Libvirt.Network.html#TYPEt">t</a> -> <a href="Libvirt.html#TYPEro">Libvirt.ro</a> <a href="Libvirt.Network.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">const network</code> turns a read/write network handle into a read-only
network handle. Note that the opposite operation is impossible.<br>
</div>
</body></html>
