Get help for client commandsTo get usage information, including a list of commands with
descriptions, for a client, run the following command:$CLIENT_NAME helpFor example, to get help information for the swift client,
run the following command:$swift helpUsage: 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
download 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 --lhDepending on your credentials, you might not have
permission to use every command.After the command, you can enter a
command name to get help for that command, as follows:$CLIENT_NAME help COMMAND_NAMEFor example, to get help for the glance
image-show command, enter the following
command:$glance help image-showThe command returns a description of the command and its
positional and optional arguments: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.