summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorRodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>2016-08-02 09:42:21 +0100
committerDean Troyer <dtroyer@gmail.com>2016-10-11 15:08:36 +0000
commit3205dad161c6c7bcaf16f985121217b8cf320af0 (patch)
treee7f332fc10903866bb897f0c08af116a3841a674 /doc/source/command-objects
parent762f2f2c34814b8bfc615696918d8cb49b93a1dd (diff)
downloadpython-openstackclient-3205dad161c6c7bcaf16f985121217b8cf320af0.tar.gz
Add network support for Network QoS policies
Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/network-qos-policy.rst122
1 files changed, 122 insertions, 0 deletions
diff --git a/doc/source/command-objects/network-qos-policy.rst b/doc/source/command-objects/network-qos-policy.rst
new file mode 100644
index 00000000..f1e54976
--- /dev/null
+++ b/doc/source/command-objects/network-qos-policy.rst
@@ -0,0 +1,122 @@
+==================
+network qos policy
+==================
+
+A **Network QoS policy** groups a number of Network QoS rules, applied to a
+network or a port.
+
+Network v2
+
+network qos policy create
+-------------------------
+
+Create new Network QoS policy
+
+.. program:: network qos policy create
+.. code:: bash
+
+ os network qos policy create
+ [--description <description>]
+ [--share | --no-share]
+ [--project <project>]
+ [--project-domain <project-domain>]
+ <name>
+
+.. option:: --description <description>
+
+ Description of the QoS policy
+
+.. option:: --share
+
+ Make the QoS policy accessible by other projects
+
+.. option:: --no-share
+
+ Make the QoS policy not accessible by other projects (default)
+
+.. option:: --project <project>
+
+ Owner's project (name or ID)
+
+.. option:: --project-domain <project-domain>]
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+.. describe:: <name>
+
+ New QoS policy specification name
+
+network qos policy delete
+-------------------------
+
+Delete Network QoS policy
+
+.. program:: network qos policy delete
+.. code:: bash
+
+ os network qos policy delete
+ <qos-policy> [<qos-policy> ...]
+
+.. describe:: <qos-policy>
+
+ Network QoS policy(s) to delete (name or ID)
+
+network qos policy list
+-----------------------
+
+List Network QoS policies
+
+.. program:: network qos policy list
+.. code:: bash
+
+ os network qos policy list
+
+network qos policy set
+----------------------
+
+Set Network QoS policy properties
+
+.. program:: network qos policy set
+.. code:: bash
+
+ os network qos policy set
+ [--name <name>]
+ [--description <description>]
+ [--share | --no-share]
+ <qos-policy>
+
+.. option:: --name <name>
+
+ Name of the QoS policy
+
+.. option:: --description <description>
+
+ Description of the QoS policy
+
+.. option:: --share
+
+ Make the QoS policy accessible by other projects
+
+.. option:: --no-share
+
+ Make the QoS policy not accessible by other projects
+
+.. describe:: <qos-policy>
+
+ Network QoS policy(s) to delete (name or ID)
+
+network qos policy show
+-----------------------
+
+Display Network QoS policy details
+
+.. program:: network qos policy show
+.. code:: bash
+
+ os network qos policy show
+ <qos-policy>
+
+.. describe:: <qos-policy>
+
+ Network QoS policy(s) to show (name or ID)