ovn-nbctl: Update logical switch commands.

[cascardo/ovs.git] / ovn / utilities / ovn-nbctl.8.xml

diff --git a/ovn/utilities/ovn-nbctl.8.xml b/ovn/utilities/ovn-nbctl.8.xml
index 35a44f8..c2ca420 100644 (file)
--- a/ovn/utilities/ovn-nbctl.8.xml
+++ b/ovn/utilities/ovn-nbctl.8.xml
@@ -12,10 +12,10 @@
     <h1>General Commands</h1>
 
     <dl>
-      <dt><code>show [<var>lswitch</var> | <var>router</var>]</code></dt>
+      <dt><code>show [<var>switch</var> | <var>router</var>]</code></dt>
       <dd>
         Prints a brief overview of the database contents.  If
-        <var>lswitch</var> is provided, only records related to that
+        <var>switch</var> is provided, only records related to that
         logical switch are shown. If
         <var>router</var> is provided, only records related to that
         logical router are shown.
@@ -25,7 +25,7 @@
     <h1>Logical Switch Commands</h1>
 
     <dl>
-      <dt><code>lswitch-add</code></dt>
+      <dt><code>ls-add</code></dt>
       <dd>
         <p>
           Creates a new, unnamed logical switch, which initially has no ports.
@@ -34,10 +34,10 @@
         </p>
       </dd>
 
-      <dt>[<code>--may-exist</code> | <code>--add-duplicate</code>] <code>lswitch-add</code> <var>lswitch</var></dt> 
+      <dt>[<code>--may-exist</code> | <code>--add-duplicate</code>] <code>ls-add</code> <var>switch</var></dt>
       <dd>
         <p>
-          Creates a new logical switch named <var>lswitch</var>, which
+          Creates a new logical switch named <var>switch</var>, which
           initially has no ports.
         </p>
 
@@ -46,7 +46,7 @@
           names to be unique, but the whole point to the names is to provide an
           easy way for humans to refer to the switches, making duplicate names
           unhelpful.  Thus, without any options, this command regards it as an
-          error if <var>lswitch</var> is a duplicate name.  With
+          error if <var>switch</var> is a duplicate name.  With
           <code>--may-exist</code>, adding a duplicate name succeeds but does
           not create a new logical switch.  With <code>--add-duplicate</code>,
           the command really creates a new logical switch with a duplicate
@@ -54,23 +54,23 @@
         </p>
       </dd>
 
-      <dt>[<code>--if-exists</code>] <code>lswitch-del</code> <var>lswitch</var></dt>
+      <dt>[<code>--if-exists</code>] <code>ls-del</code> <var>switch</var></dt>
       <dd>
-        Deletes <var>lswitch</var>.  It is an error if <var>lswitch</var> does
+        Deletes <var>switch</var>.  It is an error if <var>switch</var> does
         not exist, unless <code>--if-exists</code> is specified.
       </dd>
 
-      <dt><code>lswitch-list</code></dt>
+      <dt><code>ls-list</code></dt>
       <dd>
         Lists all existing switches on standard output, one per line.
       </dd>
     </dl>
 
-    <h1>ACL Commands</h1>
+    <h1>Logical Switch ACL Commands</h1>
     <dl>
-      <dt>[<code>--log</code>] <code>acl-add</code> <var>lswitch</var> <var>direction</var> <var>priority</var> <var>match</var> <var>action</var></dt>
+      <dt>[<code>--log</code>] <code>acl-add</code> <var>switch</var> <var>direction</var> <var>priority</var> <var>match</var> <var>action</var></dt>
       <dd>
-        Adds the specified ACL to <var>lswitch</var>.
+        Adds the specified ACL to <var>switch</var>.
         <var>direction</var> must be either <code>from-lport</code> or
         <code>to-lport</code>.  <var>priority</var> must be between
         <code>1</code> and <code>65534</code>, inclusive.  If
@@ -78,25 +78,25 @@
         ACL.  A full description of the fields are in <code>ovn-nb</code>(5).
       </dd>
 
-      <dt><code>acl-del</code> <var>lswitch</var> [<var>direction</var> [<var>priority</var> <var>match</var>]]</dt>
+      <dt><code>acl-del</code> <var>switch</var> [<var>direction</var> [<var>priority</var> <var>match</var>]]</dt>
       <dd>
-        Deletes ACLs from <var>lswitch</var>.  If only
-        <var>lswitch</var> is supplied, all the ACLs from the logical
+        Deletes ACLs from <var>switch</var>.  If only
+        <var>switch</var> is supplied, all the ACLs from the logical
         switch are deleted.  If <var>direction</var> is also specified,
         then all the flows in that direction will be deleted from the
         logical switch.  If all the fields are given, then a single flow
         that matches all the fields will be deleted.
       </dd>
 
-      <dt><code>acl-list</code> <var>lswitch</var></dt>
+      <dt><code>acl-list</code> <var>switch</var></dt>
       <dd>
-        Lists the ACLs on <var>lswitch</var>.
+        Lists the ACLs on <var>switch</var>.
       </dd>
     </dl>
 
     <h1>Logical Switch Port Commands</h1>
     <dl>
-      <dt>[<code>--may-exist</code>] <code>lsp-add</code> <var>lswitch</var> <var>port</var></dt>
+      <dt>[<code>--may-exist</code>] <code>lsp-add</code> <var>switch</var> <var>port</var></dt>
       <dd>
         <p>
           Creates on <var>lswitch</var> a new logical switch port named
@@ -107,15 +107,15 @@
           It is an error if a logical port named <var>port</var> already
           exists, unless <code>--may-exist</code> is specified.  Regardless of
           <code>--may-exist</code>, it is an error if the existing port is in
-          some logical switch other than <var>lswitch</var> or if it has a
+          some logical switch other than <var>switch</var> or if it has a
           parent port.
         </p>
       </dd>
 
-      <dt>[<code>--may-exist</code>] <code>lsp-add</code> <var>lswitch</var> <var>port</var> <var>parent</var> <var>tag</var></dt>
+      <dt>[<code>--may-exist</code>] <code>lsp-add</code> <var>switch</var> <var>port</var> <var>parent</var> <var>tag</var></dt>
       <dd>
         <p>
-          Creates on <var>lswitch</var> a logical switch port named
+          Creates on <var>switch</var> a logical switch port named
           <var>port</var> that is a child of <var>parent</var> that is
           identifed with VLAN ID <var>tag</var>.  This is useful in
           cases such as virtualized container environments where Open
@@ -127,7 +127,7 @@
           It is an error if a logical port named <var>port</var> already
           exists, unless <code>--may-exist</code> is specified.  Regardless of
           <code>--may-exist</code>, it is an error if the existing port is not
-          in <var>lswitch</var> or if it does not have the specified
+          in <var>switch</var> or if it does not have the specified
           <var>parent</var> and <var>tag</var>.
         </p>
       </dd>
@@ -138,9 +138,9 @@
         not exist, unless <code>--if-exists</code> is specified.
       </dd>
 
-      <dt><code>lsp-list</code> <var>lswitch</var></dt>
+      <dt><code>lsp-list</code> <var>switch</var></dt>
       <dd>
-        Lists all the logical switch ports within <var>lswitch</var> on
+        Lists all the logical switch ports within <var>switch</var> on
         standard output, one per line.
       </dd>