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

usage: glance [--version] [-d] [-v] [--get-schema] [--timeout TIMEOUT] [--no-ssl-compression] [-f] [--os-image-url OS_IMAGE_URL] [--os-image-api-version OS_IMAGE_API_VERSION] [-k] [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY] [--key-file OS_KEY] [--os-cacert <ca-certificate-file>] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_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-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--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> ... image-create Create a new image. image-delete Delete specified image(s). image-download Download a specific image. image-list List images you can access. image-show Describe a specific image. image-update Update a specific image. member-create Share a specific image with a tenant. member-delete Remove a shared image from a tenant. member-list Describe sharing permissions by image or tenant. bash-completion Prints all of the commands and options to stdout so that the help Display help about this program or one of its subcommands.

--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. --timeout TIMEOUT Number of seconds to wait for a response --no-ssl-compression Disable SSL compression when using https. -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 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 1. -k, --insecure Explicitly allow glanceclient to perform "insecure SSL" (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. --os-cert OS_CERT Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. --cert-file OS_CERT DEPRECATED! Use --os-cert. --os-key OS_KEY Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your cert file. --key-file OS_KEY DEPRECATED! Use --os-key. --os-cacert <ca-certificate-file> Path of CA TLS certificate(s) used to verify the remote server's certificate. Without this option glance looks for the default system CA certificates. --ca-file OS_CACERT DEPRECATED! Use --os-cacert. --os-username OS_USERNAME Defaults to env[OS_USERNAME]. --os-user-id OS_USER_ID Defaults to env[OS_USER_ID]. --os-user-domain-id OS_USER_DOMAIN_ID Defaults to env[OS_USER_DOMAIN_ID]. --os-user-domain-name OS_USER_DOMAIN_NAME Defaults to env[OS_USER_DOMAIN_NAME]. --os-project-id OS_PROJECT_ID Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID]. --os-project-name OS_PROJECT_NAME Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME]. --os-project-domain-id OS_PROJECT_DOMAIN_ID Defaults to env[OS_PROJECT_DOMAIN_ID]. --os-project-domain-name OS_PROJECT_DOMAIN_NAME Defaults to env[OS_PROJECT_DOMAIN_NAME]. --os-password OS_PASSWORD Defaults to env[OS_PASSWORD]. --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-auth-url OS_AUTH_URL Defaults to env[OS_AUTH_URL]. --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].

usage: glance 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. --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.

usage: glance image-delete <IMAGE> [<IMAGE> ...] Delete specified image(s). <IMAGE> Name or ID of image(s) to delete.

usage: glance image-list [--name <NAME>] [--status <STATUS>] [--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. --name <NAME> Filter images to those that have this name. --status <STATUS> Filter images to those that have this status. --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.

usage: glance image-show [--human-readable] [--max-column-width <integer>] <IMAGE> Describe a specific image. <IMAGE> Name or ID of image to describe. --human-readable Print image size in a human-friendly format. --max-column-width <integer> The max column width of the printed table.

usage: glance 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. <IMAGE> Name or ID of image to modify. --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.) --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. --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.

usage: glance member-create [--can-share] <IMAGE> <TENANT_ID> Share a specific image with a tenant. <IMAGE> Image to add member to. <TENANT_ID> Tenant to add as member --can-share Allow the specified tenant to share this image.

usage: glance member-delete <IMAGE> <TENANT_ID> Remove a shared image from a tenant. <IMAGE> Image from which to remove member. <TENANT_ID> Tenant to remove as member.

usage: glance member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>] Describe sharing permissions by image or tenant. --image-id <IMAGE_ID> Filter results by an image ID. --tenant-id <TENANT_ID> Filter results by a tenant ID.

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

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

usage: glance --os-image-api-version 2 image-create [--property <key=value>] [--file <FILE>] [--progress] <unavailable> Create a new image. <unavailable> Please run with connection parameters set to retrieve the schema for generating help for this command --property <key=value> Arbitrary property to associate with image. May be used multiple times. --file <FILE> Local file to save downloaded image data to. If this is not specified the image data will be written to stdout. --progress Show upload progress bar.

usage: glance --os-image-api-version 2 image-delete <IMAGE_ID> Delete specified image. <IMAGE_ID> ID of image to delete.

usage: glance --os-image-api-version 2 image-download [--file <FILE>] [--progress] <IMAGE_ID> Download a specific image. <IMAGE_ID> ID of image to download. --file <FILE> Local file to save downloaded image data to. If this is not specified the image data will be written to stdout. --progress Show download progress bar.

usage: glance --os-image-api-version 2 image-list [--page-size <SIZE>] [--visibility <VISIBILITY>] [--member-status <MEMBER_STATUS>] [--owner <OWNER>] [--property-filter <KEY=VALUE>] [--checksum <CHECKSUM>] [--tag <TAG>] List images you can access. --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.

usage: glance --os-image-api-version 2 image-show [--max-column-width <integer>] <IMAGE_ID> Describe a specific image. <IMAGE_ID> ID of image to describe. --max-column-width <integer> The max column width of the printed table.

usage: glance --os-image-api-version 2 image-tag-delete <IMAGE_ID> <TAG_VALUE> Delete the tag associated with the given image. <IMAGE_ID> ID of the image from which to delete tag. <TAG_VALUE> Value of the tag.

usage: glance --os-image-api-version 2 image-tag-update <IMAGE_ID> <TAG_VALUE> Update an image with the given tag. <IMAGE_ID> Image to be updated with the given tag. <TAG_VALUE> Value of the tag.

usage: glance --os-image-api-version 2 image-update [--property <key=value>] [--remove-property key] <IMAGE_ID> <unavailable> Update an existing image. <IMAGE_ID> ID of image to update. <unavailable> Please run with connection parameters set to retrieve the schema for generating help for this command --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.

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

usage: glance --os-image-api-version 2 location-add --url <URL> [--metadata <STRING>] <ID> Add a location (and related metadata) to an image. <ID> ID of image to which the location is to be added. --url <URL> URL of location to add. --metadata <STRING> Metadata associated with the location. Must be a valid JSON object (default: {})

usage: glance --os-image-api-version 2 location-delete --url <URL> <ID> Remove locations (and related metadata) from an image. <ID> ID of image whose locations are to be removed. --url <URL> URL of location to remove. May be used multiple times.

usage: glance --os-image-api-version 2 location-update --url <URL> [--metadata <STRING>] <ID> Update metadata of an image's location. <ID> ID of image whose location is to be updated. --url <URL> URL of location to update. --metadata <STRING> Metadata associated with the location. Must be a valid JSON object (default: {})

usage: glance --os-image-api-version 2 md-namespace-create <NAMESPACE> <unavailable> Create a new metadata definitions namespace. <NAMESPACE> Name of the namespace. <unavailable> Please run with connection parameters set to retrieve the schema for generating help for this command

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

usage: glance --os-image-api-version 2 md-namespace-import [--file <FILEPATH>] Import a metadata definitions namespace from file or standard input. --file <FILEPATH> Path to file with namespace schema to import. Alternatively, namespaces schema can be passed to the client via stdin.

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

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

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

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

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. <NAMESPACE> Name of namespace to describe. --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.

usage: glance --os-image-api-version 2 md-namespace-update <NAMESPACE> <unavailable> Update an existing metadata definitions namespace. <NAMESPACE> Name of namespace to update. <unavailable> Please run with connection parameters set to retrieve the schema for generating help for this command

usage: glance --os-image-api-version 2 md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE> Create a new metadata definitions object inside a namespace. <NAMESPACE> Name of namespace the object will belong. --name <NAME> Internal name of an object. --schema <SCHEMA> Valid JSON schema of an object.

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

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

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. <NAMESPACE> Name of namespace the object belongs. <OBJECT> Name of an object. <PROPERTY> Name of a property. --max-column-width <integer> The max column width of the printed table.

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. <NAMESPACE> Name of namespace the object belongs. <OBJECT> Name of an object. --max-column-width <integer> The max column width of the printed table.

usage: glance --os-image-api-version 2 md-object-update [--name <NAME>] [--schema <SCHEMA>] <NAMESPACE> <OBJECT> Update metadata definitions object inside a namespace. <NAMESPACE> Name of namespace the object belongs. <OBJECT> Name of an object. --name <NAME> New name of an object. --schema <SCHEMA> Valid JSON schema of an object.

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. <NAMESPACE> Name of namespace the property will belong. --name <NAME> Internal name of a property. --title <TITLE> Property name displayed to the user. --schema <SCHEMA> Valid JSON schema of a property.

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

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

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. <NAMESPACE> Name of namespace the property belongs. <PROPERTY> Name of a property. --max-column-width <integer> The max column width of the printed table.

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. <NAMESPACE> Name of namespace the property belongs. <PROPERTY> Name of a property. --name <NAME> New name of a property. --title <TITLE> Property name displayed to the user. --schema <SCHEMA> Valid JSON schema of a property.

usage: glance --os-image-api-version 2 md-resource-type-associate <NAMESPACE> <unavailable> Associate resource type with a metadata definitions namespace. <NAMESPACE> Name of namespace. <unavailable> Please run with connection parameters set to retrieve the schema for generating help for this command

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

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

usage: glance --os-image-api-version 2 member-create <IMAGE_ID> <MEMBER_ID> Create member for a given image. <IMAGE_ID> Image with which to create member. <MEMBER_ID> Tenant to add as member.

usage: glance --os-image-api-version 2 member-delete <IMAGE_ID> <MEMBER_ID> Delete image member. <IMAGE_ID> Image from which to remove member. <MEMBER_ID> Tenant to remove as member.

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

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. <IMAGE_ID> Image from which to update member. <MEMBER_ID> Tenant to update. <MEMBER_STATUS> Updated status of member.