table of contents
swift(1) | OpenStack Swift | swift(1) |
NAME¶
swift - OpenStack Swift client tool
SYNOPSIS¶
swift [options] <command> [args]
DESCRIPTION¶
The swift tool is a command line utility for communicating with an OpenStack Object Storage (Swift) environment. It allows one to perform several types of operations.
COMMANDS¶
stat [command-options] [container] [object]
list [command-options] [container]
The -l or --long and --lh options provide more detail, similar to ls -l and ls -lh, the latter providing sizes in human readable format (eg 3K, 12M, etc). These latter 2 switches use more overhead to get those details, which is directly proportional to the number of container or objects being listed. With the -t or --total option they only report totals.
upload [command-options] container file_or_directory [file_or_directory] [...]
post [command-options] [container] [object]
copy [command-options] container object
download [command-options] [container] [object] [object] [...]
delete [command-options] [container] [object] [object] [...]
capabilities [command-options] [proxy-url]
By default, the output includes the list of the activated Swift middlewares as well as relevant options for each one. Additionally the command displays relevant options for the Swift core.
The --json option will print a json representation of the cluster capabilities. This is typically more suitable for consumption by other programs, such as jq.
Example: capabilities https://swift.example.com
capabilities --json
tempurl [command-option] method time path key
The time can be specified either as an integer denoting the amount of seconds the temporary URL is valid, or as an ISO 8601 timestamp in one of following formats: Complete date: YYYY-MM-DD (eg 1997-07-16), complete date plus hours, minutes and seconds: YYYY-MM-DDThh:mm:ss (eg 1997-07-16T19:20:30) or complete date plus hours, minutes and seconds with UTC designator: YYYY-MM-DDThh:mm:ssZ (eg 1997-07-16T19:20:30Z). Be aware that if you do not use the latter format, the timestamp is generated using your locale timezone. If the first format is used, the time part used will equal to 00:00:00.
With the --prefix-based option a prefix-based URL is generated.
The option --iso8601 provides ISO 8601 UTC timestamps instead of Unix timestamps inside the generated URL.
If optional --absolute argument is provided and the time argument is specified in seconds, the seconds are interpreted as a Unix timestamp at which the URL should expire.
Example: tempurl GET $(date -d "Jan 1 2016" +%s) /v1/AUTH_foo/bar_container/quux.md my_secret_tempurl_key --absolute
auth
OPTIONS¶
- --version Show program's version number and exit
- -h, --help Show this (or any subcommand if after command) help message and exit
- -s, --snet Use SERVICENET internal network
- -v, --verbose Print more info
- -q, --quiet Suppress status output
- -A AUTH, --auth=AUTH URL for obtaining an auth token
- -U USER, --user=USER User name for obtaining an auth token
- -V 1|2, --auth-version=VERSION Authentication protocol version
- -K KEY, --key=KEY Key for obtaining an auth token
- --os-storage-url=URL Use this instead of URL returned from auth
- --os-help Show all OpenStack authentication options
EXAMPLE¶
swift -A https://127.0.0.1:443/auth/v1.0 -U swiftops:swiftops -K swiftops stat
DOCUMENTATION¶
More in depth documentation about OpenStack Swift as a whole can be found at https://docs.openstack.org/swift/latest/
8/26/2011 | Linux |