The glance client is the command-line interface (CLI) for the Image service (glance) API and its extensions.
This chapter documents glance version 2.8.0
.
For help on a specific glance command, enter:
$ glance help COMMAND
usage: glance [--version] [-d] [-v] [--get-schema] [-f]
[--os-image-url OS_IMAGE_URL]
[--os-image-api-version OS_IMAGE_API_VERSION]
[--profile HMAC_KEY] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
[--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-default-domain-id OS_DEFAULT_DOMAIN_ID]
[--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
[--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]
<subcommand> ...
--version
-d, --debug
env[GLANCECLIENT_DEBUG]
.-v, --verbose
--get-schema
-f, --force
--os-image-url OS_IMAGE_URL
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
env[OS_IMAGE_API_VERSION]
or 2.--profile HMAC_KEY
env[OS_PROFILE]
.--os-region-name OS_REGION_NAME
env[OS_REGION_NAME]
.--os-auth-token OS_AUTH_TOKEN
env[OS_AUTH_TOKEN]
.--os-service-type OS_SERVICE_TYPE
env[OS_SERVICE_TYPE]
.--os-endpoint-type OS_ENDPOINT_TYPE
env[OS_ENDPOINT_TYPE]
.--os-auth-type <name>, --os-auth-plugin <name>
usage: glance explain <MODEL>
Describe a specific model.
Positional arguments:
<MODEL>
usage: glance 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>
--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
usage: glance image-deactivate <IMAGE_ID>
Deactivate specified image.
Positional arguments:
<IMAGE_ID>
usage: glance image-delete <IMAGE_ID> [<IMAGE_ID> ...]
Delete specified image.
Positional arguments:
<IMAGE_ID>
usage: glance image-download [--file <FILE>] [--progress] <IMAGE_ID>
Download a specific image.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--file <FILE>
--progress
usage: glance 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>
--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>]
usage: glance image-reactivate <IMAGE_ID>
Reactivate specified image.
Positional arguments:
<IMAGE_ID>
usage: glance image-show [--human-readable] [--max-column-width <integer>]
<IMAGE_ID>
Describe a specific image.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--human-readable
--max-column-width <integer>
usage: glance image-tag-delete <IMAGE_ID> <TAG_VALUE>
Delete the tag associated with the given image.
Positional arguments:
<IMAGE_ID>
<TAG_VALUE>
usage: glance image-tag-update <IMAGE_ID> <TAG_VALUE>
Update an image with the given tag.
Positional arguments:
<IMAGE_ID>
<TAG_VALUE>
usage: glance 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>
Optional arguments:
--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
usage: glance image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress]
<IMAGE_ID>
Upload data for a specific image.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--file <FILE>
--size <IMAGE_SIZE>
--progress
usage: glance import-info
Prints the import methods available from Glance, or a message if the target Glance does not support image import.
usage: glance image-stage [--file <FILE>] [--size <IMAGE_SIZE>]
[--progress]
<IMAGE_ID>
Upload data for a specific image to staging.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--file <FILE>
--size <IMAGE_SIZE>
--progress
usage: glance image-import [--import-method <METHOD>]
<IMAGE_ID>
Initiate the image import taskflow.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--import-method <METHOD>
This is an EXPERIMENTAL command. It may be renamed or removed in future releases.
usage: glance image-create-via import [--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 using the image import process.
NOTE This is an EXPERIMENTAL command. It may be renamed or removed in future releases.
Optional arguments:
--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
usage: glance location-add --url <URL> [--metadata <STRING>] <IMAGE_ID>
Add a location (and related metadata) to an image.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--url <URL>
--metadata <STRING>
usage: glance location-delete --url <URL> <IMAGE_ID>
Remove locations (and related metadata) from an image.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--url <URL>
usage: glance location-update --url <URL> [--metadata <STRING>] <IMAGE_ID>
Update metadata of an image’s location.
Positional arguments:
<IMAGE_ID>
Optional arguments:
--url <URL>
--metadata <STRING>
usage: glance md-namespace-create [--schema <SCHEMA>]
[--created-at <CREATED_AT>]
[--resource-type-associations <RESOURCE_TYPE_ASSOCIATIONS> [<RESOURCE_TYPE_ASSOCIATIONS> ...]]
[--protected [True|False]] [--self <SELF>]
[--display-name <DISPLAY_NAME>]
[--owner <OWNER>]
[--visibility <VISIBILITY>]
[--updated-at <UPDATED_AT>]
[--description <DESCRIPTION>]
<NAMESPACE>
Create a new metadata definitions namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--schema <SCHEMA>
--created-at <CREATED_AT>
--resource-type-associations <RESOURCE_TYPE_ASSOCIATIONS> [...]
--protected [True|False]
--self <SELF>
--display-name <DISPLAY_NAME>
--owner <OWNER>
--visibility <VISIBILITY>
--updated-at <UPDATED_AT>
--description <DESCRIPTION>
usage: glance md-namespace-delete <NAMESPACE>
Delete specified metadata definitions namespace with its contents.
Positional arguments:
<NAMESPACE>
usage: glance md-namespace-import [--file <FILEPATH>]
Import a metadata definitions namespace from file or standard input.
Optional arguments:
--file <FILEPATH>
usage: glance md-namespace-list [--resource-types <RESOURCE_TYPES>]
[--visibility <VISIBILITY>]
[--page-size <SIZE>]
List metadata definitions namespaces.
Optional arguments:
--resource-types <RESOURCE_TYPES>
--visibility <VISIBILITY>
--page-size <SIZE>
usage: glance md-namespace-objects-delete <NAMESPACE>
Delete all metadata definitions objects inside a specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance md-namespace-properties-delete <NAMESPACE>
Delete all metadata definitions property inside a specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance md-namespace-resource-type-list <NAMESPACE>
List resource types associated to specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance 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>
Optional arguments:
--resource-type <RESOURCE_TYPE>
--max-column-width <integer>
usage: glance md-namespace-tags-delete <NAMESPACE>
Delete all metadata definitions tags inside a specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance md-namespace-update [--created-at <CREATED_AT>]
[--protected [True|False]]
[--namespace <NAMESPACE>] [--self <SELF>]
[--display-name <DISPLAY_NAME>]
[--owner <OWNER>]
[--visibility <VISIBILITY>]
[--updated-at <UPDATED_AT>]
[--description <DESCRIPTION>]
<NAMESPACE>
Update an existing metadata definitions namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--created-at <CREATED_AT>
--protected [True|False]
--namespace <NAMESPACE>
--self <SELF>
--display-name <DISPLAY_NAME>
--owner <OWNER>
--visibility <VISIBILITY>
--updated-at <UPDATED_AT>
--description <DESCRIPTION>
usage: glance md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE>
Create a new metadata definitions object inside a namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--name <NAME>
--schema <SCHEMA>
usage: glance md-object-delete <NAMESPACE> <OBJECT>
Delete a specific metadata definitions object inside a namespace.
Positional arguments:
<NAMESPACE>
<OBJECT>
usage: glance md-object-list <NAMESPACE>
List metadata definitions objects inside a specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance md-object-property-show [--max-column-width <integer>]
<NAMESPACE> <OBJECT> <PROPERTY>
Describe a specific metadata definitions property inside an object.
Positional arguments:
<NAMESPACE>
<OBJECT>
<PROPERTY>
Optional arguments:
--max-column-width <integer>
usage: glance md-object-show [--max-column-width <integer>]
<NAMESPACE> <OBJECT>
Describe a specific metadata definitions object inside a namespace.
Positional arguments:
<NAMESPACE>
<OBJECT>
Optional arguments:
--max-column-width <integer>
usage: glance md-object-update [--name <NAME>] [--schema <SCHEMA>]
<NAMESPACE> <OBJECT>
Update metadata definitions object inside a namespace.
Positional arguments:
<NAMESPACE>
<OBJECT>
Optional arguments:
--name <NAME>
--schema <SCHEMA>
usage: glance md-property-create --name <NAME> --title <TITLE> --schema
<SCHEMA>
<NAMESPACE>
Create a new metadata definitions property inside a namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--name <NAME>
--title <TITLE>
--schema <SCHEMA>
usage: glance md-property-delete <NAMESPACE> <PROPERTY>
Delete a specific metadata definitions property inside a namespace.
Positional arguments:
<NAMESPACE>
<PROPERTY>
usage: glance md-property-list <NAMESPACE>
List metadata definitions properties inside a specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance md-property-show [--max-column-width <integer>]
<NAMESPACE> <PROPERTY>
Describe a specific metadata definitions property inside a namespace.
Positional arguments:
<NAMESPACE>
<PROPERTY>
Optional arguments:
--max-column-width <integer>
usage: glance md-property-update [--name <NAME>] [--title <TITLE>]
[--schema <SCHEMA>]
<NAMESPACE> <PROPERTY>
Update metadata definitions property inside a namespace.
Positional arguments:
<NAMESPACE>
<PROPERTY>
Optional arguments:
--name <NAME>
--title <TITLE>
--schema <SCHEMA>
usage: glance md-resource-type-associate [--updated-at <UPDATED_AT>]
[--name <NAME>]
[--properties-target <PROPERTIES_TARGET>]
[--prefix <PREFIX>]
[--created-at <CREATED_AT>]
<NAMESPACE>
Associate resource type with a metadata definitions namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--updated-at <UPDATED_AT>
--name <NAME>
--properties-target <PROPERTIES_TARGET>
--prefix <PREFIX>
--created-at <CREATED_AT>
usage: glance md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE>
Deassociate resource type with a metadata definitions namespace.
Positional arguments:
<NAMESPACE>
<RESOURCE_TYPE>
usage: glance md-resource-type-list
List available resource type names.
usage: glance md-tag-create --name <NAME> <NAMESPACE>
Add a new metadata definitions tag inside a namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--name <NAME>
usage: glance md-tag-create-multiple --names <NAMES> [--delim <DELIM>]
<NAMESPACE>
Create new metadata definitions tags inside a namespace.
Positional arguments:
<NAMESPACE>
Optional arguments:
--names <NAMES>
--delim <DELIM>
usage: glance md-tag-delete <NAMESPACE> <TAG>
Delete a specific metadata definitions tag inside a namespace.
Positional arguments:
<NAMESPACE>
<TAG>
usage: glance md-tag-list <NAMESPACE>
List metadata definitions tags inside a specific namespace.
Positional arguments:
<NAMESPACE>
usage: glance md-tag-show <NAMESPACE> <TAG>
Describe a specific metadata definitions tag inside a namespace.
Positional arguments:
<NAMESPACE>
<TAG>
usage: glance md-tag-update --name <NAME> <NAMESPACE> <TAG>
Rename a metadata definitions tag inside a namespace.
Positional arguments:
<NAMESPACE>
<TAG>
Optional arguments:
--name <NAME>
usage: glance member-create <IMAGE_ID> <MEMBER_ID>
Create member for a given image.
Positional arguments:
<IMAGE_ID>
<MEMBER_ID>
usage: glance member-delete <IMAGE_ID> <MEMBER_ID>
Delete image member.
Positional arguments:
<IMAGE_ID>
<MEMBER_ID>
usage: glance member-list --image-id <IMAGE_ID>
Describe sharing permissions by image.
Optional arguments:
--image-id <IMAGE_ID>
usage: glance member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS>
Update the status of a member for a given image.
Positional arguments:
<IMAGE_ID>
<MEMBER_ID>
<MEMBER_STATUS>
usage: glance task-create [--type <TYPE>] [--input <STRING>]
Create a new task.
Optional arguments:
--type <TYPE>
--input <STRING>
usage: glance 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-dir {asc,desc}
--page-size <SIZE>
--type <TYPE>
--status <STATUS>
usage: glance task-show <TASK_ID>
Describe a specific task.
Positional arguments:
<TASK_ID>
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.