From: Stefan Berger <stefanb@linux.vnet.ibm.com>
Date: Sat, 19 Nov 2011 12:26:56 +0000 (-0500)
Subject: Add documentation for VLAN filtering support
X-Git-Tag: v0.9.8-rc1~124
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=83ac18937e0cd651378a547b6ba2dafd0760eceb;p=thirdparty%2Flibvirt.git

Add documentation for VLAN filtering support

Add documentation for the VLAN filtering support. Describe the XML attributes
that are supported.

Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
---

diff --git a/docs/formatnwfilter.html.in b/docs/formatnwfilter.html.in
index ad754c1bd9..d21fac579f 100644
--- a/docs/formatnwfilter.html.in
+++ b/docs/formatnwfilter.html.in
@@ -548,6 +548,61 @@
 [...]
 </pre>
 
+    <h5><a name="nwfelemsRulesProtoVLAN">VLAN (802.1Q)</a>
+      <span class="since">(Since 0.9.8)</span>
+    </h5>
+    <p>
+      Protocol ID: <code>vlan</code>
+      <br/>
+      Note: Rules of this type should go either into the <code>root</code> or
+      <code>vlan</code> chain.
+    </p>
+      <table class="top_table">
+       <tr>
+         <th> Attribute </th>
+         <th> Datatype </th>
+         <th> Semantics </th>
+       </tr>
+       <tr>
+         <td>srcmacaddr</td>
+         <td>MAC_ADDR</td>
+         <td>MAC address of sender</td>
+       </tr>
+       <tr>
+         <td>srcmacmask</td>
+         <td>MAC_MASK</td>
+         <td>Mask applied to MAC address of sender</td>
+       </tr>
+       <tr>
+         <td>dstmacaddr</td>
+         <td>MAC_ADDR</td>
+         <td>MAC address of destination</td>
+       </tr>
+       <tr>
+         <td>dstmacmask</td>
+         <td>MAC_MASK</td>
+         <td>Mask applied to MAC address of destination</td>
+       </tr>
+       <tr>
+         <td>vlan-id</td>
+         <td>UINT16 (0x0-0xfff, 0 - 4095)</td>
+         <td>VLAN ID</td>
+       </tr>
+       <tr>
+         <td>encap-protocol</td>
+         <td>UINT16 (0x03c-0xfff), String</td>
+         <td>Encapsulated layer 3 protocol ID</td>
+       </tr>
+       <tr>
+         <td>comment </td>
+         <td>STRING</td>
+         <td>text with max. 256 characters</td>
+       </tr>
+      </table>
+    <p>
+      Valid Strings for <code>encap-protocol</code> are: arp, ipv4, ipv6
+    </p>
+
     <h5><a name="nwfelemsRulesProtoARP">ARP/RARP</a></h5>
     <p>
       Protocol ID: <code>arp</code> or <code>rarp</code>