SupportConsoleDevelopersStart a trialContact

Chapter 22. consumer

This chapter describes the commands under the consumer command.

22.1. consumer create

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>]

Table 22.1. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

Table 22.2. 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 22.3. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 22.4. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

22.2. consumer delete

Delete consumer(s)

Usage:

openstack consumer delete [-h] <consumer> [<consumer> ...]

Table 22.6. Positional arguments
ValueSummary

<consumer>

Consumer(s) to delete

Table 22.7. Command arguments
ValueSummary

-h, --help

Show this help message and exit

22.3. consumer list

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]
                               [--sort-ascending | --sort-descending]

Table 22.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 22.9. 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 22.10. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 22.11. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

22.4. consumer set

Set consumer properties

Usage:

openstack consumer set [-h] [--description <description>] <consumer>

Table 22.13. Positional arguments
ValueSummary

<consumer>

Consumer to modify

Table 22.14. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

22.5. consumer show

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>

Table 22.15. Positional arguments
ValueSummary

<consumer>

Consumer to display

Table 22.16. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 22.17. 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 22.18. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 22.19. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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.