mirror of
https://opendev.org/openstack/python-openstackclient.git
synced 2026-01-17 07:20:45 +00:00
f5b50df8ea
We have it for v1, but v2 is the future. There are two differences, things in v2 do not go into a properties dict, and the actual image data needs to get uploaded as a second step. Closes-Bug: 1405562 Co-Authored-By: Niall Bunting <niall.bunting@hp.com> Co-Authored-By: Sean Perry <sean.perry@hp.com> Change-Id: If7b81c4a6746c8a1eb0302c96e045fb0f457d67b
397 lines
7.2 KiB
ReStructuredText
397 lines
7.2 KiB
ReStructuredText
======
|
|
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>]
|
|
[--owner <project>]
|
|
[--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> [...] ]
|
|
<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:: --owner <project>
|
|
|
|
Image owner project name or ID
|
|
|
|
*Image version 1 only.*
|
|
|
|
.. 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
|
|
|
|
.. 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>]]
|
|
|
|
.. 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
|
|
|
|
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
|
|
---------
|
|
|
|
*Only supported for Image v1*
|
|
|
|
Set image properties
|
|
|
|
.. program:: image set
|
|
.. code:: bash
|
|
|
|
os image set
|
|
[--name <name>]
|
|
[--owner <project>]
|
|
[--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> [...] ]
|
|
<image>
|
|
|
|
.. option:: --name <name>
|
|
|
|
New image name
|
|
|
|
.. option:: --owner <project>
|
|
|
|
New image owner project (name or ID)
|
|
|
|
.. 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>
|
|
|
|
Container format of image.
|
|
Acceptable formats: ['ami', 'ari', 'aki', 'bare', 'ovf']
|
|
|
|
.. option:: --disk-format <disk-format>
|
|
|
|
Disk format of image.
|
|
Acceptable formats: ['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2',
|
|
'vdi', 'iso']
|
|
|
|
.. option:: --size <size>
|
|
|
|
Size of image data (in bytes)
|
|
|
|
.. 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
|
|
|
|
.. option:: --location <image-url>
|
|
|
|
Download image from an existing URL
|
|
|
|
.. option:: --copy-from <image-url>
|
|
|
|
Copy image from the data store (similar to --location)
|
|
|
|
.. option:: --file <file>
|
|
|
|
Upload image from local file
|
|
|
|
.. option:: --volume <volume>
|
|
|
|
Update image with a volume
|
|
|
|
.. option:: --force
|
|
|
|
Force image update if volume is in use (only meaningful with --volume)
|
|
|
|
.. option:: --checksum <checksum>
|
|
|
|
Image hash used for verification
|
|
|
|
.. option:: --stdin
|
|
|
|
Allow to read image data from standard input
|
|
|
|
.. option:: --property <key=value>
|
|
|
|
Set a property on this image (repeat for multiple values)
|
|
|
|
.. 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)
|