image v2

image add project

Associate project with image

openstack image add project
    [--project-domain <project-domain>]
    <image>
    <project>
--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

image

Image to share (name or ID)

project

Project to associate with image (ID)

image create

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>
--id <id>

Image ID to reserve

--container-format <container-format>

Image container format. The supported options are: ami, ari, aki, bare, docker, ova, ovf. The default format is: bare

--disk-format <disk-format>

Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, raw, qcow2, vhdx, vdi, iso, ploop. The default format is: raw

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--min-ram <ram-mb>

Minimum RAM size needed to boot image, in megabytes

--file <file>

Upload image from local file

--volume <volume>

Create image from a volume

--force

Force image creation if volume is in use (only meaningful with –volume)

--progress

Show upload progress bar (ignored if passing data via stdin)

--sign-key-path <sign-key-path>

Sign the image using the specified private key. Only use in combination with –sign-cert-id

--sign-cert-id <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

--protected

Prevent image from being deleted

--unprotected

Allow image to be deleted (default)

--public

Image is accessible to the public

--private

Image is inaccessible to the public (default)

--community

Image is accessible to the community

--shared

Image can be shared

--property <key=value>

Set a property on this image (repeat option to set multiple properties)

--tag <tag>

Set a tag on this image (repeat option to set multiple tags)

--project <project>

Set an alternate project on this image (name or ID)

--import

Force the use of glance image import instead of direct upload

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

image-name

New image name

image delete

Delete image(s)

openstack image delete <image> [<image> ...]
image

Image(s) to delete (name or ID)

image list

List available images

openstack image list
    [--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>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--public

List only public images

--private

List only private images

--community

List only community images

--shared

List only shared images

--all

List all images

--property <key=value>

Filter output based on property (repeat option to filter on multiple properties)

--name <name>

Filter images based on name.

--status <status>

Filter images based on status.

--member-status <member-status>

Filter images based on member status. The supported options are: accepted, pending, rejected, all.

--project <project>

Search by project (admin only) (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--tag <tag>

Filter images based on tag. (repeat option to filter on multiple tags)

--hidden

List hidden images

--long

List additional fields in output

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma

--limit <num-images>

Maximum number of images to display.

--marker <image>

The last image of the previous page. Display list of images after marker. Display all images if not specified. (name or ID)

image member list

List projects associated with image

openstack image member list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--project-domain <project-domain>]
    <image>
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

image

Image (name or ID)

image metadef namespace list

List metadef namespaces

openstack image metadef namespace list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--resource-types <resource_types>]
    [--visibility <visibility>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--resource-types <resource_types>

filter resource types

--visibility <visibility>

filter on visibility

image remove project

Disassociate project with image

openstack image remove project
    [--project-domain <project-domain>]
    <image>
    <project>
--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

image

Image to unshare (name or ID)

project

Project to disassociate with image (name or ID)

image save

Save an image locally

openstack image save [--file <filename>] <image>
--file <filename>

Downloaded image save filename (default: stdout)

image

Image to save (name or ID)

image set

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>
--name <name>

New image name

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--min-ram <ram-mb>

Minimum RAM size needed to boot image, in megabytes

--container-format <container-format>

Image container format. The supported options are: ami, ari, aki, bare, docker, ova, ovf

--disk-format <disk-format>

Image disk format. The supported options are: ami, ari, aki, vhd, vmdk, raw, qcow2, vhdx, vdi, iso, ploop

--protected

Prevent image from being deleted

--unprotected

Allow image to be deleted (default)

--public

Image is accessible to the public

--private

Image is inaccessible to the public (default)

--community

Image is accessible to the community

--shared

Image can be shared

--property <key=value>

Set a property on this image (repeat option to set multiple properties)

--tag <tag>

Set a tag on this image (repeat option to set multiple tags)

--architecture <architecture>

Operating system architecture

--instance-id <instance-id>

ID of server instance used to create this image

--kernel-id <kernel-id>

ID of kernel image used to boot this disk image

--os-distro <os-distro>

Operating system distribution name

--os-version <os-version>

Operating system distribution version

--ramdisk-id <ramdisk-id>

ID of ramdisk image used to boot this disk image

--deactivate

Deactivate the image

--activate

Activate the image

--project <project>

Set an alternate project on this image (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--accept

Accept the image membership

--reject

Reject the image membership

--pending

Reset the image membership to ‘pending’

--hidden

Hide the image

--unhidden

Unhide the image

image

Image to modify (name or ID)

image show

Display image details

openstack image show [--human-readable] <image>
--human-readable

Print image size in a human-friendly format.

image

Image to display (name or ID)

image stage

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>
--file <file>

Local file that contains disk image to be uploaded. Alternatively, images can be passed via stdin.

--progress

Show upload progress bar (ignored if passing data via stdin)

image

Image to upload data for (name or ID)

image task list

List tasks

openstack image task list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--sort-key <key>[:<field>]]
    [--sort-dir <key>[:<direction>]]
    [--limit <num-tasks>]
    [--marker <task>]
    [--type <type>]
    [--status <status>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--sort-key <key>[:<field>]

Sorts the response by one of the following attributes: created_at, expires_at, id, status, type, updated_at. (default is created_at) (multiple keys and directions can be specified separated by comma)

--sort-dir <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: name:desc) (multiple keys and directions can be specified separated by comma)

--limit <num-tasks>

Maximum number of tasks to display.

--marker <task>

The last task of the previous page. Display list of tasks after marker. Display all tasks if not specified. (name or ID)

--type <type>

Filters the response by a task type.

--status <status>

Filter tasks based on status.

image task show

Display task details

openstack image task show <Task ID>
Task ID

Task to display (ID)

image unset

Unset image tags and properties

openstack image unset [--tag <tag>] [--property <property-key>] <image>
--tag <tag>

Unset a tag on this image (repeat option to unset multiple tags)

--property <property-key>

Unset a property on this image (repeat option to unset multiple properties)

image

Image to modify (name or ID)