Image v2
Create/upload an image
openstack image create
[--id <id>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--min-disk <disk-gb>]
[--min-ram <ram-mb>]
[--file <file> | --volume <volume>]
[--force]
[--progress]
[--sign-key-path <sign-key-path>]
[--sign-cert-id <sign-cert-id>]
[--protected | --unprotected]
[--public | --private | --community | --shared]
[--property <key=value>]
[--tag <tag>]
[--project <project>]
[--import]
[--project-domain <project-domain>]
<image-name>
Image ID to reserve
Image container format. The supported options are: ami, ari, aki, bare, docker, ova, ovf. The default format is: bare
Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, raw, qcow2, vhdx, vdi, iso, ploop. The default format is: raw
Minimum disk size needed to boot image, in gigabytes
Minimum RAM size needed to boot image, in megabytes
Upload image from local file
Create image from a volume
Force image creation if volume is in use (only meaningful with –volume)
Show upload progress bar (ignored if passing data via stdin)
Sign the image using the specified private key. Only use in combination with –sign-cert-id
The specified certificate UUID is a reference to the certificate in the key manager that corresponds to the public key and is used for signature validation. Only use in combination with –sign-key-path
Prevent image from being deleted
Allow image to be deleted (default)
Image is accessible to the public
Image is inaccessible to the public (default)
Image is accessible to the community
Image can be shared
Set a property on this image (repeat option to set multiple properties)
Set a tag on this image (repeat option to set multiple tags)
Set an alternate project on this image (name or ID)
Force the use of glance image import instead of direct upload
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
New image name
Delete image(s)
openstack image delete [--store <STORE>] <image> [<image> ...]
Store to delete image(s) from.
Image(s) to delete (name or ID)
List available images
openstack image list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--public | --private | --community | --shared | --all]
[--property <key=value>]
[--name <name>]
[--status <status>]
[--member-status <member-status>]
[--project <project>]
[--project-domain <project-domain>]
[--tag <tag>]
[--hidden]
[--long]
[--sort <key>[:<direction>]]
[--limit <num-images>]
[--marker <image>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List only public images
List only private images
List only community images
List only shared images
List all images
Filter output based on property (repeat option to filter on multiple properties)
Filter images based on name.
Filter images based on status.
Filter images based on member status. The supported options are: accepted, pending, rejected, all.
Search by project (admin only) (name or ID)
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Filter images based on tag. (repeat option to filter on multiple tags)
List hidden images
List additional fields in output
Sort output by selected keys and directions (asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma
Maximum number of images to display.
The last image of the previous page. Display list of images after marker. Display all images if not specified. (name or ID)
Save an image locally
openstack image save [--file <filename>] <image>
Downloaded image save filename (default: stdout)
Image to save (name or ID)
Set image properties
openstack image set
[--name <name>]
[--min-disk <disk-gb>]
[--min-ram <ram-mb>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--protected | --unprotected]
[--public | --private | --community | --shared]
[--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>]
[--deactivate | --activate]
[--project <project>]
[--project-domain <project-domain>]
[--accept | --reject | --pending]
[--hidden | --unhidden]
<image>
New image name
Minimum disk size needed to boot image, in gigabytes
Minimum RAM size needed to boot image, in megabytes
Image container format. The supported options are: ami, ari, aki, bare, docker, ova, ovf
Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, raw, qcow2, vhdx, vdi, iso, ploop
Prevent image from being deleted
Allow image to be deleted (default)
Image is accessible to the public
Image is inaccessible to the public (default)
Image is accessible to the community
Image can be shared
Set a property on this image (repeat option to set multiple properties)
Set a tag on this image (repeat option to set multiple tags)
Operating system architecture
ID of server instance used to create this image
ID of kernel image used to boot this disk image
Operating system distribution name
Operating system distribution version
ID of ramdisk image used to boot this disk image
Deactivate the image
Activate the image
Set an alternate project on this image (name or ID)
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Accept the image membership for either the project indicated by ‘–project’, if provided, or the current user’s project
Reject the image membership for either the project indicated by ‘–project’, if provided, or the current user’s project
Reset the image membership to ‘pending’
Hide the image
Unhide the image
Image to modify (name or ID)
Unset image tags and properties
openstack image unset [--tag <tag>] [--property <property-key>] <image>
Unset a tag on this image (repeat option to unset multiple tags)
Unset a property on this image (repeat option to unset multiple properties)
Image to modify (name or ID)
Display image details
openstack image show [--human-readable] <image>
Print image size in a human-friendly format.
Image to display (name or ID)
Upload data for a specific image to staging. This requires support for the interoperable image import process, which was first introduced in Image API version 2.6 (Glance 16.0.0 (Queens))
openstack image stage [--file <file>] [--progress] <image>
Local file that contains disk image to be uploaded. Alternatively, images can be passed via stdin.
Show upload progress bar (ignored if passing data via stdin)
Image to upload data for (name or ID)
Initiate the image import process. This requires support for the interoperable image import process, which was first introduced in Image API version 2.6 (Glance 16.0.0 (Queens))
openstack image import
[--method <method>]
[--uri <uri>]
[--remote-image <REMOTE_IMAGE>]
[--remote-region <REMOTE_GLANCE_REGION>]
[--remote-service-interface <REMOTE_SERVICE_INTERFACE>]
[--store [<STORE> ...]
|
--all-stores ALL_STORES
]
[--allow-failure]
[--disallow-failure]
[--wait]
<image>
Import method used for image import process. Not all deployments will support all methods. The ‘glance-direct’ method (default) requires images be first staged using the ‘image-stage’ command.
URI to download the external image (only valid with the ‘web-download’ import method)
The image of remote glance (ID only) to be imported (only valid with the ‘glance-download’ import method)
The remote Glance region to download the image from (only valid with the ‘glance-download’ import method)
The remote Glance service interface to use when importing images (only valid with the ‘glance-download’ import method)
Backend store to upload image to (specify multiple times to upload to multiple stores) (either ‘–store’ or ‘–all-stores’ required with the ‘copy-image’ import method)
Make image available to all stores (either ‘–store’ or ‘–all-stores’ required with the ‘copy-image’ import method)
When uploading to multiple stores, indicate that the import should be continue should any of the uploads fail. Only usable with –stores or –all-stores
When uploading to multiple stores, indicate that the import should be reverted should any of the uploads fail. Only usable with –stores or –all-stores
Wait for operation to complete
Image to initiate import process for (name or ID)
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.