summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/volume-qos.rst
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-08-06 22:24:22 -0700
committerSteve Martinelli <stevemar@ca.ibm.com>2015-08-06 22:24:22 -0700
commitcb8590ffb3bf79a2754e913d3cc05b2b8318b8bc (patch)
tree488066a64f8885d5c89b06c1d5d16b2c14b9765f /doc/source/command-objects/volume-qos.rst
parent35833c94efd27a497f4dffbdbd17329a6e65cd2a (diff)
downloadpython-openstackclient-cb8590ffb3bf79a2754e913d3cc05b2b8318b8bc.tar.gz
Rename command docs to remove underscores
For consistency, use dashes instead of underscores. Change-Id: I2da19b56952a8a9d172793ae211bdc58ddff4146
Diffstat (limited to 'doc/source/command-objects/volume-qos.rst')
-rw-r--r--doc/source/command-objects/volume-qos.rst154
1 files changed, 154 insertions, 0 deletions
diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst
new file mode 100644
index 00000000..d0fe36f9
--- /dev/null
+++ b/doc/source/command-objects/volume-qos.rst
@@ -0,0 +1,154 @@
+==========
+volume qos
+==========
+
+volume v1, v2
+
+volume qos associate
+--------------------
+
+Associate a QoS specification to a volume type
+
+.. program:: volume qos associate
+.. code:: bash
+
+ os volume qos associate
+ <qos-spec>
+ <volume-type>
+
+.. describe:: <qos-spec>
+
+ QoS specification to modify (name or ID)
+
+.. describe:: <volume-type>
+
+ Volume type to associate the QoS (name or ID)
+
+volume qos create
+-----------------
+
+Create new QoS Specification
+
+.. program:: volume qos create
+.. code:: bash
+
+ os volume qos create
+ [--consumer <consumer>]
+ [--property <key=value> [...] ]
+ <name>
+
+.. option:: --consumer <consumer>
+
+ Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both')
+
+.. option:: --property <key=value>
+
+ Set a property on this QoS specification (repeat option to set multiple properties)
+
+.. describe:: <name>
+
+ New QoS specification name
+
+volume qos delete
+-----------------
+
+Delete QoS specification
+
+.. program:: volume qos delete
+.. code:: bash
+
+ os volume qos delete
+ <qos-spec> [<qos-spec> ...]
+
+.. describe:: <qos-spec>
+
+ QoS specification(s) to delete (name or ID)
+
+volume qos disassociate
+-----------------------
+
+Disassociate a QoS specification from a volume type
+
+.. program:: volume qos disassoiate
+.. code:: bash
+
+ os volume qos disassociate
+ --volume-type <volume-type> | --all
+ <qos-spec>
+
+.. option:: --volume-type <volume-type>
+
+ Volume type to disassociate the QoS from (name or ID)
+
+.. option:: --all
+
+ Disassociate the QoS from every volume type
+
+.. describe:: <qos-spec>
+
+ QoS specification to modify (name or ID)
+
+volume qos list
+---------------
+
+List QoS specifications
+
+.. program:: volume qos list
+.. code:: bash
+
+ os volume qos list
+
+volume qos set
+--------------
+
+Set QoS specification properties
+
+.. program:: volume qos set
+.. code:: bash
+
+ os volume qos set
+ [--property <key=value> [...] ]
+ <qos-spec>
+
+.. option:: --property <key=value>
+
+ Property to add or modify for this QoS specification (repeat option to set multiple properties)
+
+.. describe:: <qos-spec>
+
+ QoS specification to modify (name or ID)
+
+volume qos show
+---------------
+
+Display QoS specification details
+
+.. program:: volume qos show
+.. code:: bash
+
+ os volume qos show
+ <qos-spec>
+
+.. describe:: <qos-spec>
+
+ QoS specification to display (name or ID)
+
+volume qos unset
+----------------
+
+Unset QoS specification properties
+
+.. program:: volume qos unset
+.. code:: bash
+
+ os volume qos unset
+ [--property <key>]
+ <qos-spec>
+
+.. option:: --property <key>
+
+ Property to remove from QoS specification (repeat option to remove multiple properties)
+
+.. describe:: <qos-spec>
+
+ QoS specification to modify (name or ID)