vtep: Document the meaning of VLAN zero for vlan_bindings

The meaning of a value of zero in the VLAN field when mapping <VLAN, port>
pairs to logical switches had not previously been specified in the VTEP
schema. It is now clarified that a value of zero refers to untagged
traffic.

Signed-off-by: Bruce Davie <bdavie@vmware.com>
Acked-by: Russell Bryant <rbryant@redhat.com>
Signed-off-by: Justin Pettit <jpettit@nicira.com>

diff --git a/vtep/vtep.xml b/vtep/vtep.xml
index 0450999..2bdee1c 100644 (file)
--- a/vtep/vtep.xml
+++ b/vtep/vtep.xml
@@ -532,7 +532,9 @@
       Identifies how VLANs on the physical port are bound to logical switches.
       If, for example, the map contains a (VLAN, logical switch) pair, a packet
       that arrives on the port in the VLAN is considered to belong to the
-      paired logical switch.
+      paired logical switch. A value of zero in the VLAN field means
+      that untagged traffic on the physical port is mapped to the
+      logical switch.
     </column>
 
     <column name="vlan_stats">
@@ -541,7 +543,8 @@
       column with a mapping for every VLAN that is bound in <ref
       column="vlan_bindings"/>.  An implementation that does not support such
       statistics or only partially supports them would not populate this column
-      or partially populate it, respectively.
+      or partially populate it, respectively. A value of zero in the
+      VLAN field refers to untagged traffic on the physical port.
     </column>
 
     <group title="Identification">