ofproto-dpif: Use sequence number to wake up main thread for
[sliver-openvswitch.git] / vtep / vtep.xml
index 3940479..8ae6af7 100644 (file)
        banner.
       </column>
     </group>
+    <group title="Error Notification">
+      <p>
+       An entry in this column indicates to the NVC that this switch
+       has encountered a fault. The switch must clear this column
+       when the fault has been cleared.
+      </p>
+
+      <column name="switch_fault_status" key="mac_table_exhaustion">
+        Indicates that the switch has been unable to process MAC
+        entries requested by the NVC due to lack of table resources.
+      </column>
+
+      <column name="switch_fault_status" key="tunnel_exhaustion">
+        Indicates that the switch has been unable to create tunnels
+        requested by the NVC due to lack of resources.
+      </column>
+
+      <column name="switch_fault_status" key="unspecified_fault">
+        Indicates that an error has occurred in the switch but that no
+        more specific information is available.
+      </column>
+
+    </group>
   </table>
 
   <table name="Physical_Port" title="A port within a physical switch.">
        An extended description for the port.
       </column>
     </group>
+    <group title="Error Notification">
+      <p>
+       An entry in this column indicates to the NVC that the physical port has
+       encountered a fault. The switch must clear this column when the errror
+       has been cleared.
+      </p>
+      <column name="port_fault_status" key="invalid_vlan_map">
+       <p>
+         Indicates that a VLAN-to-logical-switch mapping requested by
+         the controller could not be instantiated by the switch
+         because of a conflict with local configuration.
+       </p>
+      </column>
+      <column name="port_fault_status" key="unspecified_fault">
+       <p>
+         Indicates that an error has occurred on the port but that no
+         more specific information is available.
+       </p>
+      </column>
+    </group>
+
   </table>
 
   <table name="Logical_Binding_Stats" title="Statistics for a VLAN on a physical port bound to a logical network.">
     </p>
 
     <column name="MAC">
-      A MAC address that has been learned by the NSC.
+      A MAC address that has been learned by the NVC.
     </column>
 
     <column name="logical_switch">
 
     <column name="MAC">
       <p>
-       A MAC address that has been learned by the NSC.
+       A MAC address that has been learned by the NVC.
       </p>
       <p>
        The keyword <code>unknown-dst</code> is used as a special
     </group>
   </table>
 
+  <table name="Arp_Sources_Local" title="ARP source addresses for logical routers">
+    <p>
+      MAC address to be used when a VTEP issues ARP requests on behalf
+      of a logical router.
+    </p>
+
+    <p>
+      A distributed logical router is implemented by a set of VTEPs
+      (both hardware VTEPs and vswitches). In order for a given VTEP
+      to populate the local ARP cache for a logical router, it issues
+      ARP requests with a source MAC address that is unique to the VTEP. A
+      single per-VTEP MAC can be re-used across all logical
+      networks. This table contains the MACs that are used by the
+      VTEPs of a given HSC. The table provides the mapping from MAC to
+      physical locator for each VTEP so that replies to the ARP
+      requests can be sent back to the correct VTEP using the
+      appropriate physical locator.
+    </p>
+
+    <column name="src_mac">
+      The source MAC to be used by a given VTEP.
+    </column>
+
+    <column name="locator">
+      The <ref table="Physical_Locator"/> to use for replies to ARP
+      requests from this MAC address.
+    </column>
+  </table>
+
+  <table name="Arp_Sources_Remote" title="ARP source addresses for logical routers">
+    <p>
+      MAC address to be used when a remote VTEP issues ARP requests on behalf
+      of a logical router.
+    </p>
+
+    <p>
+      This table is the remote counterpart of <ref
+      table="Arp_sources_local"/>. The NVC writes this table to notify
+      the HSC of the MACs that will be used by remote VTEPs when they
+      issue ARP requests on behalf of a distributed logical router.
+    </p>
+
+    <column name="src_mac">
+      The source MAC to be used by a given VTEP.
+    </column>
+
+    <column name="locator">
+      The <ref table="Physical_Locator"/> to use for replies to ARP
+      requests from this MAC address.
+    </column>
+  </table>
+
   <table name="Physical_Locator_Set">
     <p>
       A set of one or more <ref table="Physical_Locator"/>s.
           expected as destination for received BFD packets.  The default is
           <code>00:23:20:00:00:01</code>.
         </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>.
+       </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>.
+       </column>
       </group>
 
       <group title="BFD Status">