bfd: Clarify the BFD diagnostic.
[cascardo/ovs.git] / vswitchd / vswitch.xml
index 7f2fd58..329ea31 100644 (file)
         host as displayed by <code>xe host-list</code>.
       </column>
 
+      <column name="other_config" key="stats-update-interval"
+              type='{"type": "integer", "minInteger": 5000}'>
+        <p>
+          Interval for updating statistics to the database, in milliseconds.
+          This option will affect the update of the <code>statistics</code>
+          column in the following tables: <code>Port</code>, <code>Interface
+          </code>, <code>Mirror</code>.
+        </p>
+        <p>
+          Default value is 5000 ms.
+        </p>
+        <p>
+          Getting statistics more frequently can be achieved via OpenFlow.
+        </p>
+      </column>
+
       <column name="other_config" key="flow-restore-wait"
               type='{"type": "boolean"}'>
         <p>
        </p>
 
        <p>
-         The current implementation of OpenFlow 1.4 support is not safe:
-         <code>ovs-vswitchd</code> will abort when certain unimplemented
-         features are tested.  Thus, for now it is suitable only for
-         experimental use.  For this reason, OpenFlow 1.4 is supported only
-         if, in addition to specifying <code>OpenFlow14</code> in this field,
-         <code>ovs-vswitchd</code> is invoked with the
-         <code>--enable-of14</code> option.  (When support becomes safe, this
-         option will be removed.)
+         OpenFlow 1.4 is not enabled by default because its implementation is
+         missing features.
        </p>
+
+        <p>
+          OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
+          experimental because the OpenFlow 1.5 specification is still under
+          development and thus subject to change.  Pass
+          <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
+          OpenFlow 1.5 to be enabled.
+        </p>
       </column>
     </group>
 
 
     <group title="Port Statistics">
       <p>
-        Key-value pairs that report port statistics.
+        Key-value pairs that report port statistics.  The update period
+        is controlled by <ref column="other_config"
+        key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
       </p>
       <group title="Statistics: STP transmit and receive counters">
         <column name="statistics" key="stp_tx_count">
     <group title="Statistics">
       <p>
         Key-value pairs that report interface statistics.  The current
-        implementation updates these counters periodically.  Future
-        implementations may update them when an interface is created, when they
-        are queried (e.g. using an OVSDB <code>select</code> operation), and
-        just before an interface is deleted due to virtual interface hot-unplug
-        or VM shutdown, and perhaps at other times, but not on any regular
-        periodic basis.
+        implementation updates these counters periodically.  The update period
+        is controlled by <ref column="other_config"
+        key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
+        Future implementations may update them when an interface is created,
+        when they are queried (e.g. using an OVSDB <code>select</code>
+        operation), and just before an interface is deleted due to virtual
+        interface hot-unplug or VM shutdown, and perhaps at other times, but
+        not on any regular periodic basis.
       </p>
       <p>
         These are the same statistics reported by OpenFlow in its <code>struct
           tunnel key.
        </column>
 
-       <column name="bfd" key="bfd_dst_mac">
+       <column name="bfd" key="bfd_local_src_mac">
+         Set to an Ethernet address in the form
+         <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
+         to set the MAC used as source for transmitted BFD packets.  The
+         default is the mac address of the BFD enabled interface.
+       </column>
+
+       <column name="bfd" key="bfd_local_dst_mac">
+         Set to an Ethernet address in the form
+         <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
+         to set the MAC used as destination for transmitted BFD packets.  The
+         default is <code>00:23:20:00:00:01</code>.
+       </column>
+
+       <column name="bfd" key="bfd_remoe_dst_mac">
          Set to an Ethernet address in the form
          <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
-         to set the MAC used as destination for transmitted BFD packets and
-         expected as destination for received BFD packets.  The default is
-         <code>00:23:20:00:00:01</code>.
+         to set the MAC used for checking the destination of received BFD packets.
+         Packets with different destination MAC will not be considered as BFD packets.
+         If not specified the destination MAC address of received BFD packets
+         are not checked.
        </column>
 
        <column name="bfd" key="bfd_src_ip">
           Set to an IPv4 address to set the IP address used as source for
-          transmitted BFD packets.  The default is <code>169.254.1.0</code>.
+          transmitted BFD packets.  The default is <code>169.254.1.1</code>.
        </column>
 
        <column name="bfd" key="bfd_dst_ip">
           Set to an IPv4 address to set the IP address used as destination
-          for transmitted BFD packets.  The default is <code>169.254.1.1</code>.
+          for transmitted BFD packets.  The default is <code>169.254.1.0</code>.
        </column>
       </group>
 
        </column>
 
        <column name="bfd_status" key="diagnostic">
-         In case of a problem, set to a short message that reports what the
-         local BFD session thinks is wrong.
+         In case of a problem, set to an error message that reports what the
+         local BFD session thinks is wrong.  The error messages are defined
+         in section 4.1 of [RFC 5880].
        </column>
 
        <column name="bfd_status" key="remote_state"
        </column>
 
        <column name="bfd_status" key="remote_diagnostic">
-         In case of a problem, set to a short message that reports what the
-         remote endpoint's BFD session thinks is wrong.
+         In case of a problem, set to an error message that reports what the
+         remote endpoint's BFD session thinks is wrong.  The error messages
+         are defined in section 4.1 of [RFC 5880].
        </column>
 
         <column name="bfd_status" key="flap_count"
 
     <group title="Statistics: Mirror counters">
       <p>
-        Key-value pairs that report mirror statistics.
+        Key-value pairs that report mirror statistics.  The update period
+        is controlled by <ref column="other_config"
+        key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
       </p>
       <column name="statistics" key="tx_packets">
         Number of packets transmitted through this mirror.