Skip to content

Commit 862afd1

Browse files
author
Steve Martinelli
committed
Add docs for QoS specs
QoS v1 was recently included in openstackclient. We should include command object docs. Change-Id: I891231be095324bf55eb7ee4bb86debdf7a26f05
1 parent 4c3f2ed commit 862afd1

1 file changed

Lines changed: 154 additions & 0 deletions

File tree

‎doc/source/command-objects/volume_qos.rst‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
==========
2+
volume qos
3+
==========
4+
5+
volume v1, v2
6+
7+
volume qos associate
8+
--------------------
9+
10+
Associate a QoS specification to a volume type
11+
12+
.. program:: volume qos associate
13+
.. code:: bash
14+
15+
os volume qos associate
16+
<qos-specs>
17+
<volume-type>
18+
19+
.. describe:: <qos-specs>
20+
21+
QoS specification to modify (name or ID)
22+
23+
.. describe:: <volume-type>
24+
25+
Volume type to associate the QoS (name or ID)
26+
27+
volume qos create
28+
-----------------
29+
30+
Create new QoS Specification
31+
32+
.. program:: volume qos create
33+
.. code:: bash
34+
35+
os volume qos create
36+
[--consumer <consumer>]
37+
[--property <key=value> [...] ]
38+
<name>
39+
40+
.. option:: --consumer <consumer>
41+
42+
Consumer of the QoS. Valid consumers: 'front-end', 'back-end', 'both' (defaults to 'both')
43+
44+
.. option:: --property <key=value>
45+
46+
Set a property on this QoS specification (repeat option to set multiple properties)
47+
48+
.. describe:: <name>
49+
50+
New QoS specification name
51+
52+
volume qos delete
53+
-----------------
54+
55+
Delete QoS specification
56+
57+
.. program:: volume qos delete
58+
.. code:: bash
59+
60+
os volume qos delete
61+
<qos-specs>
62+
63+
.. describe:: <qos-specs>
64+
65+
QoS specification to delete (name or ID)
66+
67+
volume qos disassociate
68+
-----------------------
69+
70+
Disassociate a QoS specification from a volume type
71+
72+
.. program:: volume qos disassoiate
73+
.. code:: bash
74+
75+
os volume qos disassociate
76+
--volume-type <volume-type> | --all
77+
<qos-specs>
78+
79+
.. option:: --volume-type <volume-type>
80+
81+
Volume type to disassociate the QoS from (name or ID)
82+
83+
.. option:: --all
84+
85+
Disassociate the QoS from every volume type
86+
87+
.. describe:: <qos-specs>
88+
89+
QoS specification to modify (name or ID)
90+
91+
volume qos list
92+
---------------
93+
94+
List QoS specifications
95+
96+
.. program:: volume qos list
97+
.. code:: bash
98+
99+
os volume qos list
100+
101+
volume qos set
102+
--------------
103+
104+
Set QoS specification properties
105+
106+
.. program:: volume qos set
107+
.. code:: bash
108+
109+
os volume qos set
110+
[--property <key=value> [...] ]
111+
<qos-specs>
112+
113+
.. option:: --property <key=value>
114+
115+
Property to add or modify for this QoS specification (repeat option to set multiple properties)
116+
117+
.. describe:: <qos-specs>
118+
119+
QoS specification to modify (name or ID)
120+
121+
volume qos show
122+
---------------
123+
124+
Display QoS specification details
125+
126+
.. program:: volume qos show
127+
.. code:: bash
128+
129+
os volume qos show
130+
<qos-specs>
131+
132+
.. describe:: <qos-specs>
133+
134+
QoS specification to display (name or ID)
135+
136+
volume qos unset
137+
----------------
138+
139+
Unset QoS specification properties
140+
141+
.. program:: volume qos unset
142+
.. code:: bash
143+
144+
os volume qos unset
145+
[--property <key>]
146+
<qos-specs>
147+
148+
.. option:: --property <key>
149+
150+
Property to remove from QoS specification (repeat option to remove multiple properties)
151+
152+
.. describe:: <qos-specs>
153+
154+
QoS specification to modify (name or ID)

0 commit comments

Comments
 (0)