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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
======
image
======
Image v1, v2
image create
------------
*Image v1, v2*
Create/upload an image
.. program:: image create
.. code:: bash
os image create
[--id <id>]
[--store <store>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--size <size>]
[--min-disk <disk-gb>]
[--min-ram <ram-mb>]
[--location <image-url>]
[--copy-from <image-url>]
[--file <file>]
[--volume <volume>]
[--force]
[--checksum <checksum>]
[--protected | --unprotected]
[--public | --private]
[--property <key=value> [...] ]
[--tag <tag> [...] ]
[--project <project> [--project-domain <project-domain>]]
<image-name>
.. option:: --id <id>
Image ID to reserve
.. option:: --store <store>
Upload image to this store
*Image version 1 only.*
.. option:: --container-format <container-format>
Image container format (default: bare)
.. option:: --disk-format <disk-format>
Image disk format (default: raw)
.. option:: --size <size>
Image size, in bytes (only used with --location and --copy-from)
*Image version 1 only.*
.. option:: --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
.. option:: --min-ram <disk-ram>
Minimum RAM size needed to boot image, in megabytes
.. option:: --location <image-url>
Download image from an existing URL
*Image version 1 only.*
.. option:: --copy-from <image-url>
Copy image from the data store (similar to --location)
*Image version 1 only.*
.. option:: --file <file>
Upload image from local file
.. option:: --volume <volume>
Create image from a volume
.. option:: --force
Force image creation if volume is in use (only meaningful with --volume)
.. option:: --checksum <checksum>
Image hash used for verification
*Image version 1 only.*
.. option:: --protected
Prevent image from being deleted
.. option:: --unprotected
Allow image to be deleted (default)
.. option:: --public
Image is accessible to the public
.. option:: --private
Image is inaccessible to the public (default)
.. option:: --property <key=value>
Set a property on this image (repeat for multiple values)
.. option:: --tag <tag>
Set a tag on this image (repeat for multiple values)
.. versionadded:: 2
.. option:: --project <project>
Set an alternate project on this image (name or ID).
Previously known as `--owner`.
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. versionadded:: 2
.. describe:: <image-name>
New image name
image delete
------------
Delete image(s)
.. program:: image delete
.. code:: bash
os image delete
<image>
.. describe:: <image>
Image(s) to delete (name or ID)
image list
----------
List available images
.. program:: image list
.. code:: bash
os image list
[--public | --private | --shared]
[--property <key=value>]
[--long]
[--sort <key>[:<direction>]]
[--limit <limit>]
[--marker <marker>]
.. option:: --public
List only public images
.. option:: --private
List only private images
.. option:: --shared
List only shared images
*Image version 2 only.*
.. option:: --property <key=value>
Filter output based on property
.. option:: --long
List additional fields in output
.. option:: --sort <key>[:<direction>]
Sort output by selected keys and directions(asc or desc) (default: asc),
multiple keys and directions can be specified separated by comma
.. option:: --limit <limit>
Maximum number of images to display.
.. option:: --marker <marker>
The last image (name or ID) of the previous page. Display list of images
after marker. Display all images if not specified.
image save
----------
Save an image locally
.. program:: image save
.. code:: bash
os image save
--file <filename>
<image>
.. option:: --file <filename>
Downloaded image save filename (default: stdout)
.. describe:: <image>
Image to save (name or ID)
image set
---------
*Image v1, v2*
Set image properties
.. program:: image set
.. code:: bash
os image set
[--name <name>]
[--min-disk <disk-gb>]
[--min-ram <disk-ram>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--size <size>]
[--protected | --unprotected]
[--public | --private]
[--store <store>]
[--location <image-url>]
[--copy-from <image-url>]
[--file <file>]
[--volume <volume>]
[--force]
[--checksum <checksum>]
[--stdin]
[--property <key=value> [...] ]
[--tag <tag> [...] ]
[--architecture <architecture>]
[--instance-id <instance-id>]
[--kernel-id <kernel-id>]
[--os-distro <os-distro>]
[--os-version <os-version>]
[--ramdisk-id <ramdisk-id>]
[--activate|--deactivate]
[--project <project> [--project-domain <project-domain>]]
<image>
.. option:: --name <name>
New image name
.. option:: --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
.. option:: --min-ram <disk-ram>
Minimum RAM size needed to boot image, in megabytes
.. option:: --container-format <container-format>
Image container format (default: bare)
.. option:: --disk-format <disk-format>
Image disk format (default: raw)
.. option:: --size <size>
Size of image data (in bytes)
*Image version 1 only.*
.. option:: --protected
Prevent image from being deleted
.. option:: --unprotected
Allow image to be deleted (default)
.. option:: --public
Image is accessible to the public
.. option:: --private
Image is inaccessible to the public (default)
.. option:: --store <store>
Upload image to this store
*Image version 1 only.*
.. option:: --location <image-url>
Download image from an existing URL
*Image version 1 only.*
.. option:: --copy-from <image-url>
Copy image from the data store (similar to --location)
*Image version 1 only.*
.. option:: --file <file>
Upload image from local file
*Image version 1 only.*
.. option:: --volume <volume>
Update image with a volume
*Image version 1 only.*
.. option:: --force
Force image update if volume is in use (only meaningful with --volume)
*Image version 1 only.*
.. option:: --checksum <checksum>
Image hash used for verification
*Image version 1 only.*
.. option:: --stdin
Allow to read image data from standard input
*Image version 1 only.*
.. option:: --property <key=value>
Set a property on this image (repeat option to set multiple properties)
.. versionadded:: 2
.. option:: --tag <tag>
Set a tag on this image (repeat for multiple values)
.. versionadded:: 2
.. option:: --architecture <architecture>
Operating system architecture
.. versionadded:: 2
.. option:: --instance-id <instance-id>
ID of server instance used to create this image
.. versionadded:: 2
.. option:: --kernel-id <kernel-id>
ID of kernel image used to boot this disk image
.. versionadded:: 2
.. option:: --os-distro <os-distro>
Operating system distribution name
.. versionadded:: 2
.. option:: --os-version <os-version>
Operating system distribution version
.. versionadded:: 2
.. option:: --ramdisk-id <ramdisk-id>
ID of ramdisk image used to boot this disk image
.. versionadded:: 2
.. option:: --activate
Activate the image.
.. versionadded:: 2
.. option:: --deactivate
Deactivate the image.
.. versionadded:: 2
.. option:: --project <project>
Set an alternate project on this image (name or ID).
Previously known as `--owner`.
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. versionadded:: 2
.. describe:: <image>
Image to modify (name or ID)
image show
----------
Display image details
.. program:: image show
.. code:: bash
os image show
<image>
.. describe:: <image>
Image to display (name or ID)
image add project
-----------------
*Only supported for Image v2*
Associate project with image
.. program:: image add project
.. code:: bash
os image add project
[--project-domain <project-domain>]
<image> <project>
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. describe:: <image>
Image to share (name or ID).
.. describe:: <project>
Project to associate with image (name or ID)
image remove project
--------------------
*Only supported for Image v2*
Disassociate project with image
.. program:: image remove project
.. code:: bash
os image remove remove
[--project-domain <project-domain>]
<image> <project>
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. describe:: <image>
Image to unshare (name or ID).
.. describe:: <project>
Project to disassociate with image (name or ID)
|
