]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: domain: Document network <filterref>
authorCole Robinson <crobinso@redhat.com>
Fri, 15 Apr 2016 21:58:00 +0000 (17:58 -0400)
committerCole Robinson <crobinso@redhat.com>
Wed, 20 Apr 2016 20:33:24 +0000 (16:33 -0400)
The proper nwfilter docs go into full detail, but we should still
have a brief bit about domain XML in the domain documentation

docs/formatdomain.html.in

index 54ad99b74ece6ab587f70859b8898b8b05592017..895114bffefe7d275379d7c490405dd323398857 100644 (file)
@@ -4909,6 +4909,46 @@ qemu-kvm -net nic,model=? /dev/null
       <code>&lt;model&gt;</code> element is mandatory.
     </p>
 
+    <h5><a name="elementNwfilter">Traffic filtering with NWFilter</a></h5>
+
+    <p>
+    <span class="since">Since 0.8.0</span> an <code>nwfilter</code> profile
+    can be assigned to a domain interface, which allows configuring
+    traffic filter rules for the virtual machine.
+
+    See the <a href="formatnwfilter.html">nwfilter</a> documentation for more
+    complete details.
+    </p>
+
+<pre>
+  ...
+  &lt;devices&gt;
+    &lt;interface ...&gt;
+      ...
+      &lt;filterref filter='clean-traffic'/&gt;
+    &lt;/interface&gt;
+    &lt;interface ...&gt;
+      ...
+      &lt;filterref filter='myfilter'&gt;
+        &lt;parameter name='IP' value='104.207.129.11'/&gt;
+        &lt;parameter name='IP6_ADDR' value='2001:19f0:300:2102::'/&gt;
+        &lt;parameter name='IP6_MASK' value='64'/&gt;
+        ...
+      &lt;/filterref&gt;
+    &lt;/interface&gt;
+  &lt;/devices&gt;
+  ...</pre>
+
+    <p>
+      The <code>filter</code> attribute specifies the name of the nwfilter
+      to use. Optional <code>&lt;parameter&gt;</code> elements may be
+      specified for passing additional info to the nwfilter via the
+      <code>name</code> and <code>value</code> attributes. See
+      the <a href="formatnwfilter.html#nwfconceptsvars">nwfilter</a>
+      docs for info on parameters.
+    </p>
+
+
     <h4><a name="elementsInput">Input devices</a></h4>
 
     <p>