documenting the 802.1Qbh parameters of a 'direct' interface

This patch adds documentation about the 802.1Qbh related parameters
of the virtualport element for 'direct' interfaces.

Signed-off-by: David S. Wang <dwang2@cisco.com>
Signed-off-by: Roopa Prabhu <roprabhu@cisco.com>
Signed-off-by: Christian Benvenuti <benve@cisco.com>
Signed-off-by: Vasanthy Kolluri <vkolluri@cisco.com>

diff --git a/AUTHORS b/AUTHORS
index 64ba1a1ed6144fe08a8e0c14210c7cf8ed17c22a..906e0d11d1c5dcafaff25d0df60d8dc2a341fe36 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -177,6 +177,7 @@ Patches have also been contributed by:
   Ohad Levy            <ohadlevy@gmail.com>
   Michael Chapman      <mike@very.puzzling.org>
   Daniel Gollub        <gollub@b1-systems.de>
+  David S. Wang        <dwang2@cisco.com>
 
   [....send patches to get your name here....]
 

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 39e1a85877009d74fed7dd004abbf0c6ba5b8500..3a649831c04ea9234f4edb562598eb1db1715381 100644 (file)
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1532,7 +1532,7 @@
       in the IEEE 802.1Qbg standard. The values are network specific and
       should be provided by the network administrator. In 802.1Qbg terms,
       the Virtual Station Interface (VSI) represents the virtual interface
-      of a virtual machine.
+      of a virtual machine. <span class="since">Since 0.8.2</span>
     </p>
     <p>
       Please note that IEEE 802.1Qbg requires a non-zero value for the
@@ -1572,6 +1572,35 @@
   &lt;/devices&gt;
   ...</pre>
 
+    <p>
+      The interface can have additional parameters as shown below
+      if the switch is conforming to the IEEE 802.1Qbh standard.
+      The values are network specific and should be provided by the
+      network administrator. <span class="since">Since 0.8.2</span>
+    </p>
+    <dl>
+      <dt><code>profileid</code></dt>
+      <dd>The profile ID contains the name of the port profile that is to
+        be applied onto this interface.  This name is resolved by the port
+        profile database into the network parameters from the port profile,
+        and those network parameters will be applied to this interface.
+      </dd>
+    </dl>
+  <pre>
+  ...
+  &lt;devices&gt;
+    &lt;interface type='direct'/&gt;
+    ...
+    &lt;interface type='direct'&gt;
+      &lt;source dev='eth0' mode='private'/&gt;
+      &lt;virtualport type='802.1Qbh'&gt;
+        &lt;parameters profileid='finance'/&gt;
+      &lt;/virtualport&gt;
+    &lt;/interface&gt;
+  &lt;/devices&gt;
+  ...
+  </pre>
+
     <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>
 
     <p>