summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/volume-qos.rst
blob: 52c1f2d4845de6033e2c2ef9fafde3b186f610ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
==========
volume qos
==========

Block Storage v1, v2

volume qos associate
--------------------

Associate a QoS specification to a volume type

.. program:: volume qos associate
.. code:: bash

    openstack volume qos associate
        <qos-spec>
        <volume-type>

.. _volume_qos_associate:
.. 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

    openstack 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)

.. _volume_qos_create-name:
.. describe:: <name>

    New QoS specification name

volume qos delete
-----------------

Delete QoS specification

.. program:: volume qos delete
.. code:: bash

    openstack volume qos delete
         [--force]
         <qos-spec> [<qos-spec> ...]

.. option:: --force

    Allow to delete in-use QoS specification(s)

.. _volume_qos_delete-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 disassociate
.. code:: bash

    openstack 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

.. _volume_qos_disassociate-qos-spec:
.. describe:: <qos-spec>

    QoS specification to modify (name or ID)

volume qos list
---------------

List QoS specifications

.. program:: volume qos list
.. code:: bash

    openstack volume qos list

volume qos set
--------------

Set QoS specification properties

.. program:: volume qos set
.. code:: bash

    openstack volume qos set
        [--no-property]
        [--property <key=value> [...] ]
        <qos-spec>

.. option:: --no-property

    Remove all properties from :ref:`\<snapshot\> <volume_qos_set-qos-spec>`
    (specify both :option:`--no-property` and :option:`--property` to
    remove the current properties before setting new properties.)

.. option:: --property <key=value>

    Property to add or modify for this QoS specification (repeat option to set multiple properties)

.. _volume_qos_set-qos-spec:
.. describe:: <qos-spec>

    QoS specification to modify (name or ID)

volume qos show
---------------

Display QoS specification details

.. program:: volume qos show
.. code:: bash

    openstack volume qos show
        <qos-spec>

.. _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

    openstack volume qos unset
        [--property <key> [...] ]
        <qos-spec>

.. option:: --property <key>

    Property to remove from QoS specification (repeat option to remove multiple properties)

.. _volume_qos_unset-qos-spec:
.. describe:: <qos-spec>

    QoS specification to modify (name or ID)