The --portrange option was added in commit [0]. The option appears in
the help text for ovn-nbctl, but it is not documented in the manpage at
all.

This commit adds documentation to the manpage for the --portrange
option.

Reported-at: https://issues.redhat.com/browse/FDP-537
Signed-off-by: Mark Michelson <mmich...@redhat.com>
---
 utilities/ovn-nbctl.8.xml | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/utilities/ovn-nbctl.8.xml b/utilities/ovn-nbctl.8.xml
index 39c352212..ea2b201a5 100644
--- a/utilities/ovn-nbctl.8.xml
+++ b/utilities/ovn-nbctl.8.xml
@@ -1175,7 +1175,7 @@
     <h2>NAT Commands</h2>
 
     <dl>
-      <dt>[<code>--may-exist</code>] [<code>--stateless</code>] 
[<code>--gateway-port</code>=<var>GATEWAY_PORT</var>] <code>lr-nat-add</code> 
<var>router</var> <var>type</var> <var>external_ip</var> <var>logical_ip</var> 
[<var>logical_port</var> <var>external_mac</var>]</dt>
+      <dt>[<code>--may-exist</code>] [<code>--stateless</code>] 
[<code>--gateway-port</code>=<var>GATEWAY_PORT</var>] [--portrange] 
<code>lr-nat-add</code> <var>router</var> <var>type</var> 
<var>external_ip</var> <var>logical_ip</var> [<var>logical_port</var> 
<var>external_mac</var>] [<var>external_port_range</var>]</dt>
       <dd>
         <p>
           Adds the specified NAT to <var>router</var>.
@@ -1212,6 +1212,18 @@
           specify the <var>GATEWAY_PORT</var>.
         </p>
 
+        <p>
+          If the <code>--portrange</code> option is specified, then a range of
+          ports may be specified in the <code>external_port_range</code> part
+          of the <code>lr-nat-add</code> command. If this option is omitted,
+          then an external port range may not be specified. The format of the
+          port range is <code>port_low-port_high</code>, where
+          <var>port_low</var> is a lower number than <var>port_high</var>. When
+          the packet is NATted, a random port from the range will be selected
+          as the source port. The range for the
+          <code>external_port_range</code> is <code>1-65535</code>.
+        </p>
+
         <p>
           When <var>type</var> is <code>dnat</code>, the externally
           visible IP address <var>external_ip</var> is DNATted to the
-- 
2.44.0

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

Reply via email to