Language:
Format:

Chapter 41. metric

This chapter describes the commands under the metric command.

41.1. metric aggregates

Get measurements of aggregated metrics

Usage:

openstack metric aggregates [-h] [-f {csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

Table 41.1. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.2. Positional Arguments

Value	Summary
operations	Operations to apply to time series
search	A query to filter resource. the syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, ⇐, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.

Value

Summary

operations

Operations to apply to time series

A query to filter resource. the syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, ⇐, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.

Table 41.3. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.4. Output Formatters

Value	Summary
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

Table 41.5. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.6. Optional Arguments

Value	Summary
--groupby GROUPBY	Attribute to use to group resources
--fill FILL	Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or null.
--start START	Beginning of the period
--resource-type RESOURCE_TYPE	Resource type to query
--stop STOP	End of the period
--granularity GRANULARITY	Granularity to retrieve
-h, --help	Show this help message and exit
--needed-overlap NEEDED_OVERLAP	Percentage of overlap across datapoints

41.2. metric archive-policy create

Create an archive policy

Usage:

openstack metric archive-policy create [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              -d <DEFINITION> [-b BACK_WINDOW]
                                              [-m AGGREGATION_METHODS]
                                              name

Table 41.7. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.8. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 41.9. Output Formatters

Value	Summary
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

Table 41.10. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.11. Optional Arguments

Value	Summary
-d <DEFINITION>, --definition <DEFINITION>	Two attributes (separated by ,) of an archive policy definition with its name and value separated with a :
-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS	Aggregation method of the archive policy
-h, --help	Show this help message and exit
-b BACK_WINDOW, --back-window BACK_WINDOW	Back window of the archive policy

Table 41.12. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.3. metric archive-policy delete

Delete an archive policy

Usage:

openstack metric archive-policy delete [-h] name

Table 41.13. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 41.14. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.4. metric archive-policy list

List archive policies

Usage:

openstack metric archive-policy list [-h]
                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]

Table 41.15. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.16. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.17. Output Formatters

Value	Summary
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

Table 41.18. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.19. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.5. metric archive-policy-rule create

Create an archive policy rule

Usage:

openstack metric archive-policy-rule create [-h]
                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

Table 41.20. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.21. Positional Arguments

Value	Summary
name	Rule name

Table 41.22. Output Formatters

Value	Summary
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

Table 41.23. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.24. Optional Arguments

Value	Summary
-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME	Archive policy name
-h, --help	Show this help message and exit
-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN	Wildcard of metric name to match

Table 41.25. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.6. metric archive-policy-rule delete

Delete an archive policy rule

Usage:

openstack metric archive-policy-rule delete [-h] name

Table 41.26. Positional Arguments

Value	Summary
name	Name of the archive policy rule

Table 41.27. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.7. metric archive-policy-rule list

List archive policy rules

Usage:

openstack metric archive-policy-rule list [-h]
                                                 [-f {csv,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--sort-column SORT_COLUMN]

Table 41.28. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.29. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.30. Output Formatters

Value	Summary
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

Table 41.31. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.32. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.8. metric archive-policy-rule show

Show an archive policy rule

Usage:

openstack metric archive-policy-rule show [-h]
                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 name

Table 41.33. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.34. Positional Arguments

Value	Summary
name	Name of the archive policy rule

Table 41.35. Output Formatters

Value	Summary
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

Table 41.36. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.37. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 41.38. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.9. metric archive-policy show

Show an archive policy

Usage:

openstack metric archive-policy show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            name

Table 41.39. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.40. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 41.41. Output Formatters

Value	Summary
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

Table 41.42. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.43. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 41.44. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.10. metric archive-policy update

Update an archive policy

Usage:

openstack metric archive-policy update [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              -d <DEFINITION>
                                              name

Table 41.45. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.46. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 41.47. Output Formatters

Value	Summary
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

Table 41.48. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.49. Optional Arguments

Value	Summary
-d <DEFINITION>, --definition <DEFINITION>	Two attributes (separated by ,) of an archive policy definition with its name and value separated with a :
-h, --help	Show this help message and exit

Table 41.50. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.11. metric benchmark measures add

Do benchmark testing of adding measurements

Usage:

openstack metric benchmark measures add [-h]
                                               [--resource-id RESOURCE_ID]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

Table 41.51. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.52. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 41.53. Output Formatters

Value	Summary
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

Table 41.54. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.55. Optional Arguments

Value	Summary
--wait	Wait for all measures to be processed
--count COUNT, -n COUNT	Number of total measures to send
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START	First timestamp to use
--workers WORKERS, -w WORKERS	Number of workers to use
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
--batch BATCH, -b BATCH	Number of measures to send in each batch
-h, --help	Show this help message and exit
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END	Last timestamp to use

Table 41.56. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.12. metric benchmark measures show

Do benchmark testing of measurements show

Usage:

openstack metric benchmark measures show [-h]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--sort-column SORT_COLUMN]
                                                [--utc]
                                                [--resource-id RESOURCE_ID]
                                                [--aggregation AGGREGATION]
                                                [--start START] [--stop STOP]
                                                [--granularity GRANULARITY]
                                                [--refresh]
                                                [--resample RESAMPLE]
                                                [--workers WORKERS] --count
                                                COUNT
                                                metric

Table 41.57. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.58. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 41.59. Output Formatters

Value	Summary
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
--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 41.60. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.61. Optional Arguments

Value	Summary
--start START	Beginning of the period
--count COUNT, -n COUNT	Number of total measures to send
--aggregation AGGREGATION	Aggregation to retrieve
--refresh	Force aggregation of all known measures
--workers WORKERS, -w WORKERS	Number of workers to use
--resample RESAMPLE	Granularity to resample time-series to (in seconds)
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
--stop STOP	End of the period
--granularity GRANULARITY	Granularity to retrieve
--utc	Return timestamps as utc
-h, --help	Show this help message and exit

Table 41.62. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.13. metric benchmark metric create

Do benchmark testing of metric creation

Usage:

openstack metric benchmark metric create [-h]
                                                [--resource-id RESOURCE_ID]
                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--noindent] [--prefix PREFIX]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

Table 41.63. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.64. Output Formatters

Value	Summary
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

Table 41.65. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.66. Optional Arguments

Value	Summary
--count COUNT, -n COUNT	Number of metrics to create
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME	Name of the archive policy
--keep, -k	Keep created metrics
--workers WORKERS, -w WORKERS	Number of workers to use
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
-h, --help	Show this help message and exit

Table 41.67. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.14. metric benchmark metric show

Do benchmark testing of metric show

Usage:

openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

Table 41.68. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.69. Positional Arguments

Value	Summary
metric	Id or name of the metrics

Table 41.70. Output Formatters

Value	Summary
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

Table 41.71. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.72. Optional Arguments

Value	Summary
--count COUNT, -n COUNT	Number of metrics to get
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
--workers WORKERS, -w WORKERS	Number of workers to use

Table 41.73. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.15. metric capabilities list

List capabilities

Usage:

openstack metric capabilities list [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]

Table 41.74. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.75. Output Formatters

Value	Summary
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

Table 41.76. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.77. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 41.78. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.16. metric create

Create a metric

Usage:

openstack metric create [-h] [--resource-id RESOURCE_ID]
                               [-f {json,shell,table,value,yaml}] [-c COLUMN]
                               [--max-width <integer>] [--fit-width]
                               [--print-empty] [--noindent] [--prefix PREFIX]
                               [--archive-policy-name ARCHIVE_POLICY_NAME]
                               [--unit UNIT]
                               [METRIC_NAME]

Table 41.79. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.80. Positional Arguments

Value	Summary
METRIC_NAME	Name of the metric

Table 41.81. Output Formatters

Value	Summary
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

Table 41.82. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.83. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
--unit UNIT, -u UNIT	Unit of the metric
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME	Name of the archive policy

Table 41.84. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.17. metric delete

Delete a metric

Usage:

openstack metric delete [-h] [--resource-id RESOURCE_ID]
                               metric [metric ...]

Table 41.85. Positional Arguments

Value	Summary
metric	Ids or names of the metric

Table 41.86. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource

41.18. metric list

List metrics

Usage:

openstack metric list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--limit <LIMIT>]
                             [--marker <MARKER>] [--sort <SORT>]

Table 41.87. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.88. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.89. Output Formatters

Value	Summary
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

Table 41.90. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.91. Optional Arguments

Value	Summary
--limit <LIMIT>	Number of metrics to return (default is server default)
-h, --help	Show this help message and exit
--marker <MARKER>	Last item of the previous listing. return the next results after this value
--sort <SORT>	Sort of metric attribute (example: user_id:desc- nullslast

41.19. metric measures add

Add measurements to a metric

Usage:

openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
                                     MEASURE
                                     metric

Table 41.92. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 41.93. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
-m MEASURE, --measure MEASURE	Timestamp and value of a measure separated with a @

41.20. metric measures aggregation

Get measurements of aggregated metrics

Usage:

openstack metric measures aggregation [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--sort-column SORT_COLUMN]
                                             [--utc] -m METRIC [METRIC ...]
                                             [--aggregation AGGREGATION]
                                             [--reaggregation REAGGREGATION]
                                             [--start START] [--stop STOP]
                                             [--granularity GRANULARITY]
                                             [--needed-overlap NEEDED_OVERLAP]
                                             [--query QUERY]
                                             [--resource-type RESOURCE_TYPE]
                                             [--groupby GROUPBY] [--refresh]
                                             [--resample RESAMPLE]
                                             [--fill FILL]

Table 41.94. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.95. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.96. Output Formatters

Value	Summary
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

Table 41.97. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.98. Optional Arguments

Value	Summary
--groupby GROUPBY	Attribute to use to group resources
--start START	Beginning of the period
--query QUERY	A query to filter resource. the syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!="1" and memory>=24). Use "" to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, ⇐, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
--fill FILL	Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or null.
--aggregation AGGREGATION	Granularity aggregation function to retrieve
-m METRIC [METRIC …], --metric METRIC [METRIC …]	Metrics ids or metric name
--resource-type RESOURCE_TYPE	Resource type to query
--refresh	Force aggregation of all known measures
--reaggregation REAGGREGATION	Groupby aggregation function to retrieve
--stop STOP	End of the period
--granularity GRANULARITY	Granularity to retrieve
--utc	Return timestamps as utc
-h, --help	Show this help message and exit
--resample RESAMPLE	Granularity to resample time-series to (in seconds)
--needed-overlap NEEDED_OVERLAP	Percent of datapoints in each metrics required

41.21. metric measures batch-metrics

Usage:

openstack metric measures batch-metrics [-h] file

Table 41.99. Positional Arguments

Value	Summary
file	File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format

Table 41.100. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.22. metric measures batch-resources-metrics

Usage:

openstack metric measures batch-resources-metrics [-h]
                                                         [--create-metrics]
                                                         file

Table 41.101. Positional Arguments

Value	Summary
file	File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format

Table 41.102. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--create-metrics	Create unknown metrics

41.23. metric measures show

Get measurements of a metric

Usage:

openstack metric measures show [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

Table 41.103. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.104. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 41.105. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.106. Output Formatters

Value	Summary
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

Table 41.107. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.108. Optional Arguments

Value	Summary
--start START	Beginning of the period
--aggregation AGGREGATION	Aggregation to retrieve
--refresh	Force aggregation of all known measures
--resample RESAMPLE	Granularity to resample time-series to (in seconds)
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
--stop STOP	End of the period
--granularity GRANULARITY	Granularity to retrieve
--utc	Return timestamps as utc
-h, --help	Show this help message and exit

41.24. metric metric create

Deprecated: Create a metric

Usage:

openstack metric metric create [-h] [--resource-id RESOURCE_ID]
                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

Table 41.109. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.110. Positional Arguments

Value	Summary
METRIC_NAME	Name of the metric

Table 41.111. Output Formatters

Value	Summary
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

Table 41.112. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.113. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource
--unit UNIT, -u UNIT	Unit of the metric
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME	Name of the archive policy

Table 41.114. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.25. metric metric delete

Deprecated: Delete a metric

Usage:

openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
                                      metric [metric ...]

Table 41.115. Positional Arguments

Value	Summary
metric	Ids or names of the metric

Table 41.116. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource

41.26. metric metric list

Deprecated: List metrics

Usage:

openstack metric metric list [-h] [-f {csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT>]

Table 41.117. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.118. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.119. Output Formatters

Value	Summary
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

Table 41.120. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.121. Optional Arguments

Value	Summary
--limit <LIMIT>	Number of metrics to return (default is server default)
-h, --help	Show this help message and exit
--marker <MARKER>	Last item of the previous listing. return the next results after this value
--sort <SORT>	Sort of metric attribute (example: user_id:desc- nullslast

41.27. metric metric show

Deprecated: Show a metric

Usage:

openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--resource-id RESOURCE_ID]
                                    metric

Table 41.122. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.123. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 41.124. Output Formatters

Value	Summary
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

Table 41.125. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.126. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource

Table 41.127. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.28. metric resource batch delete

Delete a batch of resources based on attribute values

Usage:

openstack metric resource batch delete [-h]
                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [--type RESOURCE_TYPE]
                                              query

Table 41.128. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.129. Positional Arguments

Value

Summary

query

Table 41.130. Output Formatters

Value	Summary
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

Table 41.131. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.132. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource

Table 41.133. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.29. metric resource create

Create a resource

Usage:

openstack metric resource create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--type RESOURCE_TYPE] [-a ATTRIBUTE]
                                        [-m ADD_METRIC] [-n CREATE_METRIC]
                                        resource_id

Table 41.134. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.135. Positional Arguments

Value	Summary
resource_id	Id of the resource

Table 41.136. Output Formatters

Value	Summary
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

Table 41.137. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.138. Optional Arguments

Value	Summary
-n CREATE_METRIC, --create-metric CREATE_METRIC	Name:archive_policy_name of a metric to create
-h, --help	Show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE	Name and value of an attribute separated with a :
-m ADD_METRIC, --add-metric ADD_METRIC	Name:id of a metric to add
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource

Table 41.139. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.30. metric resource delete

Delete a resource

Usage:

openstack metric resource delete [-h] resource_id

Table 41.140. Positional Arguments

Value	Summary
resource_id	Id of the resource

Table 41.141. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.31. metric resource history

Show the history of a resource

Usage:

openstack metric resource history [-h] [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

Table 41.142. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.143. Positional Arguments

Value	Summary
resource_id	Id of a resource

Table 41.144. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.145. Output Formatters

Value	Summary
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

Table 41.146. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.147. Optional Arguments

Value	Summary
--details	Show all attributes of generic resources
--limit <LIMIT>	Number of resources to return (default is server default)
--sort <SORT>	Sort of resource attribute (example: user_id:desc- nullslast
--marker <MARKER>	Last item of the previous listing. return the next results after this value
-h, --help	Show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource

41.32. metric resource list

List resources

Usage:

openstack metric resource list [-h] [-f {csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

Table 41.148. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.149. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.150. Output Formatters

Value	Summary
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

Table 41.151. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.152. Optional Arguments

Value	Summary
--details	Show all attributes of generic resources
--limit <LIMIT>	Number of resources to return (default is server default)
--history	Show history of the resources
--sort <SORT>	Sort of resource attribute (example: user_id:desc- nullslast
-h, --help	Show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource
--marker <MARKER>	Last item of the previous listing. return the next results after this value

41.33. metric resource search

Search resources with specified query rules

Usage:

openstack metric resource search [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--sort-column SORT_COLUMN]
                                        [--details] [--history]
                                        [--limit <LIMIT>] [--marker <MARKER>]
                                        [--sort <SORT>] [--type RESOURCE_TYPE]
                                        query

Table 41.153. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.154. Positional Arguments

Value

Summary

query

Table 41.155. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.156. Output Formatters

Value	Summary
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

Table 41.157. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.158. Optional Arguments

Value	Summary
--details	Show all attributes of generic resources
--limit <LIMIT>	Number of resources to return (default is server default)
--history	Show history of the resources
--sort <SORT>	Sort of resource attribute (example: user_id:desc- nullslast
-h, --help	Show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource
--marker <MARKER>	Last item of the previous listing. return the next results after this value

41.34. metric resource show

Show a resource

Usage:

openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--type RESOURCE_TYPE]
                                      resource_id

Table 41.159. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.160. Positional Arguments

Value	Summary
resource_id	Id of a resource

Table 41.161. Output Formatters

Value	Summary
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

Table 41.162. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.163. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource

Table 41.164. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.35. metric resource-type create

Create a resource type

Usage:

openstack metric resource-type create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [-a ATTRIBUTE]
                                             name

Table 41.165. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.166. Positional Arguments

Value	Summary
name	Name of the resource type

Table 41.167. Output Formatters

Value	Summary
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

Table 41.168. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.169. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE	Attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… For example: display_name:string:true:max_length=255

Table 41.170. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.36. metric resource-type delete

Delete a resource type

Usage:

openstack metric resource-type delete [-h] name

Table 41.171. Positional Arguments

Value	Summary
name	Name of the resource type

Table 41.172. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.37. metric resource-type list

List resource types

Usage:

openstack metric resource-type list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]

Table 41.173. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.174. CSV Formatter

Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 41.175. Output Formatters

Value	Summary
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

Table 41.176. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.177. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

41.38. metric resource-type show

Show a resource type

Usage:

openstack metric resource-type show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           name

Table 41.178. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.179. Positional Arguments

Value	Summary
name	Name of the resource type

Table 41.180. Output Formatters

Value	Summary
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

Table 41.181. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.182. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 41.183. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.39. metric resource-type update

Usage:

openstack metric resource-type update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [-a ATTRIBUTE]
                                             [-r REMOVE_ATTRIBUTE]
                                             name

Table 41.184. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.185. Positional Arguments

Value	Summary
name	Name of the resource type

Table 41.186. Output Formatters

Value	Summary
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

Table 41.187. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.188. Optional Arguments

Value	Summary
-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE	Attribute name
-h, --help	Show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE	Attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… For example: display_name:string:true:max_length=255

Table 41.189. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.40. metric resource update

Update a resource

Usage:

openstack metric resource update [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--type RESOURCE_TYPE] [-a ATTRIBUTE]
                                        [-m ADD_METRIC] [-n CREATE_METRIC]
                                        [-d DELETE_METRIC]
                                        resource_id

Table 41.190. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.191. Positional Arguments

Value	Summary
resource_id	Id of the resource

Table 41.192. Output Formatters

Value	Summary
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

Table 41.193. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.194. Optional Arguments

Value	Summary
-n CREATE_METRIC, --create-metric CREATE_METRIC	Name:archive_policy_name of a metric to create
-m ADD_METRIC, --add-metric ADD_METRIC	Name:id of a metric to add
-d DELETE_METRIC, --delete-metric DELETE_METRIC	Name of a metric to delete
-h, --help	Show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE	Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE	Name and value of an attribute separated with a :

Table 41.195. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.41. metric server version

Show the version of Gnocchi server

Usage:

openstack metric server version [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]

Table 41.196. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.197. Output Formatters

Value	Summary
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

Table 41.198. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.199. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 41.200. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.42. metric show

Show a metric

Usage:

openstack metric show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             [--resource-id RESOURCE_ID]
                             metric

Table 41.201. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.202. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 41.203. Output Formatters

Value	Summary
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

Table 41.204. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.205. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID	Id of the resource

Table 41.206. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

41.43. metric status

Show the status of measurements processing

Usage:

openstack metric status [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]

Table 41.207. Table Formatter

Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 41.208. Output Formatters

Value	Summary
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

Table 41.209. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 41.210. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit

Table 41.211. Shell Formatter

Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

Language and Page Formatting Options

Chapter 41. metric

41.1. metric aggregates

41.2. metric archive-policy create

41.3. metric archive-policy delete

41.4. metric archive-policy list

41.5. metric archive-policy-rule create

41.6. metric archive-policy-rule delete

41.7. metric archive-policy-rule list

41.8. metric archive-policy-rule show

41.9. metric archive-policy show

41.10. metric archive-policy update

41.11. metric benchmark measures add

41.12. metric benchmark measures show

41.13. metric benchmark metric create

41.14. metric benchmark metric show

41.15. metric capabilities list

41.16. metric create

41.17. metric delete

41.18. metric list

41.19. metric measures add

41.20. metric measures aggregation

41.21. metric measures batch-metrics

41.22. metric measures batch-resources-metrics

41.23. metric measures show

41.24. metric metric create

41.25. metric metric delete

41.26. metric metric list

41.27. metric metric show

41.28. metric resource batch delete

41.29. metric resource create

41.30. metric resource delete

41.31. metric resource history

41.32. metric resource list

41.33. metric resource search

41.34. metric resource show

41.35. metric resource-type create

41.36. metric resource-type delete

41.37. metric resource-type list

41.38. metric resource-type show

41.39. metric resource-type update

41.40. metric resource update

41.41. metric server version

41.42. metric show

41.43. metric status

Quick Links

Help

Site Info

Related Sites

Systems Status

About

Red Hat legal and privacy links

Red Hat legal and privacy links