Chapter 21. consumer
This chapter describes the commands under the consumer command.
21.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 21.1. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description <description> | New consumer description |
Table 21.2. 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 21.3. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 21.4. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 21.5. 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. |
21.2. consumer delete
Delete consumer(s)
Usage:
openstack consumer delete [-h] <consumer> [<consumer> ...]
Table 21.6. Positional arguments
| Value | Summary |
|---|---|
| <consumer> | Consumer(s) to delete |
Table 21.7. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
21.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 21.8. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 21.9. 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 21.10. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 21.11. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 21.12. 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. |
21.4. consumer set
Set consumer properties
Usage:
openstack consumer set [-h] [--description <description>] <consumer>
Table 21.13. Positional arguments
| Value | Summary |
|---|---|
| <consumer> | Consumer to modify |
Table 21.14. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --description <description> | New consumer description |
21.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 21.15. Positional arguments
| Value | Summary |
|---|---|
| <consumer> | Consumer to display |
Table 21.16. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 21.17. 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 21.18. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 21.19. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 21.20. 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. |
