netdev: Add support for "patch" type

[sliver-openvswitch.git] / vswitchd / vswitch.xml

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index e0f7d82..e1019e2 100644 (file)
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -127,8 +127,8 @@
         The currently defined key-value pairs are:
         <dl>
           <dt><code>network-uuids</code></dt>
-          <dd>Space-delimited set of universally unique identifier(s) for the
-            network with which this bridge is associated.  The form of the
+          <dd>Semicolon-delimited set of universally unique identifier(s) for
+            the network with which this bridge is associated.  The form of the
             identifier(s) depends on the type of the host.  On a Citrix
             XenServer host, the network identifiers are RFC 4122 UUIDs as
             displayed by, e.g., <code>xe network-list</code>.</dd>
@@ -357,6 +357,12 @@
           <dd>A TUN/TAP device managed by Open vSwitch.</dd>
           <dt><code>gre</code></dt>
           <dd>A GRE tunnel device managed by Open vSwitch.</dd>
+          <dt><code>patch</code></dt>
+          <dd>A pair of virtual devices that act as a patch cable.  A 
+            <code>peer</code> argument is required that indicates the name
+            of the other side of the patch.  Since a patch must work in
+            pairs, a second patch interface must be declared with the
+            <code>name</code> and <code>peer</code> arguments reversed.</dd>
         </dl>
       </column>