[libvirt] [PATCH V2 4/5] Add documentation for STP filtering support
Add documentation for the STP filtering support. Describe the XML attributes
that are supported.
Signed-off-by: Stefan Berger <stefanb(a)linux.vnet.ibm.com>
---
docs/formatnwfilter.html.in | 142 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 142 insertions(+)
Index: libvirt-acl/docs/formatnwfilter.html.in
===================================================================
--- libvirt-acl.orig/docs/formatnwfilter.html.in
+++ libvirt-acl/docs/formatnwfilter.html.in
@@ -603,6 +603,148 @@
Valid Strings for <code>encap-protocol</code> are: arp, ipv4, ipv6
</p>
+ <h5><a name="nwfelemsRulesProtoSTP">STP (Spanning Tree
Protocol)</a>
+ <span class="since">(Since 0.9.8)</span>
+ </h5>
+ <p>
+ Protocol ID: <code>stp</code>
+ <br/>
+ Note: Rules of this type should go either into the <code>root</code>
or
+ <code>stp</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>type</td>
+ <td>UINT8</td>
+ <td>Bridge Protcol Data Unit (BPDU) type</td>
+ </tr>
+ <tr>
+ <td>flags</td>
+ <td>UINT8</td>
+ <td>BPDU flag</td>
+ </tr>
+ <tr>
+ <td>root-priority</td>
+ <td>UINT16</td>
+ <td>Root priority (range start)</td>
+ </tr>
+ <tr>
+ <td>root-priority-hi</td>
+ <td>UINT16</td>
+ <td>Root priority range end</td>
+ </tr>
+ <tr>
+ <td>root-address</td>
+ <td>MAC_ADDRESS</td>
+ <td>Root MAC address</td>
+ </tr>
+ <tr>
+ <td>root-address-mask</td>
+ <td>MAC_MASK</td>
+ <td>Root MAC address mask</td>
+ </tr>
+ <tr>
+ <td>root-cost</td>
+ <td>UINT32</td>
+ <td>Root path cost (range start)</td>
+ </tr>
+ <tr>
+ <td>root-cost-hi</td>
+ <td>UINT32</td>
+ <td>Root path cost range end</td>
+ </tr>
+ <tr>
+ <td>sender-priority</td>
+ <td>UINT16</td>
+ <td>Sender priority (range start)</td>
+ </tr>
+ <tr>
+ <td>sender-priority-hi</td>
+ <td>UINT16</td>
+ <td>Sender priority range end</td>
+ </tr>
+ <tr>
+ <td>sender-address</td>
+ <td>MAC_ADDRESS</td>
+ <td>BPDU sender MAC address</td>
+ </tr>
+ <tr>
+ <td>sender-address-mask</td>
+ <td>MAC_MASK</td>
+ <td>BPDU sender MAC address mask</td>
+ </tr>
+ <tr>
+ <td>port</td>
+ <td>UINT16</td>
+ <td>Port identifier (range start)</td>
+ </tr>
+ <tr>
+ <td>port_hi</td>
+ <td>UINT16</td>
+ <td>Port identifier range end</td>
+ </tr>
+ <tr>
+ <td>msg-age</td>
+ <td>UINT16</td>
+ <td>Message age timer (range start)</td>
+ </tr>
+ <tr>
+ <td>msg-age-hi</td>
+ <td>UINT16</td>
+ <td>Message age timer range end</td>
+ </tr>
+ <tr>
+ <td>max-age</td>
+ <td>UINT16</td>
+ <td>Maximum age timer (range start)</td>
+ </tr>
+ <tr>
+ <td>max-age-hi</td>
+ <td>UINT16</td>
+ <td>Maximum age timer range end</td>
+ </tr>
+ <tr>
+ <td>hello-time</td>
+ <td>UINT16</td>
+ <td>Hello time timer (range start)</td>
+ </tr>
+ <tr>
+ <td>hello-time-hi</td>
+ <td>UINT16</td>
+ <td>Hello time timer range end</td>
+ </tr>
+ <tr>
+ <td>forward-delay</td>
+ <td>UINT16</td>
+ <td>Forward delay (range start)</td>
+ </tr>
+ <tr>
+ <td>forward-delay-hi</td>
+ <td>UINT16</td>
+ <td>Forward delay range end</td>
+ </tr>
+ <tr>
+ <td>comment</td>
+ <td>STRING</td>
+ <td>text with max. 256 characters</td>
+ </tr>
+ </table>
+
<h5><a
name="nwfelemsRulesProtoARP">ARP/RARP</a></h5>
<p>
Protocol ID: <code>arp</code> or <code>rarp</code>