Search

Chapter 40. image

download PDF

This chapter describes the commands under the image command.

40.1. image add project

Associate project with image

Usage:

openstack image add project [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--noindent] [--prefix PREFIX]
                                   [--max-width <integer>] [--fit-width]
                                   [--print-empty]
                                   [--project-domain <project-domain>]
                                   <image> <project>

Table 40.1. Positional arguments
ValueSummary

<image>

Image to share (name or id)

<project>

Project to associate with image (id)

Table 40.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

Table 40.3. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 40.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 40.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 40.6. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.2. image create

Create/upload an image

Usage:

openstack image create [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--noindent] [--prefix PREFIX]
                              [--max-width <integer>] [--fit-width]
                              [--print-empty] [--id <id>]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                              [--file <file> | --volume <volume>] [--force]
                              [--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>]
                              [--project-domain <project-domain>]
                              <image-name>

Table 40.7. Positional arguments
ValueSummary

<image-name>

New image name

Table 40.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

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

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

--project-domain <project-domain>

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

Table 40.9. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 40.10. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 40.11. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 40.12. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.3. image delete

Delete image(s)

Usage:

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

Table 40.13. Positional arguments
ValueSummary

<image>

Image(s) to delete (name or id)

Table 40.14. Command arguments
ValueSummary

-h, --help

Show this help message and exit

40.4. image list

List available images

Usage:

openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--noindent] [--max-width <integer>] [--fit-width]
                            [--print-empty] [--sort-column SORT_COLUMN]
                            [--public | --private | --community | --shared]
                            [--property <key=value>] [--name <name>]
                            [--status <status>]
                            [--member-status <member-status>] [--tag <tag>]
                            [--long] [--sort <key>[:<direction>]]
                            [--limit <num-images>] [--marker <image>]

Table 40.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--public

List only public images

--private

List only private images

--community

List only community images

--shared

List only shared 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.

--tag <tag>

Filter images based on tag.

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

Table 40.16. Output formatter options
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 40.17. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 40.18. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 40.19. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.5. image member list

List projects associated with image

Usage:

openstack image member list [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--noindent] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--sort-column SORT_COLUMN]
                                   [--project-domain <project-domain>]
                                   <image>

Table 40.20. Positional arguments
ValueSummary

<image>

Image (name or id)

Table 40.21. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

Table 40.22. Output formatter options
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

Table 40.23. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 40.24. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 40.25. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.6. image remove project

Disassociate project with image

Usage:

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

Table 40.26. Positional arguments
ValueSummary

<image>

Image to unshare (name or id)

<project>

Project to disassociate with image (name or id)

Table 40.27. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

40.7. image save

Save an image locally

Usage:

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

Table 40.28. Positional arguments
ValueSummary

<image>

Image to save (name or id)

Table 40.29. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded image save filename (default: stdout)

40.8. image set

Set image properties

Usage:

openstack image set [-h] [--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]
                           <image>

Table 40.30. Positional arguments
ValueSummary

<image>

Image to modify (name or id)

Table 40.31. Command arguments
ValueSummary

-h, --help

Show this help message and exit

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

40.9. image show

Display image details

Usage:

openstack image show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--human-readable]
                            <image>

Table 40.32. Positional arguments
ValueSummary

<image>

Image to display (name or id)

Table 40.33. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--human-readable

Print image size in a human-friendly format.

Table 40.34. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

Table 40.35. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 40.36. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 40.37. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

40.10. image unset

Unset image tags and properties

Usage:

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

Table 40.38. Positional arguments
ValueSummary

<image>

Image to modify (name or id)

Table 40.39. Command arguments
ValueSummary

-h, --help

Show this help message and exit

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

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.