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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
======
volume
======
Block Storage v1, v2
volume create
-------------
Create new volume
.. program:: volume create
.. code:: bash
os volume create
--size <size>
[--snapshot <snapshot>]
[--description <description>]
[--type <volume-type>]
[--user <user>]
[--project <project>]
[--availability-zone <availability-zone>]
[--image <image>]
[--source <volume>]
[--property <key=value> [...] ]
<name>
.. option:: --size <size> (required)
New volume size in GB
.. option:: --snapshot <snapshot>
Use <snapshot> as source of new volume
.. option:: --description <description>
New volume description
.. option:: --type <volume-type>
Use <volume-type> as the new volume type
.. option:: --user <user>
Specify an alternate user (name or ID)
.. option:: --project <project>
Specify an alternate project (name or ID)
.. option:: --availability-zone <availability-zone>
Create new volume in <availability-zone>
.. option:: --image <image>
Use <image> as source of new volume (name or ID)
.. option:: --source <source>
Volume to clone (name or ID)
.. option:: --property <key=value>
Set a property on this volume (repeat option to set multiple properties)
.. describe:: <name>
New volume name
The :option:`--project` and :option:`--user` options are typically only
useful for admin users, but may be allowed for other users depending on
the policy of the cloud and the roles granted to the user.
volume delete
-------------
Delete volume(s)
.. program:: volume delete
.. code:: bash
os volume delete
[--force]
<volume> [<volume> ...]
.. option:: --force
Attempt forced removal of volume(s), regardless of state (defaults to False)
.. describe:: <volume>
Volume(s) to delete (name or ID)
volume list
-----------
List volumes
.. program:: volume list
.. code:: bash
os volume list
[--all-projects]
[--project <project> [--project-domain <project-domain>]]
[--user <user> [--user-domain <user-domain>]]
[--name <name>]
[--status <status>]
[--long]
.. option:: --project <project>
Filter results by project (name or ID) (admin only)
*Volume version 2 only*
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
*Volume version 2 only*
.. option:: --user <user>
Filter results by user (name or ID) (admin only)
*Volume version 2 only*
.. option:: --user-domain <user-domain>
Domain the user belongs to (name or ID).
This can be used in case collisions between user names exist.
*Volume version 2 only*
.. option:: --name <name>
Filter results by volume name
.. option:: --status <status>
Filter results by status
.. option:: --all-projects
Include all projects (admin only)
.. option:: --long
List additional fields in output
volume set
----------
Set volume properties
.. program:: volume set
.. code:: bash
os volume set
[--name <name>]
[--description <description>]
[--size <size>]
[--property <key=value> [...] ]
<volume>
.. option:: --name <name>
New volume name
.. option:: --description <description>
New volume description
.. option:: --size <size>
Extend volume size in GB
.. option:: --property <key=value>
Property to add or modify for this volume (repeat option to set multiple properties)
.. describe:: <volume>
Volume to modify (name or ID)
volume show
-----------
Show volume details
.. program:: volume show
.. code:: bash
os volume show
<volume>
.. describe:: <volume>
Volume to display (name or ID)
volume unset
------------
Unset volume properties
.. program:: volume unset
.. code:: bash
os volume unset
[--property <key>]
<volume>
.. option:: --property <key>
Property to remove from volume (repeat option to remove multiple properties)
.. describe:: <volume>
Volume to modify (name or ID)
|
