summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorRodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>2016-08-05 09:57:24 +0100
committerRodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>2017-01-09 18:05:30 +0000
commit6b114cd98f4a1bc95cb8702db02eeb625be6b3e7 (patch)
tree6c91995c34d1430e623d339a933ddcd2a3873d34 /doc/source/command-objects
parent1957690754961aed8bf9c7894e3ab140a9f2c0b9 (diff)
downloadpython-openstackclient-6b114cd98f4a1bc95cb8702db02eeb625be6b3e7.tar.gz
Add support for Network QoS rule commands
Added following commands: - network qos rule create --type minimum-bandwidth dscp-marking limit-bandwidth - network qos rule delete - network qos rule list - network qos rule set - network qos rule show Closes-Bug: 1609472 Depends-On: I2e8869750024a8ccbc7777b95fe8ef6e26ec0885 Depends-On: Ife549ff6499217ca65e2554be8ef86ea7866b2d8 Change-Id: Ib3e1951f0917f5f23c8d9e0a380d19da2b3af5f0
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/network-qos-rule.rst165
1 files changed, 165 insertions, 0 deletions
diff --git a/doc/source/command-objects/network-qos-rule.rst b/doc/source/command-objects/network-qos-rule.rst
new file mode 100644
index 00000000..b98244b1
--- /dev/null
+++ b/doc/source/command-objects/network-qos-rule.rst
@@ -0,0 +1,165 @@
+================
+network qos rule
+================
+
+A **Network QoS rule** specifies a rule defined in a Network QoS policy; its
+type is defined by the parameter 'type'. Can be assigned, within a Network QoS
+policy, to a port or a network. Each Network QoS policy can contain several
+rules, each of them
+
+Network v2
+
+network qos rule create
+-----------------------
+
+Create new Network QoS rule
+
+.. program:: network qos rule create
+.. code:: bash
+
+ os network qos rule create
+ --type <type>
+ [--max-kbps <max-kbps>]
+ [--max-burst-kbits <max-burst-kbits>]
+ [--dscp-marks <dscp-marks>]
+ [--min-kbps <min-kbps>]
+ [--ingress | --egress]
+ <qos-policy>
+
+.. option:: --type <type>
+
+ QoS rule type (minimum-bandwidth, dscp-marking, bandwidth-limit)
+
+.. option:: --max-kbps <min-kbps>
+
+ Maximum bandwidth in kbps
+
+.. option:: --max-burst-kbits <max-burst-kbits>
+
+ Maximum burst in kilobits, 0 means automatic
+
+.. option:: --dscp-mark <dscp-mark>
+
+ DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50,
+ 52, and 54
+
+.. option:: --min-kbps <min-kbps>
+
+ Minimum guaranteed bandwidth in kbps
+
+.. option:: --ingress
+
+ Ingress traffic direction from the project point of view
+
+.. option:: --egress
+
+ Egress traffic direction from the project point of view
+
+.. describe:: <qos-policy>
+
+ QoS policy that contains the rule (name or ID)
+
+network qos rule delete
+-----------------------
+
+Delete Network QoS rule
+
+.. program:: network qos rule delete
+.. code:: bash
+
+ os network qos rule delete
+ <qos-policy>
+ <rule-id>
+
+.. describe:: <qos-policy>
+
+ QoS policy that contains the rule (name or ID)
+
+.. describe:: <rule-id>
+
+ Network QoS rule to delete (ID)
+
+network qos rule list
+---------------------
+
+List Network QoS rules
+
+.. program:: network qos rule list
+.. code:: bash
+
+ os network qos rule list
+ <qos-policy>
+
+.. describe:: <qos-policy>
+
+ QoS policy that contains the rule (name or ID)
+
+network qos rule set
+--------------------
+
+Set Network QoS rule properties
+
+.. program:: network qos rule set
+.. code:: bash
+
+ os network qos rule set
+ [--max-kbps <max-kbps>]
+ [--max-burst-kbits <max-burst-kbits>]
+ [--dscp-marks <dscp-marks>]
+ [--min-kbps <min-kbps>]
+ [--ingress | --egress]
+ <qos-policy>
+ <rule-id>
+
+.. option:: --max-kbps <min-kbps>
+
+ Maximum bandwidth in kbps
+
+.. option:: --max-burst-kbits <max-burst-kbits>
+
+ Maximum burst in kilobits, 0 means automatic
+
+.. option:: --dscp-mark <dscp-mark>
+
+ DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50,
+ 52, and 54
+
+.. option:: --min-kbps <min-kbps>
+
+ Minimum guaranteed bandwidth in kbps
+
+.. option:: --ingress
+
+ Ingress traffic direction from the project point of view
+
+.. option:: --egress
+
+ Egress traffic direction from the project point of view
+
+.. describe:: <qos-policy>
+
+ QoS policy that contains the rule (name or ID)
+
+.. describe:: <rule-id>
+
+ Network QoS rule to delete (ID)
+
+network qos rule show
+---------------------
+
+Display Network QoS rule details
+
+.. program:: network qos rule show
+.. code:: bash
+
+ os network qos rule show
+ <qos-policy>
+ <rule-id>
+
+.. describe:: <qos-policy>
+
+ QoS policy that contains the rule (name or ID)
+
+.. describe:: <rule-id>
+
+ Network QoS rule to delete (ID)