e827a0d412
Move CLI sections to common as they are shared between user guide, admin user guide, and config reference guide. Update the appendix (which was already in common) to refer to the new location. Change-Id: Id51aacea15ce70a90e1a49203665b2797d374e48
123 lines
6.4 KiB
XML
123 lines
6.4 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section 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="glance_commands">
|
|
<title>glance commands</title>
|
|
<para>The glance client is the command-line interface (CLI) for the
|
|
OpenStack Image Service API.</para>
|
|
<para>For help on a specific glance command, enter:</para>
|
|
<screen><prompt>$</prompt> <userinput><command>glance</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
<example>
|
|
<title>Usage</title>
|
|
<screen><computeroutput> glance [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
|
|
[--key-file KEY_FILE] [--os-cacert <ca-certificate-file>]
|
|
[--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]
|
|
<subcommand> ...</computeroutput></screen>
|
|
</example>
|
|
<example>
|
|
<title>Positional arguments</title>
|
|
<screen><computeroutput><subcommand>
|
|
add DEPRECATED! Use image-create instead.
|
|
clear DEPRECATED!
|
|
delete DEPRECATED! Use image-delete instead.
|
|
details DEPRECATED! Use image-list instead.
|
|
image-create Create a new image.
|
|
image-delete Delete specified image(s).
|
|
image-download Download a specific image.
|
|
image-list List images you can access.
|
|
image-members DEPRECATED! Use member-list instead.
|
|
image-show Describe a specific image.
|
|
image-update Update a specific image.
|
|
index DEPRECATED! Use image-list instead.
|
|
member-add DEPRECATED! Use member-create instead.
|
|
member-create Share a specific image with a tenant.
|
|
member-delete Remove a shared image from a tenant.
|
|
member-images DEPRECATED! Use member-list instead.
|
|
member-list Describe sharing permissions by image or tenant.
|
|
members-replace DEPRECATED!
|
|
show DEPRECATED! Use image-show instead.
|
|
update DEPRECATED! Use image-update instead.
|
|
help Display help about this program or one of its
|
|
subcommands.</computeroutput></screen>
|
|
</example>
|
|
<example>
|
|
<title>Optional arguments</title>
|
|
<screen><computeroutput> --version show program's version number and exit
|
|
-d, --debug Defaults to env[GLANCECLIENT_DEBUG]
|
|
-v, --verbose Print more verbose output
|
|
-k, --insecure Explicitly allow glanceclient to perform "insecure
|
|
SSL" (https) requests. The server's certificate will
|
|
not be verified against any certificate authorities.
|
|
This option should be used with caution.
|
|
--cert-file CERT_FILE
|
|
Path of certificate file to use in SSL connection.
|
|
This file can optionally be prepended with the private
|
|
key.
|
|
--key-file KEY_FILE Path of client key to use in SSL connection. This
|
|
option is not necessary if your key is prepended to
|
|
your cert file.
|
|
--os-cacert <ca-certificate-file>
|
|
Path of CA TLS certificate(s) used to verify the
|
|
remote server's certificate. Without this option
|
|
glance looks for the default system CA certificates.
|
|
--ca-file OS_CACERT DEPRECATED! Use --os-cacert.
|
|
--timeout TIMEOUT Number of seconds to wait for a response
|
|
--no-ssl-compression Disable SSL compression when using https.
|
|
-f, --force Prevent select actions from requesting user
|
|
confirmation.
|
|
--dry-run DEPRECATED! Only used for deprecated legacy commands.
|
|
--ssl DEPRECATED! Send a fully-formed endpoint using --os-
|
|
image-url instead.
|
|
-H ADDRESS, --host ADDRESS
|
|
DEPRECATED! Send a fully-formed endpoint using --os-
|
|
image-url instead.
|
|
-p PORT, --port PORT DEPRECATED! Send a fully-formed endpoint using --os-
|
|
image-url instead.
|
|
--os-username OS_USERNAME
|
|
Defaults to env[OS_USERNAME]
|
|
-I OS_USERNAME DEPRECATED! Use --os-username.
|
|
--os-password OS_PASSWORD
|
|
Defaults to env[OS_PASSWORD]
|
|
-K OS_PASSWORD DEPRECATED! Use --os-password.
|
|
--os-tenant-id OS_TENANT_ID
|
|
Defaults to env[OS_TENANT_ID]
|
|
--os-tenant-name OS_TENANT_NAME
|
|
Defaults to env[OS_TENANT_NAME]
|
|
-T OS_TENANT_NAME DEPRECATED! Use --os-tenant-name.
|
|
--os-auth-url OS_AUTH_URL
|
|
Defaults to env[OS_AUTH_URL]
|
|
-N OS_AUTH_URL DEPRECATED! Use --os-auth-url.
|
|
--os-region-name OS_REGION_NAME
|
|
Defaults to env[OS_REGION_NAME]
|
|
-R OS_REGION_NAME DEPRECATED! Use --os-region-name.
|
|
--os-auth-token OS_AUTH_TOKEN
|
|
Defaults to env[OS_AUTH_TOKEN]
|
|
-A OS_AUTH_TOKEN, --auth_token OS_AUTH_TOKEN
|
|
DEPRECATED! Use --os-auth-token.
|
|
--os-image-url OS_IMAGE_URL
|
|
Defaults to env[OS_IMAGE_URL]
|
|
-U OS_IMAGE_URL, --url OS_IMAGE_URL
|
|
DEPRECATED! Use --os-image-url.
|
|
--os-image-api-version OS_IMAGE_API_VERSION
|
|
Defaults to env[OS_IMAGE_API_VERSION] or 1
|
|
--os-service-type OS_SERVICE_TYPE
|
|
Defaults to env[OS_SERVICE_TYPE]
|
|
--os-endpoint-type OS_ENDPOINT_TYPE
|
|
Defaults to env[OS_ENDPOINT_TYPE]
|
|
-S OS_AUTH_STRATEGY, --os_auth_strategy OS_AUTH_STRATEGY
|
|
DEPRECATED! This option is completely ignored.</computeroutput></screen>
|
|
</example>
|
|
</section>
|