64b6c9261e
Current folder name New folder name Book title ---------------------------------------------------------- basic-install DELETE cli-guide DELETE common common NEW admin-guide-cloud Cloud Administrators Guide docbkx-example DELETE openstack-block-storage-admin DELETE openstack-compute-admin DELETE openstack-config config-reference OpenStack Configuration Reference openstack-ha high-availability-guide OpenStack High Availabilty Guide openstack-image image-guide OpenStack Virtual Machine Image Guide openstack-install install-guide OpenStack Installation Guide openstack-network-connectivity-admin admin-guide-network OpenStack Networking Administration Guide openstack-object-storage-admin DELETE openstack-security security-guide OpenStack Security Guide openstack-training training-guide OpenStack Training Guide openstack-user user-guide OpenStack End User Guide openstack-user-admin user-guide-admin OpenStack Admin User Guide glossary NEW OpenStack Glossary bug: #1220407 Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7 author: diane fleming
76 lines
3.6 KiB
XML
76 lines
3.6 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="cli_help">
|
|
<title>Get help for client commands</title>
|
|
<para>To get usage information, including a list of commands with
|
|
descriptions, for a client, run the following command:</para>
|
|
<screen><prompt>$</prompt> <userinput><replaceable>CLIENT_NAME</replaceable> help</userinput></screen>
|
|
<para>For example, to get help information for the swift client,
|
|
run the following command:</para>
|
|
<screen><prompt>$</prompt> <userinput>swift help</userinput></screen>
|
|
<screen><?db-font-size 65%?><computeroutput>Usage: swift [--version] [--help] [--snet] [--verbose]
|
|
[--debug] [--quiet] [--auth <auth_url>]
|
|
[--auth-version <auth_version>] [--user <username>]
|
|
[--key <api_key>] [--retries <num_retries>]
|
|
[--os-username <auth-user-name>] [--os-password <auth-password>]
|
|
[--os-tenant-id <auth-tenant-id>]
|
|
[--os-tenant-name <auth-tenant-name>]
|
|
[--os-auth-url <auth-url>] [--os-auth-token <auth-token>]
|
|
[--os-storage-url <storage-url>] [--os-region-name <region-name>]
|
|
[--os-service-type <service-type>]
|
|
[--os-endpoint-type <endpoint-type>]
|
|
[--os-cacert <ca-certificate>] [--insecure]
|
|
[--no-ssl-compression]
|
|
<subcommand> ...
|
|
|
|
Command-line interface to the OpenStack Swift API.
|
|
|
|
Positional arguments:
|
|
<subcommand>
|
|
delete Delete a container or objects within a container
|
|
downlad Download objects from containers
|
|
list Lists the containers for the account or the objects
|
|
for a container
|
|
post Updates meta information for the account, container,
|
|
or object
|
|
stat Displays information for the account, container,
|
|
or object
|
|
upload Uploads files or directories to the given container
|
|
|
|
Examples:
|
|
swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key stat -v
|
|
|
|
swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \
|
|
--os-username user --os-password password list
|
|
|
|
swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \
|
|
--os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
|
|
list
|
|
|
|
swift list --lh</computeroutput></screen>
|
|
<note>
|
|
<para>Depending on your credentials, you might not have
|
|
permission to use every command.</para>
|
|
</note>
|
|
<para>After the <option>help</option> command, you can enter a
|
|
command name to get help for that command, as follows:</para>
|
|
<screen><prompt>$</prompt> <userinput><replaceable>CLIENT_NAME</replaceable> help <replaceable>COMMAND_NAME</replaceable></userinput></screen>
|
|
<para>For example, to get help for the glance
|
|
<command>image-show</command> command, enter the following
|
|
command:</para>
|
|
<screen><prompt>$</prompt> <userinput>glance help image-show</userinput></screen>
|
|
<para>The command returns a description of the command and its
|
|
positional and optional arguments:</para>
|
|
<screen><?db-font-size 75%?><computeroutput>usage: glance image-show [--human-readable] <IMAGE>
|
|
|
|
Describe a specific image.
|
|
|
|
Positional arguments:
|
|
<IMAGE> Name or ID of image to describe.
|
|
|
|
Optional arguments:
|
|
--human-readable Print image size in a human-friendly format.</computeroutput></screen>
|
|
</section>
|