Chapter 36. image


This chapter describes the commands under the image command.

36.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>
Copy to Clipboard Toggle word wrap

Expand
Table 36.1. Positional arguments
ValueSummary

<image>

Image to share (name or id)

<project>

Project to associate with image (id)

Expand
Table 36.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.

Expand
Table 36.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 to show multiple columns

Expand
Table 36.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 36.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.

36.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]
                              [--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>
Copy to Clipboard Toggle word wrap

Expand
Table 36.7. Positional arguments
ValueSummary

<image-name>

New image name

Expand
Table 36.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)

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

Expand
Table 36.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 to show multiple columns

Expand
Table 36.10. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.11. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 36.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.

36.3. image delete

Delete image(s)

Usage:

openstack image delete [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 36.13. Positional arguments
ValueSummary

<image>

Image(s) to delete (name or id)

Expand
Table 36.14. Command arguments
ValueSummary

-h, --help

Show this help message and exit

36.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]
                            [--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>]
Copy to Clipboard Toggle word wrap

Expand
Table 36.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

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

Expand
Table 36.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 to show multiple columns

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

Expand
Table 36.17. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 36.18. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.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.

36.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]
                                   [--sort-ascending | --sort-descending]
                                   [--project-domain <project-domain>]
                                   <image>
Copy to Clipboard Toggle word wrap

Expand
Table 36.20. Positional arguments
ValueSummary

<image>

Image (name or id)

Expand
Table 36.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.

Expand
Table 36.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 to show multiple columns

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

Expand
Table 36.23. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 36.24. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.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.

36.6. image metadef namespace create

Create a metadef namespace

Usage:

openstack image metadef namespace create [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--display-name <display_name>]
                                                [--description <description>]
                                                [--public | --private]
                                                [--protected | --unprotected]
                                                <namespace>
Copy to Clipboard Toggle word wrap

Expand
Table 36.26. Positional arguments
ValueSummary

<namespace>

New metadef namespace name

Expand
Table 36.27. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--display-name <display_name>

A user-friendly name for the namespace.

--description <description>

A description of the namespace

--public

Set namespace visibility public

--private

Set namespace visibility private

--protected

Prevent metadef namespace from being deleted

--unprotected

Allow metadef namespace to be deleted (default)

Expand
Table 36.28. 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 to show multiple columns

Expand
Table 36.29. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.30. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 36.31. 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.

36.7. image metadef namespace delete

Delete metadef namespace

Usage:

openstack image metadef namespace delete [-h]
                                                <namespace_name>
                                                [<namespace_name> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 36.32. Positional arguments
ValueSummary

<namespace_name>

An identifier (a name) for the namespace

Expand
Table 36.33. Command arguments
ValueSummary

-h, --help

Show this help message and exit

36.8. image metadef namespace list

List metadef namespaces

Usage:

openstack image metadef namespace 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]
                                              [--sort-ascending | --sort-descending]
                                              [--resource-types <resource_types>]
                                              [--visibility <visibility>]
Copy to Clipboard Toggle word wrap

Expand
Table 36.34. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--resource-types <resource_types>

Filter resource types

--visibility <visibility>

Filter on visibility

Expand
Table 36.35. 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 to show multiple columns

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

Expand
Table 36.36. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 36.37. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.38. 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.

36.9. image metadef namespace set

Set metadef namespace properties

Usage:

openstack image metadef namespace set [-h]
                                             [--display-name <display_name>]
                                             [--description <description>]
                                             [--public | --private]
                                             [--protected | --unprotected]
                                             <namespace>
Copy to Clipboard Toggle word wrap

Expand
Table 36.39. Positional arguments
ValueSummary

<namespace>

Namespace (name) for the namespace

Expand
Table 36.40. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--display-name <display_name>

Set a user-friendly name for the namespace.

--description <description>

Set the description of the namespace

--public

Set namespace visibility public

--private

Set namespace visibility private

--protected

Prevent metadef namespace from being deleted

--unprotected

Allow metadef namespace to be deleted (default)

36.10. image metadef namespace show

Show a metadef namespace

Usage:

openstack image metadef namespace show [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              <namespace_name>
Copy to Clipboard Toggle word wrap

Expand
Table 36.41. Positional arguments
ValueSummary

<namespace_name>

Namespace (name) for the namespace

Expand
Table 36.42. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 36.43. 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 to show multiple columns

Expand
Table 36.44. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.45. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 36.46. 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.

36.11. image remove project

Disassociate project with image

Usage:

openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>
Copy to Clipboard Toggle word wrap

Expand
Table 36.47. Positional arguments
ValueSummary

<image>

Image to unshare (name or id)

<project>

Project to disassociate with image (name or id)

Expand
Table 36.48. 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.

36.12. image save

Save an image locally

Usage:

openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap

Expand
Table 36.49. Positional arguments
ValueSummary

<image>

Image to save (name or id)

Expand
Table 36.50. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded image save filename (default: stdout)

36.13. 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]
                           [--hidden | --unhidden]
                           <image>
Copy to Clipboard Toggle word wrap

Expand
Table 36.51. Positional arguments
ValueSummary

<image>

Image to modify (name or id)

Expand
Table 36.52. 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 for either the project indicated by --project, if provided, or the current user’s project

--reject

Reject the image membership for either the project indicated by --project, if provided, or the current user’s project

--pending

Reset the image membership to pending

--hidden

Hide the image

--unhidden

Unhide the image

36.14. 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>
Copy to Clipboard Toggle word wrap

Expand
Table 36.53. Positional arguments
ValueSummary

<image>

Image to display (name or id)

Expand
Table 36.54. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--human-readable

Print image size in a human-friendly format.

Expand
Table 36.55. 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 to show multiple columns

Expand
Table 36.56. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.57. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 36.58. 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.

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

Usage:

openstack image stage [-h] [--file <file>] [--progress] <image>
Copy to Clipboard Toggle word wrap

Expand
Table 36.59. Positional arguments
ValueSummary

<image>

Image to upload data for (name or id)

Expand
Table 36.60. Command arguments
ValueSummary

-h, --help

Show this help message and exit

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

36.16. image task list

List tasks

Usage:

openstack image task 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]
                                 [--sort-ascending | --sort-descending]
                                 [--sort-key <key>[:<field>]]
                                 [--sort-dir <key>[:<direction>]]
                                 [--limit <num-tasks>] [--marker <task>]
                                 [--type <type>] [--status <status>]
Copy to Clipboard Toggle word wrap

Expand
Table 36.61. Command arguments
ValueSummary

-h, --help

Show this help message and exit

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

Expand
Table 36.62. 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 to show multiple columns

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

Expand
Table 36.63. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 36.64. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.65. 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.

36.17. image task show

Display task details

Usage:

openstack image task show [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty]
                                 <Task ID>
Copy to Clipboard Toggle word wrap

Expand
Table 36.66. Positional arguments
ValueSummary

<Task ID>

Task to display (id)

Expand
Table 36.67. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 36.68. 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 to show multiple columns

Expand
Table 36.69. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 36.70. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 36.71. 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.

36.18. image unset

Unset image tags and properties

Usage:

openstack image unset [-h] [--tag <tag>] [--property <property-key>]
                             <image>
Copy to Clipboard Toggle word wrap

Expand
Table 36.72. Positional arguments
ValueSummary

<image>

Image to modify (name or id)

Expand
Table 36.73. 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)

Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat