Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 9. Object Storage Service Command-line Client

The swift client is the command-line interface (CLI) for the OpenStack Object Storage API and its extensions. This chapter documents swift version 3.1.0.
For help on a specific swift command, enter: 
$ swift COMMAND --help

9.1. swift Usage

usage: swift [--version] [--help] [--os-help] [--snet] [--verbose]
             [--debug] [--info] [--quiet] [--auth <auth_url>]
             [--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>]
             [--os-user-domain-id <auth-user-domain-id>]
             [--os-user-domain-name <auth-user-domain-name>]
             [--os-tenant-id <auth-tenant-id>]
             [--os-tenant-name <auth-tenant-name>]
             [--os-project-id <auth-project-id>]
             [--os-project-name <auth-project-name>]
             [--os-project-domain-id <auth-project-domain-id>]
             [--os-project-domain-name <auth-project-domain-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]
             [--os-cert <client-certificate-file>]
             [--os-key <client-certificate-key-file>]
             [--no-ssl-compression]
             <subcommand> [--help] [<subcommand options>]

Subcommands

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; creates containers if not present.

copy


        Copies object, optionally adds meta

stat


        Displays information for the account, container,
      or object.

upload


        Uploads files or directories to the given container.

capabilities


        List cluster capabilities.

tempurl


        Create a temporary URL.

auth


        Display auth related environment variables.