summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-10-11 18:14:00 +0000
committerGerrit Code Review <review@openstack.org>2016-10-11 18:14:00 +0000
commit0f02f7ea1ed285ca08ad5f1423fdf0671a3b9920 (patch)
tree3baf25d34163beb4db9af732f87e7d04435f1609 /doc/source
parent6f60817cd4377ceceff42c62599994146f362872 (diff)
parent3205dad161c6c7bcaf16f985121217b8cf320af0 (diff)
downloadpython-openstackclient-0f02f7ea1ed285ca08ad5f1423fdf0671a3b9920.tar.gz
Merge "Add network support for Network QoS policies"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/network-qos-policy.rst122
-rw-r--r--doc/source/commands.rst1
2 files changed, 123 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)
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index bf2c322a..53272f68 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -112,6 +112,7 @@ referring to both Compute and Volume quotas.
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
* ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks
* ``network rbac``: (**Network**) - an RBAC policy for network resources
+* ``network qos policy``: (**Network**) - a QoS policy for network resources
* ``network segment``: (**Network**) - a segment of a virtual network
* ``object``: (**Object Storage**) a single file in the Object Storage
* ``object store account``: (**Object Storage**) owns a group of Object Storage resources