summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/network-qos-policy.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/network-qos-policy.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/network-qos-policy.rst')
-rw-r--r--doc/source/cli/command-objects/network-qos-policy.rst145
1 files changed, 145 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/network-qos-policy.rst b/doc/source/cli/command-objects/network-qos-policy.rst
new file mode 100644
index 00000000..a75c32fe
--- /dev/null
+++ b/doc/source/cli/command-objects/network-qos-policy.rst
@@ -0,0 +1,145 @@
+==================
+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
+
+ openstack 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.
+
+.. _network_qos_policy_create-name:
+.. describe:: <name>
+
+ New QoS policy specification name
+
+network qos policy delete
+-------------------------
+
+Delete Network QoS policy
+
+.. program:: network qos policy delete
+.. code:: bash
+
+ openstack network qos policy delete
+ <qos-policy> [<qos-policy> ...]
+
+.. _network_qos_policy_delete-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
+
+ openstack network qos policy list
+ [--project <project> [--project-domain <project-domain>]]
+ [--share | --no-share]
+
+.. option:: --project <project>
+
+ List qos policies according to their 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.
+
+.. option:: --share
+
+ List qos policies shared between projects
+
+.. option:: --no-share
+
+ List qos policies not shared between projects
+
+network qos policy set
+----------------------
+
+Set Network QoS policy properties
+
+.. program:: network qos policy set
+.. code:: bash
+
+ openstack 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
+
+.. _network_qos_policy_set-qos-policy:
+.. describe:: <qos-policy>
+
+ Network QoS policy to modify (name or ID)
+
+network qos policy show
+-----------------------
+
+Display Network QoS policy details
+
+.. program:: network qos policy show
+.. code:: bash
+
+ openstack network qos policy show
+ <qos-policy>
+
+.. _network_qos_policy_show-qos-policy:
+.. describe:: <qos-policy>
+
+ Network QoS policy to display (name or ID)