vswitchd: Add miimon support.
[sliver-openvswitch.git] / vswitchd / vswitch.xml
index 7a70909..53c2650 100644 (file)
       <p>These columns apply only to bonded ports.  Their values are
         otherwise ignored.</p>
 
-      <column name="bond_type">
+      <column name="bond_mode">
         <p>The type of bonding used for a bonded port.  Currently supported
-          values are <code>slb</code> and <code>active-backup</code>.  Defaults
-          to SLB if unset.</p>
+          values are <code>balance-slb</code> and <code>active-backup</code>.
+          Defaults to SLB if unset.</p>
       </column>
 
       <column name="bond_updelay">
             the bond to another in an attempt to keep usage of each
             interface roughly equal.  The default is 10000 (10
             seconds), and the minimum is 1000 (1 second).</dd>
+          <dt><code>bond-detect-mode</code></dt>
+          <dd> Sets the method used to detect link failures in a bonded port.
+            Options are <code>carrier</code> and <code>miimon</code>. Defaults
+            to <code>carrier</code> which uses each interface's carrier to detect
+            failures.  When set to <code>miimon</code>, will check for failures
+            by polling each interface's MII. </dd>
+          <dt><code>bond-miimon-interval</code></dt>
+          <dd> The number of milliseconds between successive attempts to
+            poll each interface's MII.  Only relevant on ports which use
+            <code>miimon</code> to detect failures. </dd>
         </dl>
       </column>
     </group>
           Key-value pairs that report port status.  Supported status
           values are <code>type</code>-dependent.
         </p>
-        <p>The only currently defined key-value pair is:</p>
+        <p>The currently defined key-value pairs are:</p>
         <dl>
           <dt><code>source_ip</code></dt>
           <dd>The source IP address used for an IPv4 tunnel end-point,
             such as <code>gre</code> or <code>capwap</code>.  Not
             supported by all implementations.</dd>
         </dl>
+        <dl>
+            <dt><code>tunnel_egress_iface</code></dt>
+            <dd>Egress interface for tunnels.  Currently only relevant for GRE
+                and CAPWAP tunnels.  On Linux systems, this column will show
+                the name of the interface which is responsible for routing
+                traffic destined for the configured <code>remote_ip</code>.
+                This could be an internal interface such as a bridge port.</dd>
+        </dl>
       </column>
     </group>
 
         </dl>
       </column>
 
-      <column name="tunnel_egress_iface">
-        Egress interface for tunnels.  Currently only relevant for GRE and
-        CAPWAP tunnels.  On Linux systems, this column will show the name of
-        the interface which is responsible for routing traffic destined for the
-        configured <code>remote_ip</code>.  This could be an internal interface
-        such as a bridge port.
-      </column>
-
       <column name="other_config">
         Key-value pairs for rarely used interface features.  Currently,
         there are none defined.