|
2 | 2 | volume type |
3 | 3 | =========== |
4 | 4 |
|
5 | | -Block Storage v1, v2 |
| 5 | +Block Storage v1, v2, v3 |
6 | 6 |
|
7 | | -volume type create |
8 | | ------------------- |
9 | | - |
10 | | -Create new volume type |
11 | | - |
12 | | -.. program:: volume type create |
13 | | -.. code:: bash |
14 | | -
|
15 | | - openstack volume type create |
16 | | - [--description <description>] |
17 | | - [--public | --private] |
18 | | - [--property <key=value> [...] ] |
19 | | - [--project <project>] |
20 | | - [--project-domain <project-domain>] |
21 | | - [--encryption-provider <provider>] |
22 | | - [--encryption-cipher <cipher>] |
23 | | - [--encryption-key-size <key-size>] |
24 | | - [--encryption-control-location <control-location>] |
25 | | - <name> |
26 | | -
|
27 | | -.. option:: --description <description> |
28 | | - |
29 | | - Volume type description |
30 | | - |
31 | | - .. versionadded:: 2 |
32 | | - |
33 | | -.. option:: --public |
34 | | - |
35 | | - Volume type is accessible to the public |
36 | | - |
37 | | - .. versionadded:: 2 |
38 | | - |
39 | | -.. option:: --private |
40 | | - |
41 | | - Volume type is not accessible to the public |
42 | | - |
43 | | - .. versionadded:: 2 |
44 | | - |
45 | | -.. option:: --property <key=value> |
46 | | - |
47 | | - Set a property on this volume type (repeat option to set multiple properties) |
48 | | - |
49 | | -.. option:: --project <project> |
50 | | - |
51 | | - Allow <project> to access private type (name or ID) |
52 | | - (Must be used with :option:`--private` option) |
53 | | - |
54 | | - *Volume version 2 only* |
55 | | - |
56 | | -.. option:: --project-domain <project-domain> |
57 | | - |
58 | | - Domain the project belongs to (name or ID). |
59 | | - This can be used in case collisions between project names exist. |
60 | | - |
61 | | - *Volume version 2 only* |
62 | | - |
63 | | -.. option:: --encryption-provider <provider> |
64 | | - |
65 | | - Set the encryption provider format for this volume type |
66 | | - (e.g "luks" or "plain") (admin only) |
67 | | - |
68 | | - This option is required when setting encryption type of a volume. |
69 | | - Consider using other encryption options such as: :option:`--encryption-cipher`, |
70 | | - :option:`--encryption-key-size` and :option:`--encryption-control-location` |
71 | | - |
72 | | -.. option:: --encryption-cipher <cipher> |
73 | | - |
74 | | - Set the encryption algorithm or mode for this volume type |
75 | | - (e.g "aes-xts-plain64") (admin only) |
76 | | - |
77 | | -.. option:: --encryption-key-size <key-size> |
78 | | - |
79 | | - Set the size of the encryption key of this volume type |
80 | | - (e.g "128" or "256") (admin only) |
81 | | - |
82 | | -.. option:: --encryption-control-location <control-location> |
83 | | - |
84 | | - Set the notional service where the encryption is performed |
85 | | - ("front-end" or "back-end") (admin only) |
86 | | - |
87 | | - The default value for this option is "front-end" when setting encryption type of |
88 | | - a volume. Consider using other encryption options such as: :option:`--encryption-cipher`, |
89 | | - :option:`--encryption-key-size` and :option:`--encryption-provider` |
90 | | - |
91 | | -.. _volume_type_create-name: |
92 | | -.. describe:: <name> |
93 | | - |
94 | | - Volume type name |
95 | | - |
96 | | -volume type delete |
97 | | ------------------- |
98 | | - |
99 | | -Delete volume type(s) |
100 | | - |
101 | | -.. program:: volume type delete |
102 | | -.. code:: bash |
103 | | -
|
104 | | - openstack volume type delete |
105 | | - <volume-type> [<volume-type> ...] |
106 | | -
|
107 | | -.. _volume_type_delete-volume-type: |
108 | | -.. describe:: <volume-type> |
109 | | - |
110 | | - Volume type(s) to delete (name or ID) |
111 | | - |
112 | | -volume type list |
113 | | ----------------- |
114 | | - |
115 | | -List volume types |
116 | | - |
117 | | -.. program:: volume type list |
118 | | -.. code:: bash |
119 | | -
|
120 | | - openstack volume type list |
121 | | - [--long] |
122 | | - [--default | --public | --private] |
123 | | - [--encryption-type] |
124 | | -
|
125 | | -.. option:: --long |
126 | | - |
127 | | - List additional fields in output |
128 | | - |
129 | | -.. option:: --public |
130 | | - |
131 | | - List only public types |
132 | | - |
133 | | - *Volume version 2 only* |
134 | | - |
135 | | -.. option:: --private |
136 | | - |
137 | | - List only private types (admin only) |
138 | | - |
139 | | - *Volume version 2 only* |
140 | | - |
141 | | -.. option:: --default |
142 | | - |
143 | | - List the default volume type |
144 | | - |
145 | | - *Volume version 2 only* |
146 | | - |
147 | | -.. option:: --encryption-type |
148 | | - |
149 | | - Display encryption information for each volume type (admin only) |
150 | | - |
151 | | -volume type set |
152 | | ---------------- |
153 | | - |
154 | | -Set volume type properties |
155 | | - |
156 | | -.. program:: volume type set |
157 | | -.. code:: bash |
158 | | -
|
159 | | - openstack volume type set |
160 | | - [--name <name>] |
161 | | - [--description <description>] |
162 | | - [--property <key=value> [...] ] |
163 | | - [--project <project>] |
164 | | - [--project-domain <project-domain>] |
165 | | - [--encryption-provider <provider>] |
166 | | - [--encryption-cipher <cipher>] |
167 | | - [--encryption-key-size <key-size>] |
168 | | - [--encryption-control-location <control-location>] |
169 | | - <volume-type> |
170 | | -
|
171 | | -.. option:: --name <name> |
172 | | - |
173 | | - Set volume type name |
174 | | - |
175 | | - .. versionadded:: 2 |
176 | | - |
177 | | -.. option:: --description <description> |
178 | | - |
179 | | - Set volume type description |
180 | | - |
181 | | - .. versionadded:: 2 |
182 | | - |
183 | | -.. option:: --project <project> |
184 | | - |
185 | | - Set volume type access to project (name or ID) (admin only) |
186 | | - |
187 | | - *Volume version 2 only* |
188 | | - |
189 | | -.. option:: --project-domain <project-domain> |
190 | | - |
191 | | - Domain the project belongs to (name or ID). |
192 | | - This can be used in case collisions between project names exist. |
193 | | - |
194 | | -.. option:: --property <key=value> |
195 | | - |
196 | | - Set a property on this volume type (repeat option to set multiple properties) |
197 | | - |
198 | | -.. option:: --encryption-provider <provider> |
199 | | - |
200 | | - Set the encryption provider format for this volume type |
201 | | - (e.g "luks" or "plain") (admin only) |
202 | | - |
203 | | - This option is required when setting encryption type of a volume for the first time. |
204 | | - Consider using other encryption options such as: :option:`--encryption-cipher`, |
205 | | - :option:`--encryption-key-size` and :option:`--encryption-control-location` |
206 | | - |
207 | | -.. option:: --encryption-cipher <cipher> |
208 | | - |
209 | | - Set the encryption algorithm or mode for this volume type |
210 | | - (e.g "aes-xts-plain64") (admin only) |
211 | | - |
212 | | -.. option:: --encryption-key-size <key-size> |
213 | | - |
214 | | - Set the size of the encryption key of this volume type |
215 | | - (e.g "128" or "256") (admin only) |
216 | | - |
217 | | -.. option:: --encryption-control-location <control-location> |
218 | | - |
219 | | - Set the notional service where the encryption is performed |
220 | | - ("front-end" or "back-end") (admin only) |
221 | | - |
222 | | - The default value for this option is "front-end" when setting encryption type of |
223 | | - a volume for the first time. Consider using other encryption options such as: |
224 | | - :option:`--encryption-cipher`, :option:`--encryption-key-size` and :option:`--encryption-provider` |
225 | | - |
226 | | -.. _volume_type_set-volume-type: |
227 | | -.. describe:: <volume-type> |
228 | | - |
229 | | - Volume type to modify (name or ID) |
230 | | - |
231 | | -volume type show |
232 | | ----------------- |
233 | | - |
234 | | -Display volume type details |
235 | | - |
236 | | -.. program:: volume type show |
237 | | -.. code:: bash |
238 | | -
|
239 | | - openstack volume type show |
240 | | - [--encryption-type] |
241 | | - <volume-type> |
242 | | -
|
243 | | -.. option:: --encryption-type |
244 | | - |
245 | | - Display encryption information of this volume type (admin only) |
246 | | - |
247 | | -.. _volume_type_show-volume-type: |
248 | | -.. describe:: <volume-type> |
249 | | - |
250 | | - Volume type to display (name or ID) |
251 | | - |
252 | | -volume type unset |
253 | | ------------------ |
254 | | - |
255 | | -Unset volume type properties |
256 | | - |
257 | | -.. program:: volume type unset |
258 | | -.. code:: bash |
259 | | -
|
260 | | - openstack volume type unset |
261 | | - [--property <key> [...] ] |
262 | | - [--project <project>] |
263 | | - [--project-domain <project-domain>] |
264 | | - [--encryption-type] |
265 | | - <volume-type> |
266 | | -
|
267 | | -.. option:: --property <key> |
268 | | - |
269 | | - Property to remove from volume type (repeat option to remove multiple properties) |
270 | | - |
271 | | -.. option:: --project <project> |
272 | | - |
273 | | - Removes volume type access from project (name or ID) (admin only) |
274 | | - |
275 | | - *Volume version 2 only* |
276 | | - |
277 | | -.. option:: --project-domain <project-domain> |
278 | | - |
279 | | - Domain the project belongs to (name or ID). |
280 | | - This can be used in case collisions between project names exist. |
281 | | - |
282 | | - *Volume version 2 only* |
283 | | - |
284 | | -.. option:: --encryption-type |
285 | | - |
286 | | - Remove the encryption type for this volume type (admin only) |
287 | | - |
288 | | -.. _volume_type_unset-volume-type: |
289 | | -.. describe:: <volume-type> |
290 | | - |
291 | | - Volume type to modify (name or ID) |
| 7 | +.. autoprogram-cliff:: openstack.volume.v3 |
| 8 | + :command: volume type * |
0 commit comments