Menu Close

Chapter 21. container

This chapter describes the commands under the container command.

21.1. container create

Create new container

Usage:

openstack container 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]
                                  <container-name> [<container-name> ...]

Table 21.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 21.2. Positional Arguments

ValueSummary

<container-name>

New container name(s)

Table 21.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 21.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 21.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

21.2. container delete

Delete container

Usage:

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

Table 21.7. Positional Arguments

ValueSummary

<container>

Container(s) to delete

Table 21.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--recursive, -r

Recursively delete objects and container

21.3. container list

List containers

Usage:

openstack container 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>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

Table 21.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 21.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 21.11. 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 21.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.13. Optional Arguments

ValueSummary

--limit <num-containers>

Limit the number of containers returned

--marker <marker>

Anchor for paging

--long

List additional fields in output

--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 containers (default is 10000)

21.4. container save

Save container contents locally

Usage:

openstack container save [-h] <container>

Table 21.14. Positional Arguments

ValueSummary

<container>

Container to save

Table 21.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

21.5. container set

Set container properties

Usage:

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

Table 21.16. Positional Arguments

ValueSummary

<container>

Container to modify

Table 21.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key=value>

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

21.6. container show

Display container details

Usage:

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

Table 21.18. 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 21.19. Positional Arguments

ValueSummary

<container>

Container to display

Table 21.20. 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 21.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 21.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 21.23. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

21.7. container unset

Unset container properties

Usage:

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

Table 21.24. Positional Arguments

ValueSummary

<container>

Container to modify

Table 21.25. Optional Arguments

ValueSummary

--property <key>

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

-h, --help

Show this help message and exit