このコンテンツは選択した言語では利用できません。

Chapter 39. image


This chapter describes the commands under the image command.

39.1. image add project

Usage:

openstack image add project [-h] [-f {json,shell,table,value,yaml}]

                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 [--project-domain <project-domain>]
                                 <image> <project>
Copy to Clipboard Toggle word wrap

Associate project with image

Expand
Table 39.1. Positional Arguments
ValueSummary

<image>

Image to share (name or id)

<project>

Project to associate with image (name or id)

Expand
Table 39.2. Optional 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 39.3. Output Formatters
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

Expand
Table 39.4. Table Formatter
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.

Expand
Table 39.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 39.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

39.2. image create

Usage:

openstack image create [-h] [-f {json,shell,table,value,yaml}]

                            [-c COLUMN] [--max-width <integer>]
                            [--fit-width] [--print-empty] [--noindent]
                            [--prefix PREFIX] [--id <id>]
                            [--container-format <container-format>]
                            [--disk-format <disk-format>]
                            [--min-disk <disk-gb>] [--min-ram <ram-mb>]
                            [--file <file> | --volume <volume>] [--force]
                            [--protected | --unprotected]
                            [--public | --private | --community | --shared]
                            [--property <key=value>] [--tag <tag>]
                            [--project <project>]
                            [--project-domain <project-domain>]
                            <image-name>
Copy to Clipboard Toggle word wrap

Create/upload an image

Expand
Table 39.7. Positional Arguments
ValueSummary

<image-name>

New image name

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

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

Expand
Table 39.9. Output Formatters
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

Expand
Table 39.10. Table Formatter
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.

Expand
Table 39.11. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 39.12. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

39.3. image delete

Usage:

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

Delete image(s)

Expand
Table 39.13. Positional Arguments
ValueSummary

<image>

Image(s) to delete (name or id)

Expand
Table 39.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

39.4. image list

Usage:

openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                          [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [--sort-column SORT_COLUMN]
                          [--public | --private | --community | --shared]
                          [--property <key=value>] [--name <name>]
                          [--status <status>] [--tag <tag>] [--long]
                          [--sort <key>[:<direction>]]
                          [--limit <num-images>] [--marker <image>]
Copy to Clipboard Toggle word wrap

List available images

Expand
Table 39.15. Optional 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

--name <name>

Filter images based on name.

--status <status>

Filter images based on status.

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

Expand
Table 39.16. Output Formatters
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

Expand
Table 39.17. Table Formatter
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.

Expand
Table 39.18. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 39.19. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

39.5. image member list

Usage:

openstack image member list [-h] [-f {csv,json,table,value,yaml}]

                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--sort-column SORT_COLUMN]
                                 [--project-domain <project-domain>]
                                 <image>
Copy to Clipboard Toggle word wrap

List projects associated with image

Expand
Table 39.20. Positional Arguments
ValueSummary

<image>

Image (name or id)

Expand
Table 39.21. Optional 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 39.22. Output Formatters
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

Expand
Table 39.23. Table Formatter
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.

Expand
Table 39.24. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 39.25. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

39.6. image remove project

Usage:

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

                                    <image> <project>
Copy to Clipboard Toggle word wrap

Disassociate project with image

Expand
Table 39.26. Positional Arguments
ValueSummary

<image>

Image to unshare (name or id)

<project>

Project to disassociate with image (name or id)

Expand
Table 39.27. Optional 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.

39.7. image save

Usage:

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

Save an image locally

Expand
Table 39.28. Positional Arguments
ValueSummary

<image>

Image to save (name or id)

Expand
Table 39.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Downloaded image save filename (default: stdout)

39.8. image set

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

Set image properties

Expand
Table 39.30. Positional Arguments
ValueSummary

<image>

Image to modify (name or id)

Expand
Table 39.31. Optional 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'

39.9. image show

Usage:

openstack image show [-h] [-f {json,shell,table,value,yaml}]

                          [-c COLUMN] [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent] [--prefix PREFIX]
                          [--human-readable]
                          <image>
Copy to Clipboard Toggle word wrap

Display image details

Expand
Table 39.32. Positional Arguments
ValueSummary

<image>

Image to display (name or id)

Expand
Table 39.33. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--human-readable

Print image size in a human-friendly format.

Expand
Table 39.34. Output Formatters
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

Expand
Table 39.35. Table Formatter
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.

Expand
Table 39.36. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 39.37. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

39.10. image unset

Usage:

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

                           <image>
Copy to Clipboard Toggle word wrap

Unset image tags and properties

Expand
Table 39.38. Positional Arguments
ValueSummary

<image>

Image to modify (name or id)

Expand
Table 39.39. Optional 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

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat