Chapter 24. container

This chapter describes the commands under the container command.

24.1. container create

Create new container

Usage:

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

Table 24.1. Positional Arguments

ValueSummary

<container-name>

New container name(s)

Table 24.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 24.4. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 24.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

24.2. container delete

Delete container

Usage:

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

Table 24.7. Positional Arguments

ValueSummary

<container>

Container(s) to delete

Table 24.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--recursive, -r

Recursively delete objects and container

24.3. container list

List containers

Usage:

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

Table 24.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--prefix <prefix>

Filter list using <prefix>

--marker <marker>

Anchor for paging

--end-marker <end-marker>

End anchor for paging

--limit <num-containers>

Limit the number of containers returned

--long

List additional fields in output

--all

List all containers (default is 10000)

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

Table 24.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 24.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

24.4. container save

Save container contents locally

Usage:

openstack container save [-h] <container>

Table 24.14. Positional Arguments

ValueSummary

<container>

Container to save

Table 24.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

24.5. container set

Set container properties

Usage:

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

Table 24.16. Positional Arguments

ValueSummary

<container>

Container to modify

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

24.6. container show

Display container details

Usage:

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

Table 24.18. Positional Arguments

ValueSummary

<container>

Container to display

Table 24.19. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 24.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 24.22. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

24.7. container unset

Unset container properties

Usage:

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

Table 24.24. Positional Arguments

ValueSummary

<container>

Container to modify

Table 24.25. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--property <key>

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