Signed-off-by: Justin Pettit <[email protected]>
---
ovn/utilities/ovn-nbctl.8.xml | 37 +++++++++++++++++++++++------------
1 file changed, 24 insertions(+), 13 deletions(-)
diff --git a/ovn/utilities/ovn-nbctl.8.xml b/ovn/utilities/ovn-nbctl.8.xml
index eadd206cf7fd..abba4ecdb2ae 100644
--- a/ovn/utilities/ovn-nbctl.8.xml
+++ b/ovn/utilities/ovn-nbctl.8.xml
@@ -127,21 +127,32 @@
<h1>Logical Switch QoS Rule Commands</h1>
<dl>
- <dt>[<code>--may-exist</code>] <code>qos-add</code> <var>switch</var>
<var>direction</var> <var>priority</var> <var>match</var> <var>rate</var>
<var>burst</var> <var>dscp</var></dt>
+ <dt>[<code>--may-exist</code>] <code>qos-add</code> <var>switch</var>
<var>direction</var> <var>priority</var> <var>match</var>
[<code>dscp=</code><var>dscp</var>] [<code>rate=</code><var>rate</var>
[<code>burst=</code><var>burst</var>]]</dt>
<dd>
<p>
- Adds the specified QoS rule to <var>switch</var>.
+ Adds QoS marking and metering rules 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>0</code> and <code>32767</code>, inclusive. <var>dscp</var>
- must be between <code>0</code> and <code>63</code>, inclusive.
- <var>rate</var> and <var>burst</var> must be between <code>1</code>
- and <code>4294967295</code>, inclusive. One of the rate or dscp
- must be configured. A full description of the fields are in
- <code>ovn-nb</code>(5). If <code>--may-exist</code> is specified,
- adding a duplicated QoS rule succeeds but the QoS rule is not
- really created. Without <code>--may-exist</code>, adding a
- duplicated QoS rule results in error.
+ <code>0</code> and <code>32767</code>, inclusive.
+ </p>
+
+ <p>
+ If <code>dscp=</code><var>dscp</var> is specified, then
+ matching packets will have DSCP marking applied.
+ <var>dscp</var> must be between <code>0</code> and
+ <code>63</code>, inclusive. If <code>rate=</code><var>rate</var>
+ is specified then matching packets will have metering applied
+ at <var>rate</var> kbps. If metering is configured, then
+ <code>burst=</code><var>burst</var> specifies the burst rate
+ limit in kilobits. <code>dscp</code> and/or <code>rate</code>
+ are required arguments.
+ </p>
+
+ <p>
+ If <code>--may-exist</code> is specified, adding a duplicated
+ QoS rule succeeds but the QoS rule is not really created.
+ Without <code>--may-exist</code>, adding a duplicated QoS rule
+ results in error.
</p>
</dd>
@@ -151,8 +162,8 @@
<var>switch</var> is supplied, all the QoS rules 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.
+ logical switch. If all the fields are supplied, then a single
+ flow that matches the given fields will be deleted.
</dd>
<dt><code>qos-list</code> <var>switch</var></dt>
--
2.17.1
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
