Chapter 23. consumer

This chapter describes the commands under the consumer command.

23.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 23.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

Table 23.2. 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 23.3. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 23.4. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

Delete consumer(s)

Usage:

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

Table 23.6. Positional Arguments

ValueSummary

<consumer>

Consumer(s) to delete

Table 23.7. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 23.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 23.9. 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 23.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 23.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

Set consumer properties

Usage:

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

Table 23.13. Positional Arguments

ValueSummary

<consumer>

Consumer to modify

Table 23.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--description <description>

New consumer description

23.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 23.15. Positional Arguments

ValueSummary

<consumer>

Consumer to display

Table 23.16. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 23.17. 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 23.18. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 23.19. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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.