openstack/openstack-manuals
Code Issues Proposed changes
cdbf99aa92
openstack-manuals/doc/common/ch_cli_glance_commands.xml
Andreas Jaeger b7ed9d3dfe Move command references from section to chapters 
Rename sections to chapters for the command references.

Update cli-reference to remove single "command references" chapter and
add a chapter per command.

Adjust training-guides.

Change-Id: I64b30bca4915eed4f312bb3d2b5692c11b19fc81
2014-02-03 17:01:50 +00:00

1147 lines
33 KiB
XML
Raw Blame History

<?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>glance commands</title>
<para>The glance client is the command-line interface (CLI) for the
OpenStack Image Service API and its extensions.</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> [--cert-file CERT_FILE] [--key-file KEY_FILE]
[--os-cacert &lt;ca-certificate-file&gt;] [--ca-file OS_CACERT]
[--timeout TIMEOUT] [--no-ssl-compression] [-f] [--dry-run]
[--ssl] [-H ADDRESS] [-p PORT] [--os-username OS_USERNAME]
[-I OS_USERNAME] [--os-password OS_PASSWORD] [-K OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[-T OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [-N OS_AUTH_URL]
[--os-region-name OS_REGION_NAME] [-R OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [-A OS_AUTH_TOKEN]
[--os-image-url OS_IMAGE_URL] [-U OS_IMAGE_URL]
[--os-image-api-version OS_IMAGE_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-S OS_AUTH_STRATEGY]
&lt;subcommand&gt; ...
</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
<term><command>add</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use image-create instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>clear</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>delete</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use image-delete instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>details</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use image-list instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-create</command></term>
<listitem>
<para>
Create a new image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-delete</command></term>
<listitem>
<para>
Delete specified image(s).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-download</command></term>
<listitem>
<para>
Download a specific image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-list</command></term>
<listitem>
<para>
List images you can access.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-members</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use member-list instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-show</command></term>
<listitem>
<para>
Describe a specific image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-update</command></term>
<listitem>
<para>
Update a specific image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>index</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use image-list instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>member-add</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use member-create instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>member-create</command></term>
<listitem>
<para>
Share a specific image with a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>member-delete</command></term>
<listitem>
<para>
Remove a shared image from a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>member-images</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use member-list instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>member-list</command></term>
<listitem>
<para>
Describe sharing permissions by image or tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>members-replace</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>show</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use image-show instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>update</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use image-update instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>help</command></term>
<listitem>
<para>
Display help about this program or one of its
subcommands.
</para>
</listitem>
</varlistentry>
</variablelist>
</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>
Force retrieving the schema used to generate portions
of the help text rather than using a cached copy.
Ignored with api version 1
</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>--cert-file CERT_FILE</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>--key-file KEY_FILE</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>--os-cacert &lt;ca-certificate-file&gt;</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>--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>
Disable SSL compression when using https.
</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>--dry-run</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Only used for deprecated legacy commands.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ssl</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Send a fully-formed endpoint using --os-
image-url instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-H ADDRESS, --host ADDRESS</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Send a fully-formed endpoint using --os-
image-url instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-p PORT, --port PORT</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Send a fully-formed endpoint using --os-
image-url instead.
</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>-I OS_USERNAME</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-username.
</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>-K OS_PASSWORD</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-password.
</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>-T OS_TENANT_NAME</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-tenant-name.
</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>-N OS_AUTH_URL</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-auth-url.
</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>-R OS_REGION_NAME</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-region-name.
</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>-A OS_AUTH_TOKEN, --auth_token OS_AUTH_TOKEN</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-auth-token.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-image-url OS_IMAGE_URL</command></term>
<listitem>
<para>
Defaults to <code>env[OS_IMAGE_URL]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-U OS_IMAGE_URL, --url OS_IMAGE_URL</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use --os-image-url.
</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 1
</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>
<varlistentry>
<term><command>-S OS_AUTH_STRATEGY, --os_auth_strategy OS_AUTH_STRATEGY</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> This option is completely ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="glanceclient_subcommand_image-create">
<title>glance image-create command</title>
<screen><computeroutput>usage: glance image-create [--id &lt;IMAGE_ID&gt;] [--name &lt;NAME&gt;] [--store &lt;STORE&gt;]
[--disk-format &lt;DISK_FORMAT&gt;]
[--container-format &lt;CONTAINER_FORMAT&gt;]
[--owner &lt;TENANT_ID&gt;] [--size &lt;SIZE&gt;]
[--min-disk &lt;DISK_GB&gt;] [--min-ram &lt;DISK_RAM&gt;]
[--location &lt;IMAGE_URL&gt;] [--file &lt;FILE&gt;]
[--checksum &lt;CHECKSUM&gt;] [--copy-from &lt;IMAGE_URL&gt;]
[--is-public {True,False}]
[--is-protected {True,False}]
[--property &lt;key=value&gt;] [--human-readable]
[--progress]
</computeroutput></screen>
<para>
Create a new image.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--id &lt;IMAGE_ID&gt; ID</command></term>
<listitem>
<para>
of image to reserve.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;NAME&gt;</command></term>
<listitem>
<para>
Name of image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--store &lt;STORE&gt;</command></term>
<listitem>
<para>
Store to upload image to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disk-format &lt;DISK_FORMAT&gt;</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 &lt;CONTAINER_FORMAT&gt;</command></term>
<listitem>
<para>
Container format of image. Acceptable formats: ami,
ari, aki, bare, and ovf.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--owner &lt;TENANT_ID&gt;</command></term>
<listitem>
<para>
Tenant who should own image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--size &lt;SIZE&gt;</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 &lt;DISK_GB&gt;</command></term>
<listitem>
<para>
Minimum size of disk needed to boot image (in
gigabytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-ram &lt;DISK_RAM&gt;</command></term>
<listitem>
<para>
Minimum amount of ram needed to boot image (in
megabytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--location &lt;IMAGE_URL&gt;</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://account:key@example.com/container/obj'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--file &lt;FILE&gt;</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 &lt;CHECKSUM&gt;</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 &lt;IMAGE_URL&gt;</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 &lt;key=value&gt;</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">
<title>glance image-delete command</title>
<screen><computeroutput>usage: glance image-delete &lt;IMAGE&gt; [&lt;IMAGE&gt; ...]
</computeroutput></screen>
<para>
Delete specified image(s).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;IMAGE&gt;</command></term>
<listitem>
<para>
Name or ID of image(s) to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="glanceclient_subcommand_image-list">
<title>glance image-list command</title>
<screen><computeroutput>usage: glance image-list [--name &lt;NAME&gt;] [--status &lt;STATUS&gt;]
[--container-format &lt;CONTAINER_FORMAT&gt;]
[--disk-format &lt;DISK_FORMAT&gt;] [--size-min &lt;SIZE&gt;]
[--size-max &lt;SIZE&gt;] [--property-filter &lt;KEY=VALUE&gt;]
[--page-size &lt;SIZE&gt;] [--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 &lt;TENANT_ID&gt;] [--all-tenants]
</computeroutput></screen>
<para>
List images you can access.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;NAME&gt;</command></term>
<listitem>
<para>
Filter images to those that have this name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;STATUS&gt;</command></term>
<listitem>
<para>
Filter images to those that have this status.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--container-format &lt;CONTAINER_FORMAT&gt;</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 &lt;DISK_FORMAT&gt;</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 &lt;SIZE&gt;</command></term>
<listitem>
<para>
Filter images to those with a size greater than this.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--size-max &lt;SIZE&gt;</command></term>
<listitem>
<para>
Filter images to those with a size less than this.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property-filter &lt;KEY=VALUE&gt;</command></term>
<listitem>
<para>
Filter images by a user-defined image property.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--page-size &lt;SIZE&gt;</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 &lt;TENANT_ID&gt;</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">
<title>glance image-show command</title>
<screen><computeroutput>usage: glance image-show [--human-readable] &lt;IMAGE&gt;
</computeroutput></screen>
<para>
Describe a specific image.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;IMAGE&gt;</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>
</variablelist>
</section>
<section xml:id="glanceclient_subcommand_image-update">
<title>glance image-update command</title>
<screen><computeroutput>usage: glance image-update [--name &lt;NAME&gt;] [--disk-format &lt;DISK_FORMAT&gt;]
[--container-format &lt;CONTAINER_FORMAT&gt;]
[--owner &lt;TENANT_ID&gt;] [--size &lt;SIZE&gt;]
[--min-disk &lt;DISK_GB&gt;] [--min-ram &lt;DISK_RAM&gt;]
[--location &lt;IMAGE_URL&gt;] [--file &lt;FILE&gt;]
[--checksum &lt;CHECKSUM&gt;] [--copy-from &lt;IMAGE_URL&gt;]
[--is-public {True,False}]
[--is-protected {True,False}]
[--property &lt;key=value&gt;] [--purge-props]
[--human-readable] [--progress]
&lt;IMAGE&gt;
</computeroutput></screen>
<para>
Update a specific image.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;IMAGE&gt;</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 &lt;NAME&gt;</command></term>
<listitem>
<para>
Name of image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disk-format &lt;DISK_FORMAT&gt;</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 &lt;CONTAINER_FORMAT&gt;</command></term>
<listitem>
<para>
Container format of image. Acceptable formats: ami,
ari, aki, bare, and ovf.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--owner &lt;TENANT_ID&gt;</command></term>
<listitem>
<para>
Tenant who should own image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--size &lt;SIZE&gt;</command></term>
<listitem>
<para>
Size of image data (in bytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-disk &lt;DISK_GB&gt;</command></term>
<listitem>
<para>
Minimum size of disk needed to boot image (in
gigabytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-ram &lt;DISK_RAM&gt;</command></term>
<listitem>
<para>
Minimum amount of ram needed to boot image (in
megabytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--location &lt;IMAGE_URL&gt;</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://account:key@example.com/container/obj'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--file &lt;FILE&gt;</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 &lt;CHECKSUM&gt;</command></term>
<listitem>
<para>
Hash of image data used Glance can use for
verification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--copy-from &lt;IMAGE_URL&gt;</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 &lt;key=value&gt;</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">
<title>glance member-create command</title>
<screen><computeroutput>usage: glance member-create [--can-share] &lt;IMAGE&gt; &lt;TENANT_ID&gt;
</computeroutput></screen>
<para>
Share a specific image with a tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;IMAGE&gt;</command></term>
<listitem>
<para>
Image to add member to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;TENANT_ID&gt;</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">
<title>glance member-delete command</title>
<screen><computeroutput>usage: glance member-delete &lt;IMAGE&gt; &lt;TENANT_ID&gt;
</computeroutput></screen>
<para>
Remove a shared image from a tenant.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;IMAGE&gt;</command></term>
<listitem>
<para>
Image from which to remove member
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;TENANT_ID&gt;</command></term>
<listitem>
<para>
Tenant to remove as member
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="glanceclient_subcommand_member-list">
<title>glance member-list command</title>
<screen><computeroutput>usage: glance member-list [--image-id &lt;IMAGE_ID&gt;] [--tenant-id &lt;TENANT_ID&gt;]
</computeroutput></screen>
<para>
Describe sharing permissions by image or tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--image-id &lt;IMAGE_ID&gt;</command></term>
<listitem>
<para>
Filter results by an image ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--tenant-id &lt;TENANT_ID&gt;</command></term>
<listitem>
<para>
Filter results by a tenant ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
View Git Blame Copy Permalink