SupportConsoleDevelopersStart a trialContact

Chapter 55. object

This chapter describes the commands under the object command.

55.1. object create

Upload object to container

Usage:

openstack object create [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN]
                               [--sort-ascending | --sort-descending]
                               [--name <name>]
                               <container> <filename> [<filename> ...]

Table 55.1. Positional arguments
ValueSummary

<container>

Container for new object

<filename>

Local filename(s) to upload

Table 55.2. Command 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

Table 55.3. Output formatter options
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 to show multiple columns

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

Table 55.4. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 55.5. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 55.6. Table formatter options
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.

55.2. object delete

Delete object from container

Usage:

openstack object delete [-h] <container> <object> [<object> ...]

Table 55.7. Positional arguments
ValueSummary

<container>

Delete object(s) from <container>

<object>

Object(s) to delete

Table 55.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

55.3. object list

List objects

Usage:

openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--noindent] [--max-width <integer>]
                             [--fit-width] [--print-empty]
                             [--sort-column SORT_COLUMN]
                             [--sort-ascending | --sort-descending]
                             [--prefix <prefix>] [--delimiter <delimiter>]
                             [--marker <marker>] [--end-marker <end-marker>]
                             [--limit <num-objects>] [--long] [--all]
                             <container>

Table 55.9. Positional arguments
ValueSummary

<container>

Container to list

Table 55.10. Command 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)

Table 55.11. Output formatter options
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 to show multiple columns

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

Table 55.12. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 55.13. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 55.14. Table formatter options
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.

55.4. object save

Save object locally

Usage:

openstack object save [-h] [--file <filename>] <container> <object>

Table 55.15. Positional arguments
ValueSummary

<container>

Download <object> from <container>

<object>

Object to save

Table 55.16. Command 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

55.5. object set

Set object properties

Usage:

openstack object set [-h] --property <key=value> <container> <object>

Table 55.17. Positional arguments
ValueSummary

<container>

Modify <object> from <container>

<object>

Object to modify

Table 55.18. Command 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)

55.6. object show

Display object details

Usage:

openstack object show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty]
                             <container> <object>

Table 55.19. Positional arguments
ValueSummary

<container>

Display <object> from <container>

<object>

Object to display

Table 55.20. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 55.21. Output formatter options
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 to show multiple columns

Table 55.22. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 55.23. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 55.24. Table formatter options
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.

55.7. object store account set

Set account properties

Usage:

openstack object store account set [-h] --property <key=value>

Table 55.25. Command 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)

55.8. object store account show

Display account details

Usage:

openstack object store account show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--noindent]
                                           [--prefix PREFIX]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]

Table 55.26. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 55.27. Output formatter options
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 to show multiple columns

Table 55.28. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 55.29. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 55.30. Table formatter options
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.

55.9. object store account unset

Unset account properties

Usage:

openstack object store account unset [-h] --property <key>

Table 55.31. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

55.10. object unset

Unset object properties

Usage:

openstack object unset [-h] --property <key> <container> <object>

Table 55.32. Positional arguments
ValueSummary

<container>

Modify <object> from <container>

<object>

Object to modify

Table 55.33. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

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

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.

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.

© 2024 Red Hat, Inc.