openstack-manuals/doc/common/section_cli_swift_commands.xml
Diane Fleming ccb80d725d Renamed cli files for consistency
Updated a typo (keystone-mange -> keystone-manage)
Updated a few capitalization errors in titles

Change-Id: I38ec2a6c53b9e3a1e1bf330b54c26f293a764d94
author: diane fleming
2014-01-06 15:06:29 -06:00

53 lines
2.7 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="swift_commands">
<title>swift commands</title>
<para>The swift client is the command-line interface for the
OpenStack Object Storage API.</para>
<para>For help on a specific swift command, enter:</para>
<screen><prompt>$</prompt> <userinput>swift <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>swift [--version] [--help] [--snet] [--verbose]
[--debug] [--quiet] [--auth &lt;auth_url>]
[--auth-version &lt;auth_version>] [--user &lt;username>]
[--key &lt;api_key>] [--retries &lt;num_retries>]
[--os-username &lt;auth-user-name>] [--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;auth-tenant-id>]
[--os-auth-url &lt;auth-url>] [--os-auth-token &lt;auth-token>]
[--os-storage-url &lt;storage-url>] [--os-region-name &lt;region-name>]
[--os-service-type &lt;service-type>]
[--os-endpoint-type &lt;endpoint-type>]
[--os-cacert &lt;ca-certificate>] [--insecure]
[--no-ssl-compression]
&lt;subcommand> ... </computeroutput></screen>
</example>
<example>
<title>Commands</title>
<screen><computeroutput>&lt;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
</computeroutput></screen>
</example>
<example>
<title>Examples</title>
<screen><prompt>$</prompt> <userinput>swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K key stat</userinput></screen>
<screen><prompt>$</prompt> <userinput>swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \
--os-usernameuser --os-password password list</userinput></screen>
<screen><prompt>$</prompt> <userinput>swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \
--os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
list</userinput></screen>
<screen><prompt>$</prompt> <userinput>swift list --lh</userinput></screen>
</example>
</section>