SupportConsoleDevelopersStart a trialContact

Chapter 23. container

This chapter describes the commands under the container command.

23.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]
                                  [--sort-ascending | --sort-descending]
                                  [--public] [--storage-policy STORAGE_POLICY]
                                  <container-name> [<container-name> ...]

Table 23.1. Positional arguments
ValueSummary

<container-name>

New container name(s)

Table 23.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--public

Make the container publicly accessible

--storage-policy STORAGE_POLICY

Specify a particular storage policy to use.

Table 23.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 23.4. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 23.5. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

23.2. container delete

Delete container

Usage:

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

Table 23.7. Positional arguments
ValueSummary

<container>

Container(s) to delete

Table 23.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--recursive, -r

Recursively delete objects and container

23.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]
                                [--sort-ascending | --sort-descending]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>]
                                [--limit <num-containers>] [--long] [--all]

Table 23.9. Command 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 23.10. 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 23.11. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 23.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

23.4. container save

Save container contents locally

Usage:

openstack container save [-h] <container>

Table 23.14. Positional arguments
ValueSummary

<container>

Container to save

Table 23.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

23.5. container set

Set container properties

Usage:

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

Table 23.16. Positional arguments
ValueSummary

<container>

Container to modify

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

23.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 23.18. Positional arguments
ValueSummary

<container>

Container to display

Table 23.19. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 23.20. 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 23.21. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 23.22. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

23.7. container unset

Unset container properties

Usage:

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

Table 23.24. Positional arguments
ValueSummary

<container>

Container to modify

Table 23.25. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from container (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.