Menu Close

Chapter 44. object

This chapter describes the commands under the object command.

44.1. object create

Upload object to container

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

Table 44.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 44.2. Positional Arguments

ValueSummary

<filename>

Local filename(s) to upload

<container>

Container for new object

Table 44.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 44.4. Output Formatters

ValueSummary

output formatter options-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

Table 44.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 44.6. Optional Arguments

ValueSummary

--name <name>

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

-h, --help

Show this help message and exit

44.2. object delete

Delete object from container

Usage:

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

Table 44.7. Positional Arguments

ValueSummary

<object>

Object(s) to delete

<container>

Delete object(s) from <container>

Table 44.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

44.3. object list

List objects

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>

Table 44.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 44.10. Positional Arguments

ValueSummary

<container>

Container to list

Table 44.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 44.12. Output Formatters

ValueSummary

output formatter options-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

Table 44.13. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 44.14. Optional Arguments

ValueSummary

--marker <marker>

Anchor for paging

--long

List additional fields in output

--delimiter <delimiter>

Roll up items with <delimiter>

--limit <num-objects>

Limit the number of objects returned

--end-marker <end-marker>

End anchor for paging

-h, --help

Show this help message and exit

--prefix <prefix>

Filter list using <prefix>

--all

List all objects in container (default is 10000)

44.4. object save

Save object locally

Usage:

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

Table 44.15. Positional Arguments

ValueSummary

<object>

Object to save

<container>

Download <object> from <container>

Table 44.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

44.5. object set

Set object properties

Usage:

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

Table 44.17. Positional Arguments

ValueSummary

<object>

Object to modify

<container>

Modify <object> from <container>

Table 44.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)

44.6. object show

Display object details

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>

Table 44.19. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 44.20. Positional Arguments

ValueSummary

<object>

Object to display

<container>

Display <object> from <container>

Table 44.21. Output Formatters

ValueSummary

output formatter options-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

Table 44.22. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 44.23. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 44.24. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

44.7. object store account set

Set account properties

Usage:

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

Table 44.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)

44.8. object store account show

Display account details

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]

Table 44.26. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 44.27. Output Formatters

ValueSummary

output formatter options-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

Table 44.28. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 44.29. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 44.30. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

44.9. object store account unset

Unset account properties

Usage:

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

Table 44.31. Optional Arguments

ValueSummary

--property <key>

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

-h, --help

Show this help message and exit

44.10. object unset

Unset object properties

Usage:

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

Table 44.32. Positional Arguments

ValueSummary

<object>

Object to modify

<container>

Modify <object> from <container>

Table 44.33. Optional Arguments

ValueSummary

--property <key>

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

-h, --help

Show this help message and exit