openstack/openstack-manuals
Code Issues Proposed changes

Update CLI Guide: Swift 2.1.0 release

Browse Source 
Regenerate swift commands with python-swiftclient 2.1.0.

Change-Id: Ibd758fb26a9df2b0eb44bb02ed4118374c02d237
This commit is contained in:
Andreas Jaeger
2014-05-23 19:24:16 +02:00
parent 24f42cbf48
commit 15c720a882
1 changed files with 65 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
doc/common/ch_cli_swift_commands.xml
View File

@@ -11,7 +11,7 @@
<title>Object Storage command-line client</title>
<para>The <command>swift</command> client is the command-line interface
(CLI) for the OpenStack Object Storage API and its extensions. This chapter documents
<command>swift</command> version 2.0.3.
<command>swift</command> version 2.1.0.
</para>
<para>For help on a specific <command>swift</command>
command, enter:
@@ -39,7 +39,7 @@
<term><command>delete</command></term>
<listitem>
<para>
Delete a container or objects within a container
Delete a container or objects within a container.
</para>
</listitem>
</varlistentry>
@@ -47,7 +47,7 @@
<term><command>download</command></term>
<listitem>
<para>
Download objects from containers
Download objects from containers.
</para>
</listitem>
</varlistentry>
@@ -56,7 +56,7 @@
<listitem>
<para>
Lists the containers for the account or the objects
for a container
for a container.
</para>
</listitem>
</varlistentry>
@@ -65,7 +65,7 @@
<listitem>
<para>
Updates meta information for the account, container,
or object; creates containers if not present
or object; creates containers if not present.
</para>
</listitem>
</varlistentry>
@@ -74,7 +74,7 @@
<listitem>
<para>
Displays information for the account, container,
or object
or object.
</para>
</listitem>
</varlistentry>
@@ -82,7 +82,7 @@
<term><command>upload</command></term>
<listitem>
<para>
Uploads files or directories to the given container
Uploads files or directories to the given container.
</para>
</listitem>
</varlistentry>
@@ -90,7 +90,7 @@
<term><command>capabilities</command></term>
<listitem>
<para>
List cluster capabilities
List cluster capabilities.
</para>
</listitem>
</varlistentry>
@@ -129,7 +129,7 @@
<term><command>-s, --snet</command></term>
<listitem>
<para>
Use SERVICENET internal network
Use SERVICENET internal network.
</para>
</listitem>
</varlistentry>
@@ -137,7 +137,7 @@
<term><command>-v, --verbose</command></term>
<listitem>
<para>
Print more info
Print more info.
</para>
</listitem>
</varlistentry>
@@ -163,7 +163,7 @@
<term><command>-q, --quiet</command></term>
<listitem>
<para>
Suppress status output
Suppress status output.
</para>
</listitem>
</varlistentry>
@@ -171,7 +171,7 @@
<term><command>-A AUTH, --auth=AUTH URL</command></term>
<listitem>
<para>
for obtaining an auth token
for obtaining an auth token.
</para>
</listitem>
</varlistentry>
@@ -227,7 +227,7 @@
<term><command>--os-tenant-id=&lt;auth-tenant-id&gt;</command></term>
<listitem>
<para>
OpenStack tenant ID. Defaults to <code>env[OS_TENANT_ID]</code>
OpenStack tenant ID. Defaults to <code>env[OS_TENANT_ID]</code>.
</para>
</listitem>
</varlistentry>
@@ -273,7 +273,8 @@
<term><command>--os-region-name=&lt;region-name&gt;</command></term>
<listitem>
<para>
OpenStack region name. Defaults to <code>env[OS_REGION_NAME]</code>
OpenStack region name. Defaults to
<code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
@@ -282,7 +283,7 @@
<listitem>
<para>
OpenStack Service type. Defaults to
<code>env[OS_SERVICE_TYPE]</code>
<code>env[OS_SERVICE_TYPE]</code>.
</para>
</listitem>
</varlistentry>
@@ -291,7 +292,7 @@
<listitem>
<para>
OpenStack Endpoint type. Defaults to
<code>env[OS_ENDPOINT_TYPE]</code>
<code>env[OS_ENDPOINT_TYPE]</code>.
</para>
</listitem>
</varlistentry>
@@ -300,7 +301,8 @@
<listitem>
<para>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to <code>env[OS_CACERT]</code>
(https) server certificate. Defaults to
<code>env[OS_CACERT]</code>.
</para>
</listitem>
</varlistentry>
@@ -320,7 +322,7 @@
<para>
This option is deprecated and not used anymore. SSL
compression should be disabled by default by the
system SSL library
system SSL library.
</para>
</listitem>
</varlistentry>
@@ -331,14 +333,14 @@
<screen><computeroutput>Usage: swift delete</computeroutput></screen>
<para>
Delete a container or objects within a container
Delete a container or objects within a container.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container&gt;</command></term>
<listitem>
<para>
Name of container to delete from
Name of container to delete from.
</para>
</listitem>
</varlistentry>
@@ -347,7 +349,7 @@ Delete a container or objects within a container
<listitem>
<para>
Name of object to delete. Specify multiple times
for multiple objects
for multiple objects.
</para>
</listitem>
</varlistentry>
@@ -358,7 +360,7 @@ Delete a container or objects within a container
<term><command>--all</command></term>
<listitem>
<para>
Delete all containers and objects
Delete all containers and objects.
</para>
</listitem>
</varlistentry>
@@ -366,7 +368,7 @@ Delete a container or objects within a container
<term><command>--leave-segments</command></term>
<listitem>
<para>
Do not delete segments of manifest objects
Do not delete segments of manifest objects.
</para>
</listitem>
</varlistentry>
@@ -375,7 +377,7 @@ Delete a container or objects within a container
<listitem>
<para>
Number of threads to use for deleting objects.
Default is 10
Default is 10.
</para>
</listitem>
</varlistentry>
@@ -384,7 +386,7 @@ Delete a container or objects within a container
<listitem>
<para>
Number of threads to use for deleting containers.
Default is 10
Default is 10.
</para>
</listitem>
</varlistentry>
@@ -395,7 +397,7 @@ Delete a container or objects within a container
<screen><computeroutput>Usage: swift download</computeroutput></screen>
<para>
Download objects from containers
Download objects from containers.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@@ -424,8 +426,8 @@ Download objects from containers
<term><command>--all</command></term>
<listitem>
<para>
Indicates that you really want to download
everything in the account
Indicates that you really want to download everything
in the account.
</para>
</listitem>
</varlistentry>
@@ -434,7 +436,7 @@ Download objects from containers
<listitem>
<para>
Marker to use when starting a container or account
download
download.
</para>
</listitem>
</varlistentry>
@@ -442,7 +444,7 @@ Download objects from containers
<term><command>--prefix &lt;prefix&gt;</command></term>
<listitem>
<para>
Only download items beginning with &lt;prefix&gt;
Only download items beginning with &lt;prefix&gt;.
</para>
</listitem>
</varlistentry>
@@ -452,7 +454,7 @@ Download objects from containers
<para>
For a single file download, stream the output to
&lt;out_file&gt;. Specifying "-" as &lt;out_file&gt; will
redirect to stdout
redirect to stdout.
</para>
</listitem>
</varlistentry>
@@ -479,7 +481,7 @@ Download objects from containers
<listitem>
<para>
Perform download(s), but don't actually write anything
to disk
to disk.
</para>
</listitem>
</varlistentry>
@@ -497,7 +499,8 @@ Download objects from containers
<term><command>--skip-identical</command></term>
<listitem>
<para>
Skip downloading files that are identical on both sides
Skip downloading files that are identical on both
sides.
</para>
</listitem>
</varlistentry>
@@ -508,14 +511,14 @@ Download objects from containers
<screen><computeroutput>Usage: swift list</computeroutput></screen>
<para>
Lists the containers for the account or the objects for a container
Lists the containers for the account or the objects for a container.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>[container]</command></term>
<listitem>
<para>
Name of container to list object in
Name of container to list object in.
</para>
</listitem>
</varlistentry>
@@ -526,7 +529,7 @@ Lists the containers for the account or the objects for a container
<term><command>--long</command></term>
<listitem>
<para>
Long listing format, similar to ls -l
Long listing format, similar to ls -l.
</para>
</listitem>
</varlistentry>
@@ -534,7 +537,8 @@ Lists the containers for the account or the objects for a container
<term><command>--lh</command></term>
<listitem>
<para>
Report sizes in human readable format similar to ls -lh
Report sizes in human readable format similar to
ls -lh.
</para>
</listitem>
</varlistentry>
@@ -542,7 +546,7 @@ Lists the containers for the account or the objects for a container
<term><command>--totals</command></term>
<listitem>
<para>
Used with -l or --lh, only report totals
Used with -l or --lh, only report totals.
</para>
</listitem>
</varlistentry>
@@ -550,7 +554,7 @@ Lists the containers for the account or the objects for a container
<term><command>--prefix</command></term>
<listitem>
<para>
Only list items beginning with the prefix
Only list items beginning with the prefix.
</para>
</listitem>
</varlistentry>
@@ -579,7 +583,7 @@ If the container is not found, it will be created automatically.
<term><command>[container]</command></term>
<listitem>
<para>
Name of container to post to
Name of container to post to.
</para>
</listitem>
</varlistentry>
@@ -588,7 +592,7 @@ If the container is not found, it will be created automatically.
<listitem>
<para>
Name of object to post. Specify multiple times
for multiple objects
for multiple objects.
</para>
</listitem>
</varlistentry>
@@ -618,7 +622,7 @@ If the container is not found, it will be created automatically.
<term><command>--sync-to &lt;sync-to&gt;</command></term>
<listitem>
<para>
Sync To for containers, for multi-cluster replication
Sync To for containers, for multi-cluster replication.
</para>
</listitem>
</varlistentry>
@@ -626,7 +630,7 @@ If the container is not found, it will be created automatically.
<term><command>--sync-key &lt;sync-key&gt;</command></term>
<listitem>
<para>
Sync Key for containers, for multi-cluster replication
Sync Key for containers, for multi-cluster replication.
</para>
</listitem>
</varlistentry>
@@ -655,14 +659,14 @@ If the container is not found, it will be created automatically.
<screen><computeroutput>Usage: swift stat</computeroutput></screen>
<para>
Displays information for the account, container, or object
Displays information for the account, container, or object.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>[container]</command></term>
<listitem>
<para>
Name of container to stat from
Name of container to stat from.
</para>
</listitem>
</varlistentry>
@@ -671,7 +675,7 @@ Displays information for the account, container, or object
<listitem>
<para>
Name of object to stat. Specify multiple times
for multiple objects
for multiple objects.
</para>
</listitem>
</varlistentry>
@@ -682,7 +686,8 @@ Displays information for the account, container, or object
<term><command>--lh</command></term>
<listitem>
<para>
Report sizes in human readable format similar to ls -lh
Report sizes in human readable format similar to
ls -lh.
</para>
</listitem>
</varlistentry>
@@ -693,14 +698,14 @@ Displays information for the account, container, or object
<screen><computeroutput>Usage: swift upload</computeroutput></screen>
<para>
Uploads specified files and directories to the given container
Uploads specified files and directories to the given container.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container&gt;</command></term>
<listitem>
<para>
Name of container to upload to
Name of container to upload to.
</para>
</listitem>
</varlistentry>
@@ -709,7 +714,7 @@ Uploads specified files and directories to the given container
<listitem>
<para>
Name of file or directory to upload. Specify multiple
times for multiple uploads
times for multiple uploads.
</para>
</listitem>
</varlistentry>
@@ -721,7 +726,7 @@ Uploads specified files and directories to the given container
<listitem>
<para>
Only upload files that have changed since the last
upload
upload.
</para>
</listitem>
</varlistentry>
@@ -729,7 +734,7 @@ Uploads specified files and directories to the given container
<term><command>--skip-identical</command></term>
<listitem>
<para>
Skip uploading files that are identical on both sides
Skip uploading files that are identical on both sides.
</para>
</listitem>
</varlistentry>
@@ -737,9 +742,10 @@ Uploads specified files and directories to the given container
<term><command>--segment-size &lt;size&gt;</command></term>
<listitem>
<para>
Upload files in segments no larger than &lt;size&gt; and
then create a "manifest" file that will download all
the segments as if it were the original file
Upload files in segments no larger than &lt;size&gt; (in
Bytes) and then create a "manifest" file that will
download all the segments as if it were the original
file.
</para>
</listitem>
</varlistentry>
@@ -749,7 +755,7 @@ Uploads specified files and directories to the given container
<para>
Upload the segments into the specified container. If
not specified, the segments will be uploaded to a
&lt;container&gt;_segments container so as to not pollute the
&lt;container&gt;_segments container to not pollute the
main &lt;container&gt; listings.
</para>
</listitem>
@@ -759,7 +765,7 @@ Uploads specified files and directories to the given container
<listitem>
<para>
Indicates that you want the older segments of manifest
objects left alone (in the case of overwrites)
objects left alone (in the case of overwrites).
</para>
</listitem>
</varlistentry>
@@ -795,7 +801,7 @@ Uploads specified files and directories to the given container
<term><command>--use-slo</command></term>
<listitem>
<para>
When used in conjunction with --segment-size will
When used in conjunction with --segment-size it will
create a Static Large Object instead of the default
Dynamic Large Object.
</para>
@@ -807,7 +813,7 @@ Uploads specified files and directories to the given container
<para>
Upload file and name object to &lt;object-name&gt; or upload
dir and use &lt;object-name&gt; as object prefix instead of
folder name
folder name.
</para>
</listitem>
</varlistentry>