Chapter 85. usage

This chapter describes the commands under the usage command.

85.1. usage list

List resource usage per project

Usage:

openstack usage 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]
                            [--start <start>] [--end <end>]

Table 85.1. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--start <start>

Usage range start date, ex 2012-01-20 (default: 4 weeks ago)

--end <end>

Usage range end date, ex 2012-01-20 (default: tomorrow)

Table 85.2. 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 85.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 85.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

85.2. usage show

Show resource usage for a single project

Usage:

openstack usage show [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--noindent] [--prefix PREFIX]
                            [--max-width <integer>] [--fit-width]
                            [--print-empty] [--project <project>]
                            [--start <start>] [--end <end>]

Table 85.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Name or id of project to show usage for

--start <start>

Usage range start date, ex 2012-01-20 (default: 4 weeks ago)

--end <end>

Usage range end date, ex 2012-01-20 (default: tomorrow)

Table 85.7. 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 85.8. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 85.9. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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