[ovs-dev] [PATCH ovn] ovn-nbctl.8: Document the "--route-table" option.

[Martin Morgenstern via dev]

This adds documentation for the --route-table option for lr-route-add,
lr-route-del and lr-route-list that previously only appeared in the help
text for ovn-nbctl and was missing in the manpage.

Signed-off-by: Martin Morgenstern <martin.morgenst...@cloudandheat.com>
---
 utilities/ovn-nbctl.8.xml | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/utilities/ovn-nbctl.8.xml b/utilities/ovn-nbctl.8.xml
index aa0291375..287074e11 100644
--- a/utilities/ovn-nbctl.8.xml
+++ b/utilities/ovn-nbctl.8.xml
@@ -1036,6 +1036,7 @@
 
     <dl>
       <dt>[<code>--may-exist</code>] [<code>--policy</code>=<var>POLICY</var>]
+        [<code>--route-table</code>=<var>ROUTE_TABLE</var>]
         [<code>--ecmp</code>] [<code>--ecmp-symmetric-reply</code>]
         [<code>--bfd[=<var>UUID</var></code>]]
         <code>lr-route-add</code> <var>router</var>
@@ -1055,6 +1056,16 @@
           for dropping packets which match the given route.
         </p>
 
+        <p>
+          The <code>--route-table</code> option can be used to assign the
+          given route to a separate routing table <var>ROUTE_TABLE</var>
+          instead of the default <code>&lt;main&gt;</code> table.  For a
+          detailed explanation of the route lookup behavior, see the
+          description of the field
+          <code>Logical_Router_Static_Route:route_table</code> in the
+          <code>ovn-nb</code>(5) manpage.
+        </p>
+
         <p>
           <code>--policy</code> describes the policy used to make routing
           decisions.  This should be one of "dst-ip" or "src-ip".  If not
@@ -1101,6 +1112,7 @@
       </dd>
 
       <dt>[<code>--if-exists</code>] [<code>--policy</code>=<var>POLICY</var>]
+        [<code>--route-table</code>=<var>ROUTE_TABLE</var>]
         <code>lr-route-del</code> <var>router</var> [<var>prefix</var>
         [<var>nexthop</var> [<var>port</var>]]]</dt>
       <dd>
@@ -1112,6 +1124,12 @@
           the conditions will be deleted from the logical router.
         </p>
 
+        <p>
+          The <code>--route-table</code> option can be used to delete the
+          given route from the route table <var>ROUTE_TABLE</var> instead
+          of the default <code>&lt;main&gt;</code> table.
+        </p>
+
         <p>
           It is an error if there is no matching route entry, unless
           <code>--if-exists</code> is specified.
@@ -1128,6 +1146,7 @@
 
     <dl>
       <dt>[<code>--may-exist</code>] [<code>--bfd</code>]
+          [<code>--route-table</code>=<var>ROUTE_TABLE</var>]
           <code>lr-policy-add</code>
           <var>router</var> <var>priority</var> <var>match</var>
           <var>action</var> [<var>nexthop</var>[,<var>nexthop</var>,...]]
@@ -1155,6 +1174,12 @@
           duplicated routing policy results in error.
         </p>
 
+        <p>
+          The <code>--route-table</code> option can be used to list the
+          routes assigned to route table <var>ROUTE_TABLE</var> instead of
+          the default <code>&lt;main&gt;</code> table.
+        </p>
+
         <p>
           <code>--bfd</code> option is used to link a BFD session to the
           OVN reroute policy. OVN will look for an already running BFD
-- 
2.45.2

_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev