diff --git a/doc/cli-reference/source/swift.rst b/doc/cli-reference/source/swift.rst index a889cb3e46..3b65405066 100644 --- a/doc/cli-reference/source/swift.rst +++ b/doc/cli-reference/source/swift.rst @@ -2,14 +2,14 @@ .. This file is automatically generated, do not edit .. ################################################# -================================== -Object Storage command-line client -================================== +========================================== +Object Storage service command-line client +========================================== -The :command:`swift` client is the command-line interface (CLI) for -the OpenStack Object Storage API and its extensions. +The swift client is the command-line interface (CLI) for +the Object Storage service API and its extensions. -This chapter documents :command:`swift` version ``2.7.0``. +This chapter documents :command:`swift` version ``3.0.0``. For help on a specific :command:`swift` command, enter: @@ -26,7 +26,9 @@ swift usage Usage: swift [--version] [--help] [--os-help] [--snet] [--verbose] [--debug] [--info] [--quiet] [--auth <auth_url>] - [--auth-version <auth_version>] [--user <username>] + [--auth-version <auth_version> | + --os-identity-api-version <auth_version> ] + [--user <username>] [--key <api_key>] [--retries <num_retries>] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-user-id <auth-user-id>] @@ -46,8 +48,7 @@ swift usage [--no-ssl-compression] <subcommand> [--help] [<subcommand options>] -Subcommands ------------ +**Subcommands:** ``delete`` Delete a container or objects within a container. @@ -79,7 +80,7 @@ Subcommands ``auth`` Display auth related environment variables. -.. _swift_command_exmaples: +.. _swift_examples: swift examples ~~~~~~~~~~~~~~ @@ -143,8 +144,14 @@ swift optional arguments ``-A AUTH, --auth=AUTH`` URL for obtaining an auth token. -``-V AUTH_VERSION, --auth-version=AUTH_VERSION`` - Specify a version for authentication. Defaults to 1.0. +``-V AUTH_VERSION,`` + +``--auth-version=AUTH_VERSION,`` + +``--os-identity-api-version=AUTH_VERSION`` + Specify a version for authentication. Defaults to + ``env[ST_AUTH_VERSION]``, ``env[OS_AUTH_VERSION]``, + ``env[OS_IDENTITY_API_VERSION]`` or 1.0. ``-U USER, --user=USER`` User name for obtaining an auth token. @@ -168,7 +175,7 @@ swift optional arguments .. _swift_capabilities: swift capabilities -~~~~~~~~~~~~~~~~~~ +------------------ .. code-block:: console @@ -176,8 +183,7 @@ swift capabilities Retrieve capability of the proxy. -Optional positional arguments ------------------------------ +**Optional positional arguments:** ``<proxy_url>`` Proxy URL of the cluster to retrieve capabilities. @@ -185,7 +191,7 @@ Optional positional arguments .. _swift_delete: swift delete -~~~~~~~~~~~~ +------------ .. code-block:: console @@ -193,18 +199,16 @@ swift delete Delete a container or objects within a container. -Positional arguments --------------------- +**Positional arguments:** ``[<container>]`` Name of container to delete from. -``[object]`` +``[<object>]`` Name of object to delete. Specify multiple times for multiple objects. -Optional arguments ------------------- +**Optional arguments:** ``-a, --all`` Delete all containers and objects. @@ -223,7 +227,7 @@ Optional arguments .. _swift_download: swift download -~~~~~~~~~~~~~~ +-------------- .. code-block:: console @@ -231,20 +235,18 @@ swift download Download objects from containers. -Positional arguments --------------------- +**Positional arguments:** ``<container>`` Name of container to download from. To download a - whole account, omit this and specify --all. + whole account, omit this and specify :option:`--all`. ``<object>`` Name of object to download. Specify multiple times for multiple objects. Omit this to download all objects from the container. -Optional arguments ------------------- +**Optional arguments:** ``-a, --all`` Indicates that you really want to download @@ -305,7 +307,7 @@ Optional arguments .. _swift_list: swift list -~~~~~~~~~~ +---------- .. code-block:: console @@ -313,24 +315,22 @@ swift list Lists the containers for the account or the objects for a container. -Positional arguments --------------------- +**Positional arguments:** ``[container]`` Name of container to list object in. -Optional arguments ------------------- +**Optional arguments:** ``-l, --long`` - Long listing format, similar to ls :option:`-l`. + Long listing format, similar to ls -l. ``--lh`` Report sizes in human readable format similar to - ls :option:`-lh`. + ls -lh. ``-t, --totals`` - Used with :option:`-l` or :option:`--lh`, only report totals. + Used with -l or :option:`--lh,` only report totals. ``-p <prefix>, --prefix <prefix>`` Only list items beginning with the prefix. @@ -343,7 +343,7 @@ Optional arguments .. _swift_post: swift post -~~~~~~~~~~ +---------- .. code-block:: console @@ -352,8 +352,7 @@ swift post Updates meta information for the account, container, or object. If the container is not found, it will be created automatically. -Positional arguments --------------------- +**Positional arguments:** ``[container]`` Name of container to post to. @@ -361,8 +360,7 @@ Positional arguments ``[object]`` Name of object to post. -Optional arguments ------------------- +**Optional arguments:** ``-r, --read-acl <acl>`` Read ACL for containers. Quick summary of ACL syntax: @@ -391,7 +389,7 @@ Optional arguments .. _swift_stat: swift stat -~~~~~~~~~~ +---------- .. code-block:: console @@ -399,8 +397,7 @@ swift stat Displays information for the account, container, or object. -Positional arguments --------------------- +**Positional arguments:** ``[container]`` Name of container to stat from. @@ -408,8 +405,7 @@ Positional arguments ``[object]`` Name of object to stat. -Optional arguments ------------------- +**Optional arguments:** ``--lh`` Report sizes in human readable format similar to @@ -418,7 +414,7 @@ Optional arguments .. _swift_tempurl: swift tempurl -~~~~~~~~~~~~~ +------------- .. code-block:: console @@ -426,8 +422,7 @@ swift tempurl Generates a temporary URL for a Swift object. -Positional arguments --------------------- +**Positional arguments:** ``<method>`` An HTTP method to allow for this temporary URL. @@ -447,18 +442,17 @@ Positional arguments To set a key, run 'swift post -m "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"' -Optional arguments ------------------- +**Optional arguments:** ``--absolute`` - Interpet the <seconds> positional argument as a Unix + Interpret the <seconds> positional argument as a Unix timestamp rather than a number of seconds in the future. .. _swift_upload: swift upload -~~~~~~~~~~~~ +------------ .. code-block:: console @@ -466,8 +460,7 @@ swift upload Uploads specified files and directories to the given container. -Positional arguments --------------------- +**Positional arguments:** ``<container>`` Name of container to upload to. @@ -476,8 +469,7 @@ Positional arguments Name of file or directory to upload. Specify multiple times for multiple uploads. -Optional arguments ------------------- +**Optional arguments:** ``-c, --changed`` Only upload files that have changed since the last @@ -531,7 +523,7 @@ Optional arguments .. _swift_auth: swift auth -~~~~~~~~~~ +---------- .. code-block:: console @@ -540,13 +532,13 @@ swift auth Display auth related authentication variables in shell friendly format. Commands to run to export storage url and auth token into -OS_STORAGE_URL and OS_AUTH_TOKEN: +``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``: .. code-block:: console $ swift auth -Commands to append to a runcom file (e.g. ~/.bashrc, /etc/profile) for +Commands to append to a runcom file (e.g. ``~/.bashrc``, ``/etc/profile``) for automatic authentication: .. code-block:: console