Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 23. consumer

This chapter describes the commands under the consumer command.

23.1. consumer create
Copy link

Create new consumer

Usage:

openstack consumer create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--description <description>]
Copy to Clipboard Toggle word wrap

Expand
Table 23.1. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

Expand
Table 23.2. 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

Expand
Table 23.3. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 23.4. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

Expand
Table 23.5. 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.

23.2. consumer delete
Copy link

Delete consumer(s)

Usage:

openstack consumer delete [-h] <consumer> [<consumer> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 23.6. Positional Arguments
ValueSummary

<consumer>

Consumer(s) to delete

Expand
Table 23.7. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

23.3. consumer list
Copy link

List consumers

Usage:

openstack consumer 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]
Copy to Clipboard Toggle word wrap

Expand
Table 23.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 23.9. 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

Expand
Table 23.10. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 23.11. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 23.12. 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.

23.4. consumer set
Copy link

Set consumer properties

Usage:

openstack consumer set [-h] [--description <description>] <consumer>
Copy to Clipboard Toggle word wrap

Expand
Table 23.13. Positional Arguments
ValueSummary

<consumer>

Consumer to modify

Expand
Table 23.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

23.5. consumer show
Copy link

Display consumer details

Usage:

openstack consumer show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--noindent] [--prefix PREFIX]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty]
                               <consumer>
Copy to Clipboard Toggle word wrap

Expand
Table 23.15. Positional Arguments
ValueSummary

<consumer>

Consumer to display

Expand
Table 23.16. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 23.17. 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

Expand
Table 23.18. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 23.19. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

Expand
Table 23.20. 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.

Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat