2863 lines
90 KiB
XML
2863 lines
90 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="glanceclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<title>Image service command-line client</title>
|
|
|
|
<para>The <command>glance</command> client is the command-line
|
|
interface (CLI) for the OpenStack Image service API and its extensions.
|
|
|
|
This chapter documents <command>glance</command> version
|
|
<literal>1.1.0</literal>.
|
|
</para>
|
|
|
|
<para>For help on a specific <command>glance</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>glance</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="glanceclient_command_usage">
|
|
<title>glance usage</title>
|
|
<screen><computeroutput>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]</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="glanceclient_command_optional">
|
|
<title>glance optional arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--version</command></term>
|
|
<listitem>
|
|
<para>
|
|
show program's version number and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-d, --debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[GLANCECLIENT_DEBUG]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-v, --verbose</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print more verbose output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--get-schema</command></term>
|
|
<listitem>
|
|
<para>
|
|
Ignores cached copy and forces retrieval of schema
|
|
that generates portions of the help text. Ignored with
|
|
API version 1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timeout TIMEOUT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of seconds to wait for a response
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-ssl-compression</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> This option is deprecated and not used
|
|
anymore. SSL compression should be disabled by default
|
|
by the system SSL library.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-f, --force</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prevent select actions from requesting user
|
|
confirmation.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-image-url OS_IMAGE_URL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_IMAGE_URL]</code>. 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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-image-api-version OS_IMAGE_API_VERSION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_IMAGE_API_VERSION]</code> or 2.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-k, --insecure</command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cert OS_CERT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Path of certificate file to use in SSL connection.
|
|
This file can optionally be prepended with the private
|
|
key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--cert-file OS_CERT</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use --os-cert.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-key OS_KEY</command></term>
|
|
<listitem>
|
|
<para>
|
|
Path of client key to use in SSL connection. This
|
|
option is not necessary if your key is prepended to
|
|
your cert file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-file OS_KEY</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use --os-key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <ca-certificate-file></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ca-file OS_CACERT</command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED!</emphasis> Use --os-cacert.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username OS_USERNAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USERNAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-id OS_USER_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-id OS_USER_DOMAIN_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-name OS_USER_DOMAIN_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-id OS_PROJECT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Another way to specify tenant ID. This option is
|
|
mutually exclusive with --os-tenant-id. Defaults to
|
|
<code>env[OS_PROJECT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-name OS_PROJECT_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Another way to specify tenant name. This option is
|
|
mutually exclusive with --os-tenant-name. Defaults to
|
|
<code>env[OS_PROJECT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-id OS_PROJECT_DOMAIN_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-name OS_PROJECT_DOMAIN_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password OS_PASSWORD</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PASSWORD]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id OS_TENANT_ID</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name OS_TENANT_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url OS_AUTH_URL</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name OS_REGION_NAME</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_REGION_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_TOKEN]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-service-type OS_SERVICE_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_SERVICE_TYPE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-endpoint-type OS_ENDPOINT_TYPE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_ENDPOINT_TYPE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
|
|
<section xml:id="glance_cli_v1">
|
|
<title>Image service API v1 commands</title>
|
|
<section xml:id="glanceclient_subcommand_image-create_v1">
|
|
<title>glance image-create (v1)</title>
|
|
<screen><computeroutput>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]</computeroutput></screen>
|
|
<para>
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--id <IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to reserve.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--store <STORE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Store to upload image to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <DISK_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk format of image. Acceptable formats: ami, ari,
|
|
aki, vhd, vmdk, raw, qcow2, vdi, and iso.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <CONTAINER_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container format of image. Acceptable formats: ami,
|
|
ari, aki, bare, and ovf.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <TENANT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant who should own image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of image data (in bytes). Only used with '--
|
|
location' and '--copy_from'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <DISK_GB></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum size of disk needed to boot image (in
|
|
gigabytes).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <DISK_RAM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum amount of ram needed to boot image (in
|
|
megabytes).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--location <IMAGE_URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Local file that contains disk image to be uploaded
|
|
during creation. Alternatively, images can be passed
|
|
to the client via stdin.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--checksum <CHECKSUM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Hash of image data used Glance can use for
|
|
verification. Provide a md5 checksum here.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--copy-from <IMAGE_URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-public {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Make image accessible to the public.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-protected {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prevent image from being deleted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Arbitrary property to associate with image. May be
|
|
used multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--human-readable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print image size in a human-friendly format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--progress</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show upload progress bar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-delete_v1">
|
|
<title>glance image-delete (v1)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 1 image-delete <IMAGE> [<IMAGE> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete specified image(s).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image(s) to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-download_v1">
|
|
<title>glance image-download (v1)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 1 image-download [--file <FILE>] [--progress] <IMAGE></computeroutput></screen>
|
|
<para>
|
|
Download a specific image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image to download.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--progress</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show download progress bar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-list_v1">
|
|
<title>glance image-list (v1)</title>
|
|
<screen><computeroutput>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]</computeroutput></screen>
|
|
<para>
|
|
List images you can access.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those that have this name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <STATUS></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those that have this status.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--changes-since <CHANGES_SINCE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those that changed since the given
|
|
time, which will include the deleted images.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <CONTAINER_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those that have this container
|
|
format. Acceptable formats: ami, ari, aki, bare, and
|
|
ovf.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <DISK_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those that have this disk format.
|
|
Acceptable formats: ami, ari, aki, vhd, vmdk, raw,
|
|
qcow2, vdi, and iso.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size-min <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those with a size greater than this.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size-max <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images to those with a size less than this.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property-filter <KEY=VALUE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images by a user-defined image property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--page-size <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of images to request in each paginated request.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--human-readable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print image size in a human-friendly format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort image list by specified field.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort image list in specified direction.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-public {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allows the user to select a listing of public or non
|
|
public images.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <TENANT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all-tenants</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allows the admin user to list all images irrespective
|
|
of the image's owner or is_public value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-show_v1">
|
|
<title>glance image-show (v1)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 1 image-show [--human-readable] [--max-column-width <integer>]
|
|
<IMAGE></computeroutput></screen>
|
|
<para>
|
|
Describe a specific image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image to describe.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--human-readable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print image size in a human-friendly format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max-column-width <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
The max column width of the printed table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-update_v1">
|
|
<title>glance image-update (v1)</title>
|
|
<screen><computeroutput>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></computeroutput></screen>
|
|
<para>
|
|
Update a specific image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of image to modify.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <DISK_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk format of image. Acceptable formats: ami, ari,
|
|
aki, vhd, vmdk, raw, qcow2, vdi, and iso.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <CONTAINER_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container format of image. Acceptable formats: ami,
|
|
ari, aki, bare, and ovf.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <TENANT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant who should own image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Size of image data (in bytes).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <DISK_GB></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum size of disk needed to boot image (in
|
|
gigabytes).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <DISK_RAM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum amount of ram needed to boot image (in
|
|
megabytes).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--location <IMAGE_URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Local file that contains disk image to be uploaded
|
|
during update. Alternatively, images can be passed to
|
|
the client via stdin.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--checksum <CHECKSUM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Hash of image data used Glance can use for
|
|
verification.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--copy-from <IMAGE_URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-public {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Make image accessible to the public.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--is-protected {True,False}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prevent image from being deleted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Arbitrary property to associate with image. May be
|
|
used multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--purge-props</command></term>
|
|
<listitem>
|
|
<para>
|
|
If this flag is present, delete all image properties
|
|
not explicitly set in the update request. Otherwise,
|
|
those properties not referenced are preserved.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--human-readable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print image size in a human-friendly format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--progress</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show upload progress bar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-create_v1">
|
|
<title>glance member-create (v1)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 1 member-create [--can-share] <IMAGE> <TENANT_ID></computeroutput></screen>
|
|
<para>
|
|
Share a specific image with a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to add member to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TENANT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant to add as member
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--can-share</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allow the specified tenant to share this image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-delete_v1">
|
|
<title>glance member-delete (v1)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 1 member-delete <IMAGE> <TENANT_ID></computeroutput></screen>
|
|
<para>
|
|
Remove a shared image from a tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image from which to remove member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TENANT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant to remove as member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-list_v1">
|
|
<title>glance member-list (v1)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 1 member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]</computeroutput></screen>
|
|
<para>
|
|
Describe sharing permissions by image or tenant.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--image-id <IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by an image ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tenant-id <TENANT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by a tenant ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
<section xml:id="glance_cli_v2">
|
|
<title>Image service API v2 commands</title>
|
|
<para>
|
|
You can select an API version to use by adding the
|
|
<parameter>--os-image-api-version</parameter> parameter or by setting
|
|
the corresponding environment variable:
|
|
<screen><prompt>$</prompt> <userinput>export OS_IMAGE_API_VERSION=2</userinput></screen>
|
|
</para>
|
|
<section xml:id="glanceclient_subcommand_explain_v2">
|
|
<title>glance explain (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 explain <MODEL></computeroutput></screen>
|
|
<para>
|
|
Describe a specific model.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><MODEL></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of model to describe.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-create_v2">
|
|
<title>glance image-create (v2)</title>
|
|
<screen><computeroutput>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>] [--self <SELF>]
|
|
[--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]</computeroutput></screen>
|
|
<para>
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--architecture <ARCHITECTURE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system architecture as specified in
|
|
http://docs.openstack.org/trunk/openstack-
|
|
compute/admin/content/adding-images.html
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protected [True|False]</command></term>
|
|
<listitem>
|
|
<para>
|
|
If true, image will not be deletable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Descriptive name for the image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance-uuid <INSTANCE_UUID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of instance used to create this image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <MIN_DISK></command></term>
|
|
<listitem>
|
|
<para>
|
|
Amount of disk space (in GB) required to boot image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--visibility <VISIBILITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Scope of image accessibility Valid values: public,
|
|
private
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--kernel-id <KERNEL_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image stored in Glance that should be used as
|
|
the kernel when booting an AMI-style image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tags <TAGS> [<TAGS> ...]</command></term>
|
|
<listitem>
|
|
<para>
|
|
List of strings related to the image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-version <OS_VERSION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system version as specified by the
|
|
distributor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <DISK_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Format of the disk Valid values: ami, ari, aki, vhd,
|
|
vmdk, raw, qcow2, vdi, iso
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--self <SELF></command></term>
|
|
<listitem>
|
|
<para>
|
|
(READ-ONLY)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-distro <OS_DISTRO></command></term>
|
|
<listitem>
|
|
<para>
|
|
Common name of operating system distribution as
|
|
specified in http://docs.openstack.org/trunk
|
|
/openstack-compute/admin/content/adding-images.html
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--id <ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
An identifier for the image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <OWNER></command></term>
|
|
<listitem>
|
|
<para>
|
|
Owner of the image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ramdisk-id <RAMDISK_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image stored in Glance that should be used as
|
|
the ramdisk when booting an AMI-style image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <MIN_RAM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Amount of ram (in MB) required to boot image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <CONTAINER_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Format of the container Valid values: ami, ari, aki,
|
|
bare, ovf, ova
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Arbitrary property to associate with image. May be
|
|
used multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Local file that contains disk image to be uploaded
|
|
during creation. Must be present if images are not
|
|
passed to the client via stdin.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--progress</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show upload progress bar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-delete_v2">
|
|
<title>glance image-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 image-delete <IMAGE_ID></computeroutput></screen>
|
|
<para>
|
|
Delete specified image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-download_v2">
|
|
<title>glance image-download (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 image-download [--file <FILE>] [--progress] <IMAGE_ID></computeroutput></screen>
|
|
<para>
|
|
Download a specific image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to download.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--progress</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show download progress bar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-list_v2">
|
|
<title>glance image-list (v2)</title>
|
|
<screen><computeroutput>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>]]</computeroutput></screen>
|
|
<para>
|
|
List images you can access.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--limit <LIMIT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of images to get.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--page-size <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of images to request in each paginated request.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--visibility <VISIBILITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
The visibility of the images to display.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--member-status <MEMBER_STATUS></command></term>
|
|
<listitem>
|
|
<para>
|
|
The status of images to display.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <OWNER></command></term>
|
|
<listitem>
|
|
<para>
|
|
Display images owned by <OWNER>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property-filter <KEY=VALUE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images by a user-defined image property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--checksum <CHECKSUM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Displays images that match the checksum.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tag <TAG></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter images by a user-defined tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort image list by specified fields.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort image list in specified directions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort <key>[:<direction>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-show_v2">
|
|
<title>glance image-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width <integer>]
|
|
<IMAGE_ID></computeroutput></screen>
|
|
<para>
|
|
Describe a specific image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to describe.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--human-readable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print image size in a human-friendly format.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max-column-width <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
The max column width of the printed table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-tag-delete_v2">
|
|
<title>glance image-tag-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 image-tag-delete <IMAGE_ID> <TAG_VALUE></computeroutput></screen>
|
|
<para>
|
|
Delete the tag associated with the given image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the image from which to delete tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TAG_VALUE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Value of the tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-tag-update_v2">
|
|
<title>glance image-tag-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 image-tag-update <IMAGE_ID> <TAG_VALUE></computeroutput></screen>
|
|
<para>
|
|
Update an image with the given tag.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to be updated with the given tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TAG_VALUE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Value of the tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-update_v2">
|
|
<title>glance image-update (v2)</title>
|
|
<screen><computeroutput>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>] [--self <SELF>]
|
|
[--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></computeroutput></screen>
|
|
<para>
|
|
Update an existing image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--architecture <ARCHITECTURE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system architecture as specified in
|
|
http://docs.openstack.org/trunk/openstack-
|
|
compute/admin/content/adding-images.html
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protected [True|False]</command></term>
|
|
<listitem>
|
|
<para>
|
|
If true, image will not be deletable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Descriptive name for the image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance-uuid <INSTANCE_UUID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of instance used to create this image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <MIN_DISK></command></term>
|
|
<listitem>
|
|
<para>
|
|
Amount of disk space (in GB) required to boot image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--visibility <VISIBILITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Scope of image accessibility Valid values: public,
|
|
private
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--kernel-id <KERNEL_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image stored in Glance that should be used as
|
|
the kernel when booting an AMI-style image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-version <OS_VERSION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system version as specified by the
|
|
distributor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <DISK_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Format of the disk Valid values: ami, ari, aki, vhd,
|
|
vmdk, raw, qcow2, vdi, iso
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--self <SELF></command></term>
|
|
<listitem>
|
|
<para>
|
|
(READ-ONLY)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-distro <OS_DISTRO></command></term>
|
|
<listitem>
|
|
<para>
|
|
Common name of operating system distribution as
|
|
specified in http://docs.openstack.org/trunk
|
|
/openstack-compute/admin/content/adding-images.html
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <OWNER></command></term>
|
|
<listitem>
|
|
<para>
|
|
Owner of the image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ramdisk-id <RAMDISK_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image stored in Glance that should be used as
|
|
the ramdisk when booting an AMI-style image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <MIN_RAM></command></term>
|
|
<listitem>
|
|
<para>
|
|
Amount of ram (in MB) required to boot image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <CONTAINER_FORMAT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Format of the container Valid values: ami, ari, aki,
|
|
bare, ovf, ova
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Arbitrary property to associate with image. May be
|
|
used multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remove-property</command></term>
|
|
<listitem>
|
|
<para>
|
|
key
|
|
Name of arbitrary property to remove from the image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_image-upload_v2">
|
|
<title>glance image-upload (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress]
|
|
<IMAGE_ID></computeroutput></screen>
|
|
<para>
|
|
Upload data for a specific image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to upload data to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--file <FILE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Local file that contains disk image to be uploaded.
|
|
Alternatively, images can be passed to the client via
|
|
stdin.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size <IMAGE_SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--progress</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show upload progress bar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_location-add_v2">
|
|
<title>glance location-add (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 location-add --url <URL> [--metadata <STRING>] <ID></computeroutput></screen>
|
|
<para>
|
|
Add a location (and related metadata) to an image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image to which the location is to be added.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--url <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL of location to add.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata <STRING></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata associated with the location. Must be a valid
|
|
JSON object (default: {})
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_location-delete_v2">
|
|
<title>glance location-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 location-delete --url <URL> <ID></computeroutput></screen>
|
|
<para>
|
|
Remove locations (and related metadata) from an image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image whose locations are to be removed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--url <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL of location to remove. May be used multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_location-update_v2">
|
|
<title>glance location-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 location-update --url <URL> [--metadata <STRING>] <ID></computeroutput></screen>
|
|
<para>
|
|
Update metadata of an image's location.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of image whose location is to be updated.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--url <URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL of location to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--metadata <STRING></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metadata associated with the location. Must be a valid
|
|
JSON object (default: {})
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-create_v2">
|
|
<title>glance md-namespace-create (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-create <NAMESPACE> <unavailable></computeroutput></screen>
|
|
<para>
|
|
Create a new metadata definitions namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><unavailable></command></term>
|
|
<listitem>
|
|
<para>
|
|
Please run with connection parameters set to retrieve the
|
|
schema for generating help for this command
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-delete_v2">
|
|
<title>glance md-namespace-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-delete <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Delete specified metadata definitions namespace with its contents.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace to delete.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-import_v2">
|
|
<title>glance md-namespace-import (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-import [--file <FILEPATH>]</computeroutput></screen>
|
|
<para>
|
|
Import a metadata definitions namespace from file or standard input.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--file <FILEPATH></command></term>
|
|
<listitem>
|
|
<para>
|
|
Path to file with namespace schema to import.
|
|
Alternatively, namespaces schema can be passed to the
|
|
client via stdin.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-list_v2">
|
|
<title>glance md-namespace-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-list [--resource-types <RESOURCE_TYPES>]
|
|
[--visibility <VISIBILITY>]
|
|
[--page-size <SIZE>]</computeroutput></screen>
|
|
<para>
|
|
List metadata definitions namespaces.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--resource-types <RESOURCE_TYPES></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource type to filter namespaces.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--visibility <VISIBILITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Visibility parameter to filter namespaces.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--page-size <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of namespaces to request in each paginated
|
|
request.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-objects-delete_v2">
|
|
<title>glance md-namespace-objects-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-objects-delete <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Delete all metadata definitions objects inside a specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-properties-delete_v2">
|
|
<title>glance md-namespace-properties-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-properties-delete <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Delete all metadata definitions property inside a specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-resource-type-list_v2">
|
|
<title>glance md-namespace-resource-type-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-resource-type-list <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
List resource types associated to specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-show_v2">
|
|
<title>glance md-namespace-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-show [--resource-type <RESOURCE_TYPE>]
|
|
[--max-column-width <integer>]
|
|
<NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Describe a specific metadata definitions namespace. Lists also the namespace
|
|
properties, objects and resource type associations.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace to describe.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--resource-type <RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Applies prefix of given resource type associated to a
|
|
namespace to all properties of a namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max-column-width <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
The max column width of the printed table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-tags-delete_v2">
|
|
<title>glance md-namespace-tags-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-tags-delete <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Delete all metadata definitions tags inside a specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-namespace-update_v2">
|
|
<title>glance md-namespace-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-namespace-update <NAMESPACE> <unavailable></computeroutput></screen>
|
|
<para>
|
|
Update an existing metadata definitions namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><unavailable></command></term>
|
|
<listitem>
|
|
<para>
|
|
Please run with connection parameters set to retrieve the
|
|
schema for generating help for this command
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-object-create_v2">
|
|
<title>glance md-object-create (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Create a new metadata definitions object inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the object will belong.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Internal name of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--schema <SCHEMA></command></term>
|
|
<listitem>
|
|
<para>
|
|
Valid JSON schema of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-object-delete_v2">
|
|
<title>glance md-object-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-object-delete <NAMESPACE> <OBJECT></computeroutput></screen>
|
|
<para>
|
|
Delete a specific metadata definitions object inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the object belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><OBJECT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-object-list_v2">
|
|
<title>glance md-object-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-object-list <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
List metadata definitions objects inside a specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-object-property-show_v2">
|
|
<title>glance md-object-property-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-object-property-show [--max-column-width <integer>]
|
|
<NAMESPACE> <OBJECT> <PROPERTY></computeroutput></screen>
|
|
<para>
|
|
Describe a specific metadata definitions property inside an object.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the object belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><OBJECT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><PROPERTY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--max-column-width <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
The max column width of the printed table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-object-show_v2">
|
|
<title>glance md-object-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-object-show [--max-column-width <integer>]
|
|
<NAMESPACE> <OBJECT></computeroutput></screen>
|
|
<para>
|
|
Describe a specific metadata definitions object inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the object belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><OBJECT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--max-column-width <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
The max column width of the printed table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-object-update_v2">
|
|
<title>glance md-object-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-object-update [--name <NAME>] [--schema <SCHEMA>]
|
|
<NAMESPACE> <OBJECT></computeroutput></screen>
|
|
<para>
|
|
Update metadata definitions object inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the object belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><OBJECT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--schema <SCHEMA></command></term>
|
|
<listitem>
|
|
<para>
|
|
Valid JSON schema of an object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-property-create_v2">
|
|
<title>glance md-property-create (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-property-create --name <NAME> --title <TITLE> --schema
|
|
<SCHEMA>
|
|
<NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Create a new metadata definitions property inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the property will belong.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Internal name of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--title <TITLE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property name displayed to the user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--schema <SCHEMA></command></term>
|
|
<listitem>
|
|
<para>
|
|
Valid JSON schema of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-property-delete_v2">
|
|
<title>glance md-property-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-property-delete <NAMESPACE> <PROPERTY></computeroutput></screen>
|
|
<para>
|
|
Delete a specific metadata definitions property inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the property belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><PROPERTY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-property-list_v2">
|
|
<title>glance md-property-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-property-list <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
List metadata definitions properties inside a specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-property-show_v2">
|
|
<title>glance md-property-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-property-show [--max-column-width <integer>]
|
|
<NAMESPACE> <PROPERTY></computeroutput></screen>
|
|
<para>
|
|
Describe a specific metadata definitions property inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the property belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><PROPERTY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--max-column-width <integer></command></term>
|
|
<listitem>
|
|
<para>
|
|
The max column width of the printed table.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-property-update_v2">
|
|
<title>glance md-property-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-property-update [--name <NAME>] [--title <TITLE>]
|
|
[--schema <SCHEMA>]
|
|
<NAMESPACE> <PROPERTY></computeroutput></screen>
|
|
<para>
|
|
Update metadata definitions property inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace the property belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><PROPERTY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--title <TITLE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property name displayed to the user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--schema <SCHEMA></command></term>
|
|
<listitem>
|
|
<para>
|
|
Valid JSON schema of a property.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-resource-type-associate_v2">
|
|
<title>glance md-resource-type-associate (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-resource-type-associate <NAMESPACE> <unavailable></computeroutput></screen>
|
|
<para>
|
|
Associate resource type with a metadata definitions namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><unavailable></command></term>
|
|
<listitem>
|
|
<para>
|
|
Please run with connection parameters set to retrieve the
|
|
schema for generating help for this command
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-resource-type-deassociate_v2">
|
|
<title>glance md-resource-type-deassociate (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE></computeroutput></screen>
|
|
<para>
|
|
Deassociate resource type with a metadata definitions namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of resource type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-resource-type-list_v2">
|
|
<title>glance md-resource-type-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-resource-type-list</computeroutput></screen>
|
|
<para>
|
|
List available resource type names.
|
|
Run `glance --os-image-api-version 1 help md-resource-type-list` for v1 help
|
|
</para>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-tag-create_v2">
|
|
<title>glance md-tag-create (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-tag-create --name <NAME> <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Add a new metadata definitions tag inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the namespace the tag will belong to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the new tag to add.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-tag-create-multiple_v2">
|
|
<title>glance md-tag-create-multiple (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-tag-create-multiple --names <NAMES> [--delim <DELIM>]
|
|
<NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
Create new metadata definitions tags inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the namespace the tags will belong to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--names <NAMES></command></term>
|
|
<listitem>
|
|
<para>
|
|
A comma separated list of tag names.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--delim <DELIM></command></term>
|
|
<listitem>
|
|
<para>
|
|
The delimiter used to separate the names (if none is
|
|
provided then the default is a comma).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-tag-delete_v2">
|
|
<title>glance md-tag-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-tag-delete <NAMESPACE> <TAG></computeroutput></screen>
|
|
<para>
|
|
Delete a specific metadata definitions tag inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the namespace to which the tag belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TAG></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-tag-list_v2">
|
|
<title>glance md-tag-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-tag-list <NAMESPACE></computeroutput></screen>
|
|
<para>
|
|
List metadata definitions tags inside a specific namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of namespace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-tag-show_v2">
|
|
<title>glance md-tag-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-tag-show <NAMESPACE> <TAG></computeroutput></screen>
|
|
<para>
|
|
Describe a specific metadata definitions tag inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the namespace to which the tag belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TAG></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_md-tag-update_v2">
|
|
<title>glance md-tag-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 md-tag-update --name <NAME> <NAMESPACE> <TAG></computeroutput></screen>
|
|
<para>
|
|
Rename a metadata definitions tag inside a namespace.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><NAMESPACE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the namespace to which the tag belongs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><TAG></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the old tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--name <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
New name of the new tag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-create_v2">
|
|
<title>glance member-create (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 member-create <IMAGE_ID> <MEMBER_ID></computeroutput></screen>
|
|
<para>
|
|
Create member for a given image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image with which to create member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><MEMBER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant to add as member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-delete_v2">
|
|
<title>glance member-delete (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 member-delete <IMAGE_ID> <MEMBER_ID></computeroutput></screen>
|
|
<para>
|
|
Delete image member.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image from which to remove member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><MEMBER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant to remove as member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-list_v2">
|
|
<title>glance member-list (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 member-list --image-id <IMAGE_ID></computeroutput></screen>
|
|
<para>
|
|
Describe sharing permissions by image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--image-id <IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to display members of.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_member-update_v2">
|
|
<title>glance member-update (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS></computeroutput></screen>
|
|
<para>
|
|
Update the status of a member for a given image.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><IMAGE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image from which to update member.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><MEMBER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><MEMBER_STATUS></command></term>
|
|
<listitem>
|
|
<para>
|
|
Updated status of member. Valid Values: accepted, rejected,
|
|
pending
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_task-create_v2">
|
|
<title>glance task-create (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 task-create [--type <TYPE>] [--input <STRING>]</computeroutput></screen>
|
|
<para>
|
|
Create a new task.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--type <TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of Task. Please refer to Glance schema or
|
|
documentation to see which tasks are supported.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--input <STRING></command></term>
|
|
<listitem>
|
|
<para>
|
|
Parameters of the task to be launched
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_task-list_v2">
|
|
<title>glance task-list (v2)</title>
|
|
<screen><computeroutput>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>]</computeroutput></screen>
|
|
<para>
|
|
List tasks you can access.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--sort-key {id,type,status}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort task list by specified field.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort-dir {asc,desc}</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort task list in specified direction.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--page-size <SIZE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of tasks to request in each paginated request.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter tasks to those that have this type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <STATUS></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter tasks to those that have this status.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="glanceclient_subcommand_task-show_v2">
|
|
<title>glance task-show (v2)</title>
|
|
<screen><computeroutput>usage: glance --os-image-api-version 2 task-show <TASK_ID></computeroutput></screen>
|
|
<para>
|
|
Describe a specific task.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><TASK_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of task to describe.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</section>
|
|
</chapter>
|