Object Storage service (OBS)¶
The OBS client is the command-line interface (CLI) for the ObjectBlockStorage service (OBS) API and its extensions.
For help on a specific obs command, enter:
$ openstack obs help SUBCOMMAND
Container (bucket) operations¶
obs container create¶
Create new container
openstack obs container create
[--storage-class {STANDARD,STANDARD_IA,GLACIER}]
<container-name>
-
--storage-class
{STANDARD,STANDARD_IA,GLACIER}
¶ Storage class
-
container-name
¶
New container name(s)
This command is provided by the otcextensions plugin.
obs container delete¶
Delete container
openstack obs container delete
[--recursive]
<container>
[<container> ...]
-
--recursive
,
-r
¶
Recursively delete objects and container
-
container
¶
Container(s) to delete
This command is provided by the otcextensions plugin.
obs container list¶
List containers
openstack obs container list
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
-
--sort-column
SORT_COLUMN
¶ specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the otcextensions plugin.
obs container show¶
Display container details
openstack obs container show <container>
-
container
¶
Container to display
This command is provided by the otcextensions plugin.
Object operations¶
obs object create¶
Upload object to container
openstack obs object create
[--name <name>]
[--name-prefix <prefix>]
<container>
<filename>
[<filename> ...]
-
--name
<name>
¶ Upload a file and rename it. Can only be used when uploading a single object
-
--name-prefix
<prefix>
¶ Object name prefix. Useful when uploading multiple objects
-
container
¶
Container for new object
-
filename
¶
Local filename(s) to upload
This command is provided by the otcextensions plugin.
obs object delete¶
Delete object from container
openstack obs object delete <container> <object> [<object> ...]
-
container
¶
Delete object(s) from <container>
-
object
¶
Object(s) to delete
This command is provided by the otcextensions plugin.
obs object list¶
List objects
openstack obs object list
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--delimiter <delimiter>]
[--marker <marker>]
[--end-marker <end-marker>]
[--limit <num-objects>]
[--long]
[--all]
<container>
-
--sort-column
SORT_COLUMN
¶ specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--delimiter
<delimiter>
¶ Roll up items with <delimiter>
-
--marker
<marker>
¶ Anchor for paging
-
--end-marker
<end-marker>
¶ End anchor for paging
-
--limit
<num-objects>
¶ Limit the number of objects returned
-
--long
¶
List additional fields in output
-
--all
¶
List all objects in container (default is 10000)
-
container
¶
Container to list
This command is provided by the otcextensions plugin.
obs object save¶
Save object locally
openstack obs object save [--file <filename>] <container> <object>
-
--file
<filename>
¶ Destination filename (defaults to object name); using “-” as the filename will print the file to stdout
-
container
¶
Download <object> from <container>
-
object
¶
Object to save
This command is provided by the otcextensions plugin.
obs object show¶
Display object details
openstack obs object show <container> <object>
-
container
¶
Display <object> from <container>
-
object
¶
Object to display
This command is provided by the otcextensions plugin.