Chapter 22. container
This chapter describes the commands under the container command.
22.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 22.1. Positional arguments
| Value | Summary |
|---|---|
| <container-name> | New container name(s) |
Table 22.2. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 22.3. Output formatter options
| Value | Summary |
|---|---|
| -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 22.4. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 22.5. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 22.6. Table formatter options
| Value | Summary |
|---|---|
| --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. |
22.2. container delete
Delete container
Usage:
openstack container delete [-h] [--recursive]
<container> [<container> ...]
Table 22.7. Positional arguments
| Value | Summary |
|---|---|
| <container> | Container(s) to delete |
Table 22.8. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --recursive, -r | Recursively delete objects and container |
22.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 22.9. Command arguments
| Value | Summary |
|---|---|
| -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 22.10. Output formatter options
| Value | Summary |
|---|---|
| -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 22.11. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 22.12. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 22.13. Table formatter options
| Value | Summary |
|---|---|
| --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. |
22.4. container save
Save container contents locally
Usage:
openstack container save [-h] <container>
Table 22.14. Positional arguments
| Value | Summary |
|---|---|
| <container> | Container to save |
Table 22.15. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
22.5. container set
Set container properties
Usage:
openstack container set [-h] --property <key=value> <container>
Table 22.16. Positional arguments
| Value | Summary |
|---|---|
| <container> | Container to modify |
Table 22.17. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --property <key=value> | Set a property on this container (repeat option to set multiple properties) |
22.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 22.18. Positional arguments
| Value | Summary |
|---|---|
| <container> | Container to display |
Table 22.19. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 22.20. Output formatter options
| Value | Summary |
|---|---|
| -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 22.21. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 22.22. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 22.23. Table formatter options
| Value | Summary |
|---|---|
| --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. |
22.7. container unset
Unset container properties
Usage:
openstack container unset [-h] --property <key> <container>
Table 22.24. Positional arguments
| Value | Summary |
|---|---|
| <container> | Container to modify |
Table 22.25. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --property <key> | Property to remove from container (repeat option to remove multiple properties) |