Chapter 8. Image service command-line client

The glance client is the command-line interface (CLI) for the Image service API and its extensions. This chapter documents glance version 2.0.0.
For help on a specific glance command, enter:
$ glance help COMMAND

8.1. glance usage

usage: glance [--version] [-d] [-v] [--get-schema] [--no-ssl-compression] [-f] [--os-image-url OS_IMAGE_URL] [--os-image-api-version OS_IMAGE_API_VERSION] [--profile HMAC_KEY] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-username OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--key-file OS_KEY] [--ca-file OS_CACERT] [--cert-file OS_CERT] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] <subcommand> ...

8.2. glance optional arguments

--version
show program's version number and exit
-d, --debug
Defaults to env[GLANCECLIENT_DEBUG].
-v, --verbose
Print more verbose output.
--get-schema
Ignores cached copy and forces retrieval of schema that generates portions of the help text. Ignored with API version 1.
--no-ssl-compression
DEPRECATED! This option is deprecated and not used anymore. SSL compression should be disabled by default by the system SSL library.
-f, --force
Prevent select actions from requesting user confirmation.
--os-image-url OS_IMAGE_URL
Defaults to env[OS_IMAGE_URL]. If the provided image url contains a version number and `--os-image-api- version` is omitted the version of the URL will be picked as the image api version to use.
--os-image-api-version OS_IMAGE_API_VERSION
Defaults to env[OS_IMAGE_API_VERSION] or 2.
--profile HMAC_KEY
HMAC key to use for encrypting context data for performance profiling of operation. This key should be the value of HMAC key configured in osprofiler middleware in glance, it is specified in paste configuration file at /etc/glance/api-paste.ini and /etc/glance/registry-paste.ini. Without key the profiling will not be triggered even if osprofiler is enabled on server side.
--insecure
Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-cert <certificate>
Defaults to env[OS_CERT].
--os-key <key>
Defaults to env[OS_KEY].
--timeout <seconds>
Set request timeout (in seconds).
--os-auth-url OS_AUTH_URL
Authentication URL
--os-domain-id OS_DOMAIN_ID
Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME
Domain name to scope to
--os-project-id OS_PROJECT_ID
Project ID to scope to
--os-project-name OS_PROJECT_NAME
Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project
--os-trust-id OS_TRUST_ID
Trust ID
--os-user-id OS_USER_ID
User ID
--os-username OS_USERNAME, --os-user_name OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD
User's password
--key-file OS_KEY
DEPRECATED! Use --os-key.
--ca-file OS_CACERT
DEPRECATED! Use --os-cacert.
--cert-file OS_CERT
DEPRECATED! Use --os-cert.
--os-tenant-id OS_TENANT_ID
Defaults to env[OS_TENANT_ID].
--os-tenant-name OS_TENANT_NAME
Defaults to env[OS_TENANT_NAME].
--os-region-name OS_REGION_NAME
Defaults to env[OS_REGION_NAME].
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN].
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_SERVICE_TYPE].
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE].

8.3. Image service API v1 commands

8.3.1. glance image-create (v1)

usage: glance --os-image-api-version 1 image-create [--id <IMAGE_ID>] [--name <NAME>] [--store <STORE>] [--disk-format <DISK_FORMAT>] [--container-format <CONTAINER_FORMAT>] [--owner <TENANT_ID>] [--size <SIZE>] [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] [--location <IMAGE_URL>] [--file <FILE>] [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] [--is-public {True,False}] [--is-protected {True,False}] [--property <key=value>] [--human-readable] [--progress]
Create a new image.

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

8.3.2. glance image-delete (v1)

usage: glance --os-image-api-version 1 image-delete <IMAGE> [<IMAGE> ...]
Delete specified image(s).

Positional arguments

<IMAGE>
Name or ID of image(s) to delete.

8.3.3. glance image-download (v1)

usage: glance --os-image-api-version 1 image-download [--file <FILE>] [--progress] <IMAGE>
Download a specific image.

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.

8.3.4. glance image-list (v1)

usage: glance --os-image-api-version 1 image-list [--name <NAME>] [--status <STATUS>] [--changes-since <CHANGES_SINCE>] [--container-format <CONTAINER_FORMAT>] [--disk-format <DISK_FORMAT>] [--size-min <SIZE>] [--size-max <SIZE>] [--property-filter <KEY=VALUE>] [--page-size <SIZE>] [--human-readable] [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] [--sort-dir {asc,desc}] [--is-public {True,False}] [--owner <TENANT_ID>] [--all-tenants]
List images you can access.

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.

8.3.5. glance image-show (v1)

usage: glance --os-image-api-version 1 image-show [--human-readable] [--max-column-width <integer>] <IMAGE>
Describe a specific image.

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.

8.3.6. glance image-update (v1)

usage: glance --os-image-api-version 1 image-update [--name <NAME>] [--disk-format <DISK_FORMAT>] [--container-format <CONTAINER_FORMAT>] [--owner <TENANT_ID>] [--size <SIZE>] [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] [--location <IMAGE_URL>] [--file <FILE>] [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] [--is-public {True,False}] [--is-protected {True,False}] [--property <key=value>] [--purge-props] [--human-readable] [--progress] <IMAGE>
Update a specific image.

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

8.3.7. glance member-create (v1)

usage: glance --os-image-api-version 1 member-create [--can-share] <IMAGE> <TENANT_ID>
Share a specific image with a tenant.

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.

8.3.8. glance member-delete (v1)

usage: glance --os-image-api-version 1 member-delete <IMAGE> <TENANT_ID>
Remove a shared image from a tenant.

Positional arguments

<IMAGE>
Image from which to remove member.
<TENANT_ID>
Tenant to remove as member.

8.3.9. glance member-list (v1)

usage: glance --os-image-api-version 1 member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
Describe sharing permissions by image or tenant.

Optional arguments

--image-id <IMAGE_ID>
Filter results by an image ID.
--tenant-id <TENANT_ID>
Filter results by a tenant ID.

8.4. Image service API v2 commands

You can select an API version to use by adding the --os-image-api-version parameter or by setting the corresponding environment variable:
$ export OS_IMAGE_API_VERSION=2

8.4.1. glance explain (v2)

usage: glance --os-image-api-version 2 explain <MODEL>
Describe a specific model.

Positional arguments

<MODEL>
Name of model to describe.

8.4.2. glance image-create (v2)

usage: glance --os-image-api-version 2 image-create [--architecture <ARCHITECTURE>] [--protected [True|False]] [--name <NAME>] [--instance-uuid <INSTANCE_UUID>] [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>] [--kernel-id <KERNEL_ID>] [--tags <TAGS> [<TAGS> ...]] [--os-version <OS_VERSION>] [--disk-format <DISK_FORMAT>] [--os-distro <OS_DISTRO>] [--id <ID>] [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>] [--container-format <CONTAINER_FORMAT>] [--property <key=value>] [--file <FILE>] [--progress]
Create a new image.

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>
Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)
--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
--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, docker
--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. Alternatively, the image data can be passed to the client via stdin.
--progress
Show upload progress bar.

8.4.3. glance image-deactivate (v2)

usage: glance --os-image-api-version 2 image-deactivate <IMAGE_ID>
Deactivate specified image.

Positional arguments

<IMAGE_ID>
ID of image to deactivate.

8.4.4. glance image-delete (v2)

usage: glance --os-image-api-version 2 image-delete <IMAGE_ID> [<IMAGE_ID> ...]
Delete specified image.

Positional arguments

<IMAGE_ID>
ID of image(s) to delete.

8.4.5. glance image-download (v2)

usage: glance --os-image-api-version 2 image-download [--file <FILE>] [--progress] <IMAGE_ID>
Download a specific image.

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.

8.4.6. glance image-list (v2)

usage: glance --os-image-api-version 2 image-list [--limit <LIMIT>] [--page-size <SIZE>] [--visibility <VISIBILITY>] [--member-status <MEMBER_STATUS>] [--owner <OWNER>] [--property-filter <KEY=VALUE>] [--checksum <CHECKSUM>] [--tag <TAG>] [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] [--sort-dir {asc,desc}] [--sort <key>[:<direction>]]
List images you can access.

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. May be used multiple times.
--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.

8.4.7. glance image-reactivate (v2)

usage: glance --os-image-api-version 2 image-reactivate <IMAGE_ID>
Reactivate specified image.

Positional arguments

<IMAGE_ID>
ID of image to reactivate.

8.4.8. glance image-show (v2)

usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width <integer>] <IMAGE_ID>
Describe a specific image.

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.

8.4.9. glance image-tag-delete (v2)

usage: glance --os-image-api-version 2 image-tag-delete <IMAGE_ID> <TAG_VALUE>
Delete the tag associated with the given image.

Positional arguments

<IMAGE_ID>
ID of the image from which to delete tag.
<TAG_VALUE>
Value of the tag.

8.4.10. glance image-tag-update (v2)

usage: glance --os-image-api-version 2 image-tag-update <IMAGE_ID> <TAG_VALUE>
Update an image with the given tag.

Positional arguments

<IMAGE_ID>
Image to be updated with the given tag.
<TAG_VALUE>
Value of the tag.

8.4.11. glance image-update (v2)

usage: glance --os-image-api-version 2 image-update [--architecture <ARCHITECTURE>] [--protected [True|False]] [--name <NAME>] [--instance-uuid <INSTANCE_UUID>] [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>] [--kernel-id <KERNEL_ID>] [--os-version <OS_VERSION>] [--disk-format <DISK_FORMAT>] [--os-distro <OS_DISTRO>] [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>] [--container-format <CONTAINER_FORMAT>] [--property <key=value>] [--remove-property key] <IMAGE_ID>
Update an existing image.

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>
Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)
--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
--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, docker
--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.

8.4.12. glance image-upload (v2)

usage: glance --os-image-api-version 2 image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress] <IMAGE_ID>
Upload data for a specific 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.

8.4.13. glance location-add (v2)

usage: glance --os-image-api-version 2 location-add --url <URL> [--metadata <STRING>] <IMAGE_ID>
Add a location (and related metadata) to an image.

Positional arguments

<IMAGE_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: {})

8.4.14. glance location-delete (v2)

usage: glance --os-image-api-version 2 location-delete --url <URL> <IMAGE_ID>
Remove locations (and related metadata) from an image.

Positional arguments

<IMAGE_ID>
ID of image whose locations are to be removed.

Optional arguments

--url <URL>
URL of location to remove. May be used multiple times.

8.4.15. glance location-update (v2)

usage: glance --os-image-api-version 2 location-update --url <URL> [--metadata <STRING>] <IMAGE_ID>
Update metadata of an image's location.

Positional arguments

<IMAGE_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: {})

8.4.16. glance md-namespace-create (v2)

usage: glance --os-image-api-version 2 md-namespace-create <NAMESPACE> <unavailable>
Create a new metadata definitions namespace.

Positional arguments

<NAMESPACE>
Name of the namespace.
<unavailable>
Please run with connection parameters set to retrieve the schema for generating help for this command

8.4.17. glance md-namespace-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-delete <NAMESPACE>
Delete specified metadata definitions namespace with its contents.

Positional arguments

<NAMESPACE>
Name of namespace to delete.

8.4.18. glance md-namespace-import (v2)

usage: glance --os-image-api-version 2 md-namespace-import [--file <FILEPATH>]
Import a metadata definitions namespace from file or standard input.

Optional arguments

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

8.4.19. glance md-namespace-list (v2)

usage: glance --os-image-api-version 2 md-namespace-list [--resource-types <RESOURCE_TYPES>] [--visibility <VISIBILITY>] [--page-size <SIZE>]
List metadata definitions namespaces.

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.

8.4.20. glance md-namespace-objects-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-objects-delete <NAMESPACE>
Delete all metadata definitions objects inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.21. glance md-namespace-properties-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-properties-delete <NAMESPACE>
Delete all metadata definitions property inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.22. glance md-namespace-resource-type-list (v2)

usage: glance --os-image-api-version 2 md-namespace-resource-type-list <NAMESPACE>
List resource types associated to specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.23. glance md-namespace-show (v2)

usage: glance --os-image-api-version 2 md-namespace-show [--resource-type <RESOURCE_TYPE>] [--max-column-width <integer>] <NAMESPACE>
Describe a specific metadata definitions namespace. Lists also the namespace properties, objects and resource type associations.

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.

8.4.24. glance md-namespace-tags-delete (v2)

usage: glance --os-image-api-version 2 md-namespace-tags-delete <NAMESPACE>
Delete all metadata definitions tags inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.25. glance md-namespace-update (v2)

usage: glance --os-image-api-version 2 md-namespace-update <NAMESPACE> <unavailable>
Update an existing metadata definitions 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

8.4.26. glance md-object-create (v2)

usage: glance --os-image-api-version 2 md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE>
Create a new metadata definitions object inside a namespace.

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.

8.4.27. glance md-object-delete (v2)

usage: glance --os-image-api-version 2 md-object-delete <NAMESPACE> <OBJECT>
Delete a specific metadata definitions object inside a namespace.

Positional arguments

<NAMESPACE>
Name of namespace the object belongs.
<OBJECT>
Name of an object.

8.4.28. glance md-object-list (v2)

usage: glance --os-image-api-version 2 md-object-list <NAMESPACE>
List metadata definitions objects inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.29. glance md-object-property-show (v2)

usage: glance --os-image-api-version 2 md-object-property-show [--max-column-width <integer>] <NAMESPACE> <OBJECT> <PROPERTY>
Describe a specific metadata definitions property inside an object.

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.

8.4.30. glance md-object-show (v2)

usage: glance --os-image-api-version 2 md-object-show [--max-column-width <integer>] <NAMESPACE> <OBJECT>
Describe a specific metadata definitions object inside a namespace.

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.

8.4.31. glance md-object-update (v2)

usage: glance --os-image-api-version 2 md-object-update [--name <NAME>] [--schema <SCHEMA>] <NAMESPACE> <OBJECT>
Update metadata definitions object inside a namespace.

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.

8.4.32. glance md-property-create (v2)

usage: glance --os-image-api-version 2 md-property-create --name <NAME> --title <TITLE> --schema <SCHEMA> <NAMESPACE>
Create a new metadata definitions property inside a namespace.

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.

8.4.33. glance md-property-delete (v2)

usage: glance --os-image-api-version 2 md-property-delete <NAMESPACE> <PROPERTY>
Delete a specific metadata definitions property inside a namespace.

Positional arguments

<NAMESPACE>
Name of namespace the property belongs.
<PROPERTY>
Name of a property.

8.4.34. glance md-property-list (v2)

usage: glance --os-image-api-version 2 md-property-list <NAMESPACE>
List metadata definitions properties inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.35. glance md-property-show (v2)

usage: glance --os-image-api-version 2 md-property-show [--max-column-width <integer>] <NAMESPACE> <PROPERTY>
Describe a specific metadata definitions property inside a 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.

8.4.36. glance md-property-update (v2)

usage: glance --os-image-api-version 2 md-property-update [--name <NAME>] [--title <TITLE>] [--schema <SCHEMA>] <NAMESPACE> <PROPERTY>
Update metadata definitions property inside a namespace.

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.

8.4.37. glance md-resource-type-associate (v2)

usage: glance --os-image-api-version 2 md-resource-type-associate <NAMESPACE> <unavailable>
Associate resource type with a metadata definitions namespace.

Positional arguments

<NAMESPACE>
Name of namespace.
<unavailable>
Please run with connection parameters set to retrieve the schema for generating help for this command

8.4.38. glance md-resource-type-deassociate (v2)

usage: glance --os-image-api-version 2 md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE>
Deassociate resource type with a metadata definitions namespace.

Positional arguments

<NAMESPACE>
Name of namespace.
<RESOURCE_TYPE>
Name of resource type.

8.4.39. glance md-resource-type-list (v2)

usage: glance --os-image-api-version 2 md-resource-type-list
List available resource type names.

8.4.40. glance md-tag-create (v2)

usage: glance --os-image-api-version 2 md-tag-create --name <NAME> <NAMESPACE>
Add a new metadata definitions tag inside a namespace.

Positional arguments

<NAMESPACE>
Name of the namespace the tag will belong to.

Optional arguments

--name <NAME>
The name of the new tag to add.

8.4.41. glance md-tag-create-multiple (v2)

usage: glance --os-image-api-version 2 md-tag-create-multiple --names <NAMES> [--delim <DELIM>] <NAMESPACE>
Create new metadata definitions tags inside a namespace.

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

8.4.42. glance md-tag-delete (v2)

usage: glance --os-image-api-version 2 md-tag-delete <NAMESPACE> <TAG>
Delete a specific metadata definitions tag inside a namespace.

Positional arguments

<NAMESPACE>
Name of the namespace to which the tag belongs.
<TAG>
Name of the tag.

8.4.43. glance md-tag-list (v2)

usage: glance --os-image-api-version 2 md-tag-list <NAMESPACE>
List metadata definitions tags inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.44. glance md-tag-show (v2)

usage: glance --os-image-api-version 2 md-tag-show <NAMESPACE> <TAG>
Describe a specific metadata definitions tag inside a namespace.

Positional arguments

<NAMESPACE>
Name of the namespace to which the tag belongs.
<TAG>
Name of the tag.

8.4.45. glance md-tag-update (v2)

usage: glance --os-image-api-version 2 md-tag-update --name <NAME> <NAMESPACE> <TAG>
Rename a metadata definitions tag inside a namespace.

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.

8.4.46. glance member-create (v2)

usage: glance --os-image-api-version 2 member-create <IMAGE_ID> <MEMBER_ID>
Create member for a given image.

Positional arguments

<IMAGE_ID>
Image with which to create member.
<MEMBER_ID>
Tenant to add as member.

8.4.47. glance member-delete (v2)

usage: glance --os-image-api-version 2 member-delete <IMAGE_ID> <MEMBER_ID>
Delete image member.

Positional arguments

<IMAGE_ID>
Image from which to remove member.
<MEMBER_ID>
Tenant to remove as member.

8.4.48. glance member-list (v2)

usage: glance --os-image-api-version 2 member-list --image-id <IMAGE_ID>
Describe sharing permissions by image.

Optional arguments

--image-id <IMAGE_ID>
Image to display members of.

8.4.49. glance member-update (v2)

usage: glance --os-image-api-version 2 member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS>
Update the status of a member for a given image.

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

8.4.50. glance task-create (v2)

usage: glance --os-image-api-version 2 task-create [--type <TYPE>] [--input <STRING>]
Create a new task.

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

8.4.51. glance task-list (v2)

usage: glance --os-image-api-version 2 task-list [--sort-key {id,type,status}] [--sort-dir {asc,desc}] [--page-size <SIZE>] [--type <TYPE>] [--status <STATUS>]
List tasks you can access.

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.

8.4.52. glance task-show (v2)

usage: glance --os-image-api-version 2 task-show <TASK_ID>
Describe a specific task.

Positional arguments

<TASK_ID>
ID of task to describe.

8.5. Image Service property keys

The following keys, together with the components to which they are specific, can be used with the property option for both the glance image-update and glance image-create commands. For example:
$ glance image-update IMG-UUID --property architecture=x86_64
Note
Behavior set using image properties overrides behavior set using flavors. For more information, refer to the Red Hat OpenStack Platform Cloud Admin Guide.

Table 8.1. Property keys

Specific to Key Description Supported values
All architecture The CPU architecture that must be supported by the hypervisor. For example, x86_64, arm, or ppc64. Run uname -m to get the architecture of a machine. We strongly recommend using the architecture data vocabulary defined by the libosinfo project for this purpose.
All hypervisor_type The hypervisor type. xen, qemu, kvm, lxc, uml, vmware, or hyperv
All instance_uuid For snapshot images, this is the UUID of the server used to create this image. Valid server UUID
All kernel_id The ID of an image stored in the Image Service that should be used as the kernel when booting an AMI-style image. Valid image ID
All os_distro The common name of the operating system distribution in lowercase (uses the same data vocabulary as the libosinfo project). Specify only a recognized value for this field. Deprecated values are listed to assist you in searching for the recognized value.
  • arch—Arch Linux. Do not use archlinux or org.archlinux
  • centos—Community Enterprise Operating System. Do not use org.centos or CentOS
  • debian—Debian. Do not use Debian or org.debian
  • fedora—Fedora. Do not use Fedora, org.fedora, or org.fedoraproject
  • freebsd—FreeBSD. Do not use org.freebsd, freeBSD, or FreeBSD
  • gentoo—Gentoo Linux. Do not use Gentoo or org.gentoo
  • mandrake—Mandrakelinux (MandrakeSoft) distribution. Do not use mandrakelinux or MandrakeLinux
  • mandriva—Mandriva Linux. Do not use mandrivalinux
  • mes—Mandriva Enterprise Server. Do not use mandrivaent or mandrivaES
  • msdos—Microsoft Disc Operating System. Do not use ms-dos
  • netbsd—NetBSD. Do not use NetBSD or org.netbsd
  • netware—Novell NetWare. Do not use novell or NetWare
  • openbsd—OpenBSD. Do not use OpenBSD or org.openbsd
  • opensolaris—OpenSolaris. Do not use OpenSolaris or org.opensolaris
  • opensuse—openSUSE. Do not use suse, SuSE, or org.opensuse
  • rhel—Red Hat Enterprise Linux. Do not use redhat, RedHat, or com.redhat
  • sled—SUSE Linux Enterprise Desktop. Do not use com.suse
  • ubuntu—Ubuntu. Do not use Ubuntu, com.ubuntu, org.ubuntu, or canonical
  • windows—Microsoft Windows. Do not use com.microsoft.server
All os_version The operating system version as specified by the distributor. Version number (for example, "11.10")
All ramdisk_id The ID of image stored in the Image Service that should be used as the ramdisk when booting an AMI-style image. Valid image ID
All vm_mode The virtual machine mode. This represents the host/guest ABI (application binary interface) used for the virtual machine.
  • hvm—Fully virtualized. This is the mode used by QEMU and KVM.
  • xen—Xen 3.0 paravirtualized.
  • uml—User Mode Linux paravirtualized.
  • exe—Executables in containers. This is the mode used by LXC.
libvirt API driver hw_disk_bus Specifies the type of disk controller to attach disk devices to. One of scsi, virtio, uml, xen, ide, or usb.
libvirt API driver
hw_rng_model
Adds a random-number generator device to the image's instances. The cloud administrator can enable and control device behavior by configuring the instance's flavor. By default:
  • The generator device is disabled.
  • /dev/random is used as the default entropy source. To specify a physical HW RNG device, use the following option in the nova.conf file:
    rng_dev_path=/dev/hwrng
virtio, or other supported device.
libvirt API driver hw_machine_type Enables booting an ARM system using the specified machine type. By default, if an ARM image is used and its type is not specified, Compute uses vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. Libvirt machine type. Valid types can be viewed by using the virsh capabilities command (machine types are displayed in the machine tag).
libvirt API driver hw_scsi_model Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI controller device that provides improved scalability and performance, and supports advanced SCSI hardware. virtio-scsi
libvirt API driver hw_video_model The video image driver used. vga, cirrus, vmvga, xen, or qxl
libvirt API driver hw_video_ram Maximum RAM for the video image. Used only if a hw_video:ram_max_mb value has been set in the flavor's extra_specs and that value is higher than the value set in hw_video_ram. Integer in MB (for example, '64')
libvirt API driver hw_watchdog_action Enables a virtual hardware watchdog device that carries out the specified action if the server hangs. The watchdog uses the i6300esb device (emulating a PCI Intel 6300ESB). If hw_watchdog_action is not specified, the watchdog is disabled.
  • disabled—(default) The device is not attached. Allows the user to disable the watchdog for the image, even if it has been enabled using the image's flavor.
  • reset—Forcefully reset the guest.
  • poweroff—Forcefully power off the guest.
  • pause—Pause the guest.
  • none—Only enable the watchdog; do nothing if the server hangs.
libvirt API driver os_command_line The kernel command line to be used by the libvirt driver, instead of the default. For linux containers (LXC), the value is used as arguments for initialization. This key is valid only for Amazon kernel, ramdisk, or machine images (aki, ari, or ami).
libvirt API driver and VMware API driver hw_vif_model Specifies the model of virtual network interface device to use.
The valid options depend on the configured hypervisor.
  • KVM and QEMU: e1000, ne2k_pci, pcnet, rtl8139, and virtio.
  • VMware: e1000, e1000e, VirtualE1000, VirtualE1000e, VirtualPCNet32, VirtualSriovEthernetCard, and VirtualVmxnet.
  • Xen: e1000, netfront, ne2k_pci, pcnet, and rtl8139.
VMware API driver vmware_adaptertype The virtual SCSI or IDE controller used by the hypervisor. lsiLogic, busLogic, or ide
VMware API driver vmware_ostype A VMware GuestID which describes the operating system installed in the image. This value is passed to the hypervisor when creating a virtual machine. If not specified, the key defaults to otherGuest. See thinkvirt.com.
VMware API driver vmware_image_version Currently unused. 1
XenAPI driver auto_disk_config If true, the root partition on the disk is automatically resized before the instance boots. This value is only taken into account by the Compute service when using a Xen-based hypervisor with the XenAPI driver. The Compute service will only attempt to resize if there is a single partition on the image, and only if the partition is in ext3 or ext4 format. true | false
XenAPI driver os_type The operating system installed on the image. The XenAPI driver contains logic that takes different actions depending on the value of the os_type parameter of the image. For example, for os_type=windows images, it creates a FAT32-based swap partition instead of a Linux swap partition, and it limits the injected host name to less than 16 characters. linux or windows