bfd: Add new key "flap_count" to "bfd_status".
[sliver-openvswitch.git] / vswitchd / vswitch.xml
index 52924ee..f6a8db1 100644 (file)
 
       <p>
         The following modes require the upstream switch to support 802.3ad with
-        successful LACP negotiation:
+        successful LACP negotiation. If LACP negotiation fails and
+        other-config:lacp-fallback-ab is true, then <code>active-backup</code>
+        mode is used:
       </p>
 
       <dl>
           in LACP negotiations initiated by a remote switch, but not allowed to
           initiate such negotiations themselves.  If LACP is enabled on a port
           whose partner switch does not support LACP, the bond will be
-          disabled.  Defaults to <code>off</code> if unset.
+          disabled, unless other-config:lacp-fallback-ab is set to true.
+          Defaults to <code>off</code> if unset.
         </column>
 
         <column name="other_config" key="lacp-system-id">
             rate of once every 30 seconds.
           </p>
         </column>
+
+        <column name="other_config" key="lacp-fallback-ab"
+          type='{"type": "boolean"}'>
+          <p>
+            Determines the behavior of openvswitch bond in LACP mode. If
+            the partner switch does not support LACP, setting this option
+            to <code>true</code> allows openvswitch to fallback to
+            active-backup. If the option is set to <code>false</code>, the
+            bond will be disabled. In both the cases, once the partner switch
+            is configured to LACP mode, the bond will use LACP.
+          </p>
+        </column>
       </group>
 
       <group title="Rebalancing Configuration">
         address.</p>
       </column>
 
-      <column name="ofport">
-        <p>OpenFlow port number for this interface.  Unlike most columns, this
-        column's value should be set only by Open vSwitch itself.  Other
-        clients should set this column to an empty set (the default) when
-        creating an <ref table="Interface"/>.</p>
-        <p>Open vSwitch populates this column when the port number becomes
-        known.  If the interface is successfully added,
-        <ref column="ofport"/> will be set to a number between 1 and 65535
-        (generally either in the range 1 to 65279, inclusive, or 65534, the
-        port number for the OpenFlow ``local port'').  If the interface
-        cannot be added then Open vSwitch sets this column
-        to -1.</p>
-        <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
-        an appropriate value for this column and then tries to keep the value
-        constant across restarts.</p>
-      </column>
-
-      <column name="ofport_request">
-        <p>Requested OpenFlow port number for this interface.  The port
-        number must be between 1 and 65279, inclusive.  Some datapaths
-        cannot satisfy all requests for particular port numbers.  When
-        this column is empty or the request cannot be fulfilled, the
-        system will choose a free port.  The <ref column="ofport"/>
-        column reports the assigned OpenFlow port number.</p>
-        <p>The port number must be requested in the same transaction
-        that creates the port.</p>
-      </column>
+      <group title="OpenFlow Port Number">
+       <p>
+         When a client adds a new interface, Open vSwitch chooses an OpenFlow
+         port number for the new port.  If the client that adds the port fills
+         in <ref column="ofport_request"/>, then Open vSwitch tries to use its
+         value as the OpenFlow port number.  Otherwise, or if the requested
+         port number is already in use or cannot be used for another reason,
+         Open vSwitch automatically assigns a free port number.  Regardless of
+         how the port number was obtained, Open vSwitch then reports in <ref
+         column="ofport"/> the port number actually assigned.
+       </p>
+
+       <p>
+         Open vSwitch limits the port numbers that it automatically assigns to
+         the range 1 through 32,767, inclusive.  Controllers therefore have
+         free use of ports 32,768 and up.
+       </p>
+
+       <column name="ofport">
+         <p>
+           OpenFlow port number for this interface.  Open vSwitch sets this
+           column's value, so other clients should treat it as read-only.
+         </p>
+         <p>
+           The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
+           The other valid port numbers are in the range 1 to 65,279,
+           inclusive.  Value -1 indicates an error adding the interface.
+         </p>
+       </column>
+
+       <column name="ofport_request"
+               type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
+         <p>
+           Requested OpenFlow port number for this interface.
+         </p>
+
+         <p>
+           Open vSwitch currently assigns the OpenFlow port number for an
+           interface once, when the client first adds the interface.  It does
+           not change the port number later if the client sets or changes or
+           clears <ref column="ofport_request"/>.  Therefore, to ensure that
+           <ref column="ofport_request"/> takes effect, the client should set
+           it in the same database transaction that creates the interface.
+           (Future versions of Open vSwitch might honor changes to <ref
+           column="ofport_request"/>.)
+         </p>
+       </column>
+      </group>
     </group>
 
     <group title="System-Specific Details">
 
           <dt><code>lisp</code></dt>
           <dd>
-            A layer 3 tunnel over the experimental, UDP-based Locator/ID
-            Separation Protocol (RFC 6830).
+            <p>
+              A layer 3 tunnel over the experimental, UDP-based Locator/ID
+              Separation Protocol (RFC 6830).
+            </p>
+            <p>
+              Only IPv4 and IPv6 packets are supported by the protocol, and
+              they are sent and received without an Ethernet header.  Traffic
+              to/from LISP ports is expected to be configured explicitly, and
+              the ports are not intended to participate in learning based
+              switching.  As such, they are always excluded from packet
+              flooding.
+            </p>
           </dd>
 
           <dt><code>patch</code></dt>
          In case of a problem, set to a short message that reports what the
          remote endpoint's BFD session thinks is wrong.
        </column>
+
+        <column name="bfd_status" key="flap_count"
+          type='{"type": "integer", "minInteger": 0}'>
+          Counts the number of <ref column="bfd_status" key="forwarding" />
+          flaps since start.  A flap is considered as a change of the
+          <ref column="bfd_status" key="forwarding" /> value.
+        </column>
       </group>
     </group>