Chapter 49. object


This chapter describes the commands under the object command.

49.1. object create

Usage:

openstack object create [-h] [-f {csv,json,table,value,yaml}]

                             [-c COLUMN] [--max-width <integer>]
                             [--fit-width] [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--name <name>]
                             <container> <filename> [<filename> ...]
Copy to Clipboard Toggle word wrap

Upload object to container

Expand
Table 49.1. Positional Arguments
ValueSummary

<container>

Container for new object

<filename>

Local filename(s) to upload

Expand
Table 49.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Upload a file and rename it. can only be used when uploading a single object

Expand
Table 49.3. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 49.4. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 49.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 49.6. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

49.2. object delete

Usage:

openstack object delete [-h] <container> <object> [<object> ...]
Copy to Clipboard Toggle word wrap

Delete object from container

Expand
Table 49.7. Positional Arguments
ValueSummary

<container>

Delete object(s) from <container>

<object>

Object(s) to delete

Expand
Table 49.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

49.3. object list

Usage:

openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--sort-column SORT_COLUMN] [--prefix <prefix>]
                           [--delimiter <delimiter>] [--marker <marker>]
                           [--end-marker <end-marker>]
                           [--limit <num-objects>] [--long] [--all]
                           <container>
Copy to Clipboard Toggle word wrap

List objects

Expand
Table 49.9. Positional Arguments
ValueSummary

<container>

Container to list

Expand
Table 49.10. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--prefix <prefix>

Filter list using <prefix>

--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)

Expand
Table 49.11. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 49.12. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 49.13. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 49.14. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

49.4. object save

Usage:

openstack object save [-h] [--file <filename>] <container> <object>
Copy to Clipboard Toggle word wrap

Save object locally

Expand
Table 49.15. Positional Arguments
ValueSummary

<container>

Download <object> from <container>

<object>

Object to save

Expand
Table 49.16. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

Destination filename (defaults to object name); using '-' as the filename will print the file to stdout

49.5. object set

Usage:

openstack object set [-h] --property <key=value> <container> <object>
Copy to Clipboard Toggle word wrap

Set object properties

Expand
Table 49.17. Positional Arguments
ValueSummary

<container>

Modify <object> from <container>

<object>

Object to modify

Expand
Table 49.18. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Set a property on this object (repeat option to set multiple properties)

49.6. object show

Usage:

openstack object show [-h] [-f {json,shell,table,value,yaml}]

                           [-c COLUMN] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           <container> <object>
Copy to Clipboard Toggle word wrap

Display object details

Expand
Table 49.19. Positional Arguments
ValueSummary

<container>

Display <object> from <container>

<object>

Object to display

Expand
Table 49.20. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 49.21. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 49.22. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 49.23. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 49.24. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

49.7. object store account set

Usage:

openstack object store account set [-h] --property <key=value>
Copy to Clipboard Toggle word wrap

Set account properties

Expand
Table 49.25. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

Set a property on this account (repeat option to set multiple properties)

49.8. object store account show

Usage:

openstack object store account show [-h]

                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Display account details

Expand
Table 49.26. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 49.27. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 49.28. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 49.29. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 49.30. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

49.9. object store account unset

Usage:

openstack object store account unset [-h] --property <key>
Copy to Clipboard Toggle word wrap

Unset account properties

Expand
Table 49.31. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from account (repeat option to remove multiple properties)

49.10. object unset

Usage:

openstack object unset [-h] --property <key> <container> <object>
Copy to Clipboard Toggle word wrap

Unset object properties

Expand
Table 49.32. Positional Arguments
ValueSummary

<container>

Modify <object> from <container>

<object>

Object to modify

Expand
Table 49.33. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from object (repeat option to remove multiple properties)

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat