Chapter 8. Image service command-line client

Optional arguments

--id <IMAGE_ID>

ID of image to reserve.

--name <NAME>

Name of image.

--store <STORE>

Store to upload image to.

--disk-format <DISK_FORMAT>

Disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.

--container-format <CONTAINER_FORMAT>

Container format of image. Acceptable formats: ami, ari, aki, bare, and ovf.

--owner <TENANT_ID>

Tenant who should own image.

--size <SIZE>

Size of image data (in bytes). Only used with '-- location' and '--copy_from'.

--min-disk <DISK_GB>

Minimum size of disk needed to boot image (in gigabytes).

--min-ram <DISK_RAM>

Minimum amount of ram needed to boot image (in megabytes).

--location <IMAGE_URL>

URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'. (Note: '%3A' is ':' URL encoded.)

--file <FILE>

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

--checksum <CHECKSUM>

Hash of image data used Glance can use for verification. Provide a md5 checksum here.

--copy-from <IMAGE_URL>

Similar to '--location' in usage, but this indicates that the Glance server should immediately copy the data and store it in its configured image store.

Note

The --copy-from option has been deprecated for glance v2 for the Red Hat OpenStack Platform 8 release and will be deprecated for v1 as well in the future releases of Red Hat OpenStack Platform.

--is-public {True,False}

Make image accessible to the public.

--is-protected {True,False}

Prevent image from being deleted.

--property <key=value>

Arbitrary property to associate with image. May be used multiple times.

--human-readable

Print image size in a human-friendly format.

--progress

Show upload progress bar.

Positional arguments

<IMAGE>

Name or ID of image(s) to delete.

Positional arguments

<IMAGE>

Name or ID of image to download.

Optional arguments

--file <FILE>

Local file to save downloaded image data to. If this is not specified and there is no redirection the image data will be not be saved.

--progress

Show download progress bar.

Optional arguments

--name <NAME>

Filter images to those that have this name.

--status <STATUS>

Filter images to those that have this status.

--changes-since <CHANGES_SINCE>

Filter images to those that changed since the given time, which will include the deleted images.

--container-format <CONTAINER_FORMAT>

Filter images to those that have this container format. Acceptable formats: ami, ari, aki, bare, and ovf.

--disk-format <DISK_FORMAT>

Filter images to those that have this disk format. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.

--size-min <SIZE>

Filter images to those with a size greater than this.

--size-max <SIZE>

Filter images to those with a size less than this.

--property-filter <KEY=VALUE>

Filter images by a user-defined image property.

--page-size <SIZE>

Number of images to request in each paginated request.

--human-readable

Print image size in a human-friendly format.

--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}

Sort image list by specified field.

--sort-dir {asc,desc}

Sort image list in specified direction.

--is-public {True,False}

Allows the user to select a listing of public or non public images.

--owner <TENANT_ID>

Display only images owned by this tenant id. Filtering occurs on the client side so may be inefficient. This option is mainly intended for admin use. Use an empty string ('') to list images with no owner. Note: This option overrides the --is-public argument if present. Note: the v2 API supports more efficient server-side owner based filtering.

--all-tenants

Allows the admin user to list all images irrespective of the image's owner or is_public value.

Positional arguments

<IMAGE>

Name or ID of image to describe.

Optional arguments

--human-readable

Print image size in a human-friendly format.

--max-column-width <integer>

The max column width of the printed table.

Positional arguments

<IMAGE>

Name or ID of image to modify.

Optional arguments

--name <NAME>

Name of image.

--disk-format <DISK_FORMAT>

Disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.

--container-format <CONTAINER_FORMAT>

Container format of image. Acceptable formats: ami, ari, aki, bare, and ovf.

--owner <TENANT_ID>

Tenant who should own image.

--size <SIZE>

Size of image data (in bytes).

--min-disk <DISK_GB>

Minimum size of disk needed to boot image (in gigabytes).

--min-ram <DISK_RAM>

Minimum amount of ram needed to boot image (in megabytes).

--location <IMAGE_URL>

URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'. (Note: '%3A' is ':' URL encoded.) This option only works for images in 'queued' status.

--file <FILE>

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

--checksum <CHECKSUM>

Hash of image data used Glance can use for verification.

--copy-from <IMAGE_URL>

Similar to '--location' in usage, but this indicates that the Glance server should immediately copy the data and store it in its configured image store. This option only works for images in 'queued' status.

Note

The --copy-from option has been deprecated for glance v2 for the Red Hat OpenStack Platform 8 release and will be deprecated for v1 as well in the future releases of Red Hat OpenStack Platform.

--is-public {True,False}

Make image accessible to the public.

--is-protected {True,False}

Prevent image from being deleted.

--property <key=value>

Arbitrary property to associate with image. May be used multiple times.

--purge-props

If this flag is present, delete all image properties not explicitly set in the update request. Otherwise, those properties not referenced are preserved.

--human-readable

Print image size in a human-friendly format.

--progress

Show upload progress bar.

Positional arguments

<IMAGE>

Image to add member to.

<TENANT_ID>

Tenant to add as member

Optional arguments

--can-share

Allow the specified tenant to share this image.

Positional arguments

<IMAGE>

Image from which to remove member.

<TENANT_ID>

Tenant to remove as member.

Optional arguments

--image-id <IMAGE_ID>

Filter results by an image ID.

--tenant-id <TENANT_ID>

Filter results by a tenant ID.

Positional arguments

<MODEL>

Name of model to describe.

Optional arguments

--architecture <ARCHITECTURE>

Operating system architecture as specified in http://docs.openstack.org/trunk/openstack- compute/admin/content/adding-images.html

--protected [True|False]

If true, image will not be deletable.

--name <NAME>

Descriptive name for the image

--instance-uuid <INSTANCE_UUID>

ID of instance used to create this image.

--min-disk <MIN_DISK>

Amount of disk space (in GB) required to boot image.

--visibility <VISIBILITY>

Scope of image accessibility Valid values: public, private

--kernel-id <KERNEL_ID>

ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.

--tags <TAGS> [<TAGS> ...]

List of strings related to the image

--os-version <OS_VERSION>

Operating system version as specified by the distributor

--disk-format <DISK_FORMAT>

Format of the disk Valid values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso

--self <SELF>

(READ-ONLY)

--os-distro <OS_DISTRO>

Common name of operating system distribution as specified in http://docs.openstack.org/trunk /openstack-compute/admin/content/adding-images.html

--id <ID>

An identifier for the image

--owner <OWNER>

Owner of the image

--ramdisk-id <RAMDISK_ID>

ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.

--min-ram <MIN_RAM>

Amount of ram (in MB) required to boot image.

--container-format <CONTAINER_FORMAT>

Format of the container Valid values: ami, ari, aki, bare, ovf, ova

--property <key=value>

Arbitrary property to associate with image. May be used multiple times.

--file <FILE>

Local file that contains disk image to be uploaded during creation. Must be present if images are not passed to the client via stdin.

--progress

Show upload progress bar.

Positional arguments

<IMAGE_ID>

ID of image to delete.

Positional arguments

<IMAGE_ID>

ID of image to download.

Optional arguments

--file <FILE>

Local file to save downloaded image data to. If this is not specified and there is no redirection the image data will be not be saved.

--progress

Show download progress bar.

Optional arguments

--limit <LIMIT>

Maximum number of images to get.

--page-size <SIZE>

Number of images to request in each paginated request.

--visibility <VISIBILITY>

The visibility of the images to display.

--member-status <MEMBER_STATUS>

The status of images to display.

--owner <OWNER>

Display images owned by <OWNER>.

--property-filter <KEY=VALUE>

Filter images by a user-defined image property.

--checksum <CHECKSUM>

Displays images that match the checksum.

--tag <TAG>

Filter images by a user-defined tag.

--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}

Sort image list by specified fields.

--sort-dir {asc,desc}

Sort image list in specified directions.

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

Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: name, status, container_format, disk_format, size, id, created_at, updated_at. OPTIONAL.

Positional arguments

<IMAGE_ID>

ID of image to describe.

Optional arguments

--human-readable

Print image size in a human-friendly format.

--max-column-width <integer>

The max column width of the printed table.

Positional arguments

<IMAGE_ID>

ID of the image from which to delete tag.

<TAG_VALUE>

Value of the tag.

Positional arguments

<IMAGE_ID>

Image to be updated with the given tag.

<TAG_VALUE>

Value of the tag.

Positional arguments

<IMAGE_ID>

ID of image to update.

Optional arguments

--architecture <ARCHITECTURE>

Operating system architecture as specified in http://docs.openstack.org/trunk/openstack- compute/admin/content/adding-images.html

--protected [True|False]

If true, image will not be deletable.

--name <NAME>

Descriptive name for the image

--instance-uuid <INSTANCE_UUID>

ID of instance used to create this image.

--min-disk <MIN_DISK>

Amount of disk space (in GB) required to boot image.

--visibility <VISIBILITY>

Scope of image accessibility Valid values: public, private

--kernel-id <KERNEL_ID>

ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.

--os-version <OS_VERSION>

Operating system version as specified by the distributor

--disk-format <DISK_FORMAT>

Format of the disk Valid values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso

--self <SELF>

(READ-ONLY)

--os-distro <OS_DISTRO>

Common name of operating system distribution as specified in http://docs.openstack.org/trunk /openstack-compute/admin/content/adding-images.html

--owner <OWNER>

Owner of the image

--ramdisk-id <RAMDISK_ID>

ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.

--min-ram <MIN_RAM>

Amount of ram (in MB) required to boot image.

--container-format <CONTAINER_FORMAT>

Format of the container Valid values: ami, ari, aki, bare, ovf, ova

--property <key=value>

Arbitrary property to associate with image. May be used multiple times.

--remove-property

key Name of arbitrary property to remove from the image.

Positional arguments

<IMAGE_ID>

ID of image to upload data to.

Optional arguments

--file <FILE>

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

--size <IMAGE_SIZE>

Size in bytes of image to be uploaded. Default is to get size from provided data object but this is supported in case where size cannot be inferred.

--progress

Show upload progress bar.

Positional arguments

<ID>

ID of image to which the location is to be added.

Optional arguments

--url <URL>

URL of location to add.

--metadata <STRING>

Metadata associated with the location. Must be a valid JSON object (default: {})

Positional arguments

<ID>

ID of image whose locations are to be removed.

Optional arguments

--url <URL>

URL of location to remove. May be used multiple times.

Positional arguments

<ID>

ID of image whose location is to be updated.

Optional arguments

--url <URL>

URL of location to update.

--metadata <STRING>

Metadata associated with the location. Must be a valid JSON object (default: {})

Positional arguments

<NAMESPACE>

Name of the namespace.

<unavailable>

Please run with connection parameters set to retrieve the schema for generating help for this command

Positional arguments

<NAMESPACE>

Name of namespace to delete.

Optional arguments

--file <FILEPATH>

Path to file with namespace schema to import. Alternatively, namespaces schema can be passed to the client via stdin.

Optional arguments

--resource-types <RESOURCE_TYPES>

Resource type to filter namespaces.

--visibility <VISIBILITY>

Visibility parameter to filter namespaces.

--page-size <SIZE>

Number of namespaces to request in each paginated request.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of namespace to describe.

Optional arguments

--resource-type <RESOURCE_TYPE>

Applies prefix of given resource type associated to a namespace to all properties of a namespace.

--max-column-width <integer>

The max column width of the printed table.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of namespace to update.

<unavailable>

Please run with connection parameters set to retrieve the schema for generating help for this command

Positional arguments

<NAMESPACE>

Name of namespace the object will belong.

Optional arguments

--name <NAME>

Internal name of an object.

--schema <SCHEMA>

Valid JSON schema of an object.

Positional arguments

<NAMESPACE>

Name of namespace the object belongs.

<OBJECT>

Name of an object.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of namespace the object belongs.

<OBJECT>

Name of an object.

<PROPERTY>

Name of a property.

Optional arguments

--max-column-width <integer>

The max column width of the printed table.

Positional arguments

<NAMESPACE>

Name of namespace the object belongs.

<OBJECT>

Name of an object.

Optional arguments

--max-column-width <integer>

The max column width of the printed table.

Positional arguments

<NAMESPACE>

Name of namespace the object belongs.

<OBJECT>

Name of an object.

Optional arguments

--name <NAME>

New name of an object.

--schema <SCHEMA>

Valid JSON schema of an object.

Positional arguments

<NAMESPACE>

Name of namespace the property will belong.

Optional arguments

--name <NAME>

Internal name of a property.

--title <TITLE>

Property name displayed to the user.

--schema <SCHEMA>

Valid JSON schema of a property.

Positional arguments

<NAMESPACE>

Name of namespace the property belongs.

<PROPERTY>

Name of a property.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of namespace the property belongs.

<PROPERTY>

Name of a property.

Optional arguments

--max-column-width <integer>

The max column width of the printed table.

Positional arguments

<NAMESPACE>

Name of namespace the property belongs.

<PROPERTY>

Name of a property.

Optional arguments

--name <NAME>

New name of a property.

--title <TITLE>

Property name displayed to the user.

--schema <SCHEMA>

Valid JSON schema of a property.

Positional arguments

<NAMESPACE>

Name of namespace.

<unavailable>

Please run with connection parameters set to retrieve the schema for generating help for this command

Positional arguments

<NAMESPACE>

Name of namespace.

<RESOURCE_TYPE>

Name of resource type.

Positional arguments

<NAMESPACE>

Name of the namespace the tag will belong to.

Optional arguments

--name <NAME>

The name of the new tag to add.

Positional arguments

<NAMESPACE>

Name of the namespace the tags will belong to.

Optional arguments

--names <NAMES>

A comma separated list of tag names.

--delim <DELIM>

The delimiter used to separate the names (if none is provided then the default is a comma).

Positional arguments

<NAMESPACE>

Name of the namespace to which the tag belongs.

<TAG>

Name of the tag.

Positional arguments

<NAMESPACE>

Name of namespace.

Positional arguments

<NAMESPACE>

Name of the namespace to which the tag belongs.

<TAG>

Name of the tag.

Positional arguments

<NAMESPACE>

Name of the namespace to which the tag belongs.

<TAG>

Name of the old tag.

Optional arguments

--name <NAME>

New name of the new tag.

Positional arguments

<IMAGE_ID>

Image with which to create member.

<MEMBER_ID>

Tenant to add as member.

Positional arguments

<IMAGE_ID>

Image from which to remove member.

<MEMBER_ID>

Tenant to remove as member.

Optional arguments

--image-id <IMAGE_ID>

Image to display members of.

Positional arguments

<IMAGE_ID>

Image from which to update member.

<MEMBER_ID>

Tenant to update.

<MEMBER_STATUS>

Updated status of member. Valid Values: accepted, rejected, pending

Optional arguments

--type <TYPE>

Type of Task. Please refer to Glance schema or documentation to see which tasks are supported.

--input <STRING>

Parameters of the task to be launched

Optional arguments

--sort-key {id,type,status}

Sort task list by specified field.

--sort-dir {asc,desc}

Sort task list in specified direction.

--page-size <SIZE>

Number of tasks to request in each paginated request.

--type <TYPE>

Filter tasks to those that have this type.

--status <STATUS>

Filter tasks to those that have this status.

Positional arguments

<TASK_ID>

ID of task to describe.