image¶

Image v1, v2

image add project¶

Only supported for Image v2

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¶

Image v1, v2

Create/upload an image

openstack image create
    [--id <id>]
    [--store <store>]
    [--container-format <container-format>]
    [--disk-format <disk-format>]
    [--size <size>]
    [--min-disk <disk-gb>]
    [--min-ram <ram-mb>]
    [--location <image-url>]
    [--copy-from <image-url>]
    [--file <file> | --volume <volume>]
    [--force]
    [--checksum <checksum>]
    [--protected | --unprotected]
    [--public | --private | --community | --shared]
    [--property <key=value> [...] ]
    [--tag <tag> [...] ]
    [--project <project>]
    [--project-domain <project-domain>]
    <image-name>

--id <id>¶: Image ID to reserve

--store <store>¶

Upload image to this store

Image version 1 only.

--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, and ploop. The default format is: raw

--size <size>¶

Image size, in bytes (only used with --location and --copy-from)

Image version 1 only.

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

--location <image-url>¶

Download image from an existing URL

Image version 1 only.

--copy-from <image-url>¶

Copy image from the data store (similar to --location)

Image version 1 only.

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

--checksum <checksum>¶

Image hash used for verification

Image version 1 only.

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

New in version 2.

--project <project>¶: Set an alternate project on this image (name or ID). Previously known as –owner.

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

New in version 2.

<image-name>: New image name

image delete¶

Delete image(s)

openstack image delete
    <image>

<image>: Image(s) to delete (name or ID)

image list¶

List available images

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

--public¶: List only public images

--private¶: List only private images

--community¶

List only community images

Image version 2 only.

--shared¶

List only shared images

Image version 2 only.

--property <key=value>¶: Filter output based on property

--name <name>¶

Filter images based on name

Image version 2 only.

--status <status>¶

Filter images based on status

Image version 2 only

--member-status <member-status>¶

Filter images based on member status

Image version 2 only

--tag <tag>¶

Filter images based on tag

Image version 2 only

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

Image version 2 only

--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 version 2 only

image member list¶

List projects associated with image

openstack image member list
    <image>

<image>: Image(s) to view members for (name or ID)

image remove project¶

Only supported for Image v2

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¶

Image v1, v2

Set image properties

openstack image set
    [--name <name>]
    [--min-disk <disk-gb>]
    [--min-ram <ram-mb>]
    [--container-format <container-format>]
    [--disk-format <disk-format>]
    [--size <size>]
    [--protected | --unprotected]
    [--public | --private | --community | --shared]
    [--store <store>]
    [--location <image-url>]
    [--copy-from <image-url>]
    [--file <file>]
    [--volume <volume>]
    [--force]
    [--checksum <checksum>]
    [--stdin]
    [--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>

--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, and ploop.

--size <size>¶

Size of image data (in bytes)

Image version 1 only.

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

--store <store>¶

Upload image to this store

Image version 1 only.

--location <image-url>¶

Download image from an existing URL

Image version 1 only.

--copy-from <image-url>¶

Copy image from the data store (similar to --location)

Image version 1 only.

--file <file>¶

Upload image from local file

Image version 1 only.

--volume <volume>¶

Update image with a volume

Image version 1 only.

--force¶

Force image update if volume is in use (only meaningful with --volume)

Image version 1 only.

--checksum <checksum>¶

Image hash used for verification

Image version 1 only.

--stdin¶

Allow to read image data from standard input

Image version 1 only.

--property <key=value>¶: Set a property on this image (repeat option to set multiple properties)

New in version 2.

--tag <tag>¶: Set a tag on this image (repeat option to set multiple tags)

New in version 2.

--architecture <architecture>¶: Operating system architecture

New in version 2.

--instance-id <instance-id>¶: ID of server instance used to create this image

New in version 2.

--kernel-id <kernel-id>¶: ID of kernel image used to boot this disk image

New in version 2.

--os-distro <os-distro>¶: Operating system distribution name

New in version 2.

--os-version <os-version>¶: Operating system distribution version

New in version 2.

--ramdisk-id <ramdisk-id>¶: ID of ramdisk image used to boot this disk image

New in version 2.

--deactivate¶: Deactivate the image.

New in version 2.

--activate¶: Activate the image.

New in version 2.

--project <project>¶: Set an alternate project on this image (name or ID). Previously known as –owner.

--project-domain <project-domain>¶: Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

New in version 2.

--accept¶

Accept the image membership.

If –project is passed, this will update the membership status for the given project, otherwise –project will default to the project the user is authenticated to.

New in version 2.

--reject¶

Reject the image membership.

If –project is passed, this will update the membership status for the given project, otherwise –project will default to the project the user is authenticated to.

New in version 2.

--pending¶

Reset the image membership to ‘pending’.

If –project is passed, this will update the membership status for the given project, otherwise –project will default to the project the user is authenticated to.

New in version 2.

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

Only supported for Image v2

Unset image tags or 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)

image

image¶

image add project¶

image create¶

image delete¶

image list¶

image member list¶

image remove project¶

image save¶

image set¶

image show¶

image unset¶

python-openstackclient 5.2.3.dev13

Page Contents