Language:
Format:

Chapter 52. metric

This chapter describes the commands under the metric command.

52.1. metric aggregates

Get measurements of aggregated metrics.

Usage:

openstack metric aggregates [-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]
                                   [--resource-type RESOURCE_TYPE]
                                   [--start START] [--stop STOP]
                                   [--granularity GRANULARITY]
                                   [--needed-overlap NEEDED_OVERLAP]
                                   [--groupby GROUPBY] [--fill FILL]
                                   operations [search]

Table 52.1. 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 52.2. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--resource-type RESOURCE_TYPE	Resource type to query
--start START	Beginning of the period
--stop STOP	End of the period
--granularity GRANULARITY	Granularity to retrieve
--needed-overlap NEEDED_OVERLAP	Percentage of overlap across datapoints
--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.

Table 52.3. 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 52.4. CSV Formatter

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

Table 52.5. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.6. Table Formatter

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.

52.2. metric archive-policy create

Create an archive policy.

Usage:

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

Table 52.7. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 52.8. Optional Arguments

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

Table 52.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 52.10. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.11. Shell Formatter

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

Table 52.12. Table Formatter

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.

52.3. metric archive-policy delete

Delete an archive policy.

Usage:

openstack metric archive-policy delete [-h] name

Table 52.13. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 52.14. Optional Arguments

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

52.4. metric archive-policy list

List archive policies.

Usage:

openstack metric archive-policy 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 52.15. Optional Arguments

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

Table 52.16. 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 52.17. CSV Formatter

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

Table 52.18. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.19. Table Formatter

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.

52.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] [--noindent]
                                                   [--prefix PREFIX]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty] -a
                                                   ARCHIVE_POLICY_NAME -m
                                                   METRIC_PATTERN
                                                   name

Table 52.20. Positional Arguments

Value	Summary
name	Rule name

Table 52.21. Optional Arguments

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

Table 52.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 52.23. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.24. Shell Formatter

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

Table 52.25. Table Formatter

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.

52.6. metric archive-policy-rule delete

Delete an archive policy rule.

Usage:

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

Table 52.26. Positional Arguments

Value	Summary
name	Name of the archive policy rule

Table 52.27. Optional Arguments

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

52.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]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--noindent]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--sort-column SORT_COLUMN]

Table 52.28. Optional Arguments

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

Table 52.29. 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 52.30. CSV Formatter

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

Table 52.31. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.32. Table Formatter

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.

52.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] [--noindent]
                                                 [--prefix PREFIX]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 name

Table 52.33. Positional Arguments

Value	Summary
name	Name of the archive policy rule

Table 52.34. Optional Arguments

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

Table 52.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 52.36. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.37. Shell Formatter

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

Table 52.38. Table Formatter

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.

52.9. metric archive-policy show

Show an archive policy.

Usage:

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

Table 52.39. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 52.40. Optional Arguments

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

Table 52.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 52.42. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.43. Shell Formatter

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

Table 52.44. Table Formatter

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.

52.10. metric archive-policy update

Update an archive policy.

Usage:

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

Table 52.45. Positional Arguments

Value	Summary
name	Name of the archive policy

Table 52.46. Optional Arguments

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

Table 52.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 52.48. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.49. Shell Formatter

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

Table 52.50. Table Formatter

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.

52.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] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--workers WORKERS] --count
                                               COUNT [--batch BATCH]
                                               [--timestamp-start TIMESTAMP_START]
                                               [--timestamp-end TIMESTAMP_END]
                                               [--wait]
                                               metric

Table 52.51. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 52.52. Optional Arguments

Value	Summary
-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
--count COUNT, -n COUNT	Number of total measures to send
--batch BATCH, -b BATCH	Number of measures to send in each batch
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START	First timestamp to use
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END	Last timestamp to use
--wait	Wait for all measures to be processed

Table 52.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 52.54. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.55. Shell Formatter

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

Table 52.56. Table Formatter

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.

52.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] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--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 52.57. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 52.58. Optional Arguments

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

Table 52.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 52.60. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.61. Shell Formatter

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

Table 52.62. Table Formatter

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.

52.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] [--noindent]
                                                [--prefix PREFIX]
                                                [--max-width <integer>]
                                                [--fit-width] [--print-empty]
                                                [--archive-policy-name ARCHIVE_POLICY_NAME]
                                                [--workers WORKERS] --count
                                                COUNT [--keep]

Table 52.63. Optional Arguments

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

Table 52.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 52.65. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.66. Shell Formatter

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

Table 52.67. Table Formatter

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.

52.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] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--workers WORKERS] --count
                                              COUNT
                                              metric [metric ...]

Table 52.68. Positional Arguments

Value	Summary
metric	Id or name of the metrics

Table 52.69. Optional Arguments

Value	Summary
-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
--count COUNT, -n COUNT	Number of metrics to get

Table 52.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 52.71. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.72. Shell Formatter

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

Table 52.73. Table Formatter

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.

52.15. metric capabilities list

List capabilities.

Usage:

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

Table 52.74. Optional Arguments

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

Table 52.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 52.76. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.77. Shell Formatter

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

Table 52.78. Table Formatter

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.

52.16. metric create

Create a metric.

Usage:

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

Table 52.79. Positional Arguments

Value	Summary
METRIC_NAME	Name of the metric

Table 52.80. Optional Arguments

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

Table 52.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 52.82. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.83. Shell Formatter

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

Table 52.84. Table Formatter

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.

52.17. metric delete

Delete a metric.

Usage:

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

Table 52.85. Positional Arguments

Value	Summary
metric	Ids or names of the metric

Table 52.86. Optional Arguments

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

52.18. metric list

List metrics.

Usage:

openstack metric 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] [--limit <LIMIT>]
                             [--marker <MARKER>] [--sort <SORT>]

Table 52.87. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--limit <LIMIT>	Number of metrics to return (default is server default)
--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

Table 52.88. 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 52.89. CSV Formatter

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

Table 52.90. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.91. Table Formatter

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.

52.19. metric measures add

Add measurements to a metric.

Usage:

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

Table 52.92. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 52.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 @

52.20. metric measures aggregation

Get measurements of aggregated metrics.

Usage:

openstack metric measures aggregation [-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]
                                             [--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 52.94. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--utc	Return timestamps as utc
-m METRIC [METRIC …], --metric METRIC [METRIC …]	Metrics ids or metric name
--aggregation AGGREGATION	Granularity aggregation function to retrieve
--reaggregation REAGGREGATION	Groupby aggregation function to retrieve
--start START	Beginning of the period
--stop STOP	End of the period
--granularity GRANULARITY	Granularity to retrieve
--needed-overlap NEEDED_OVERLAP	Percent of datapoints in each metrics required
--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.
--resource-type RESOURCE_TYPE	Resource type to query
--groupby GROUPBY	Attribute to use to group resources
--refresh	Force aggregation of all known measures
--resample RESAMPLE	Granularity to resample time-series to (in seconds)
--fill FILL	Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or null.

Table 52.95. 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 52.96. CSV Formatter

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

Table 52.97. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.98. Table Formatter

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.

52.21. metric measures batch-metrics

Usage:

openstack metric measures batch-metrics [-h] file

Table 52.99. Positional Arguments

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

Table 52.100. Optional Arguments

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

52.22. metric measures batch-resources-metrics

Usage:

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

Table 52.101. Positional Arguments

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

Table 52.102. Optional Arguments

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

52.23. metric measures show

Get measurements of a metric.

Usage:

openstack metric measures show [-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] [--utc]
                                      [--resource-id RESOURCE_ID]
                                      [--aggregation AGGREGATION]
                                      [--start START] [--stop STOP]
                                      [--granularity GRANULARITY] [--refresh]
                                      [--resample RESAMPLE]
                                      metric

Table 52.103. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 52.104. Optional Arguments

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

Table 52.105. 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 52.106. CSV Formatter

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

Table 52.107. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.108. Table Formatter

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.

52.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] [--noindent]
                                      [--prefix PREFIX]
                                      [--max-width <integer>] [--fit-width]
                                      [--print-empty]
                                      [--archive-policy-name ARCHIVE_POLICY_NAME]
                                      [--unit UNIT]
                                      [METRIC_NAME]

Table 52.109. Positional Arguments

Value	Summary
METRIC_NAME	Name of the metric

Table 52.110. Optional Arguments

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

Table 52.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 52.112. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.113. Shell Formatter

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

Table 52.114. Table Formatter

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.

52.25. metric metric delete

Deprecated: Delete a metric.

Usage:

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

Table 52.115. Positional Arguments

Value	Summary
metric	Ids or names of the metric

Table 52.116. Optional Arguments

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

52.26. metric metric list

Deprecated: List metrics.

Usage:

openstack metric metric 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]
                                    [--limit <LIMIT>] [--marker <MARKER>]
                                    [--sort <SORT>]

Table 52.117. Optional Arguments

Value	Summary
-h, --help	Show this help message and exit
--limit <LIMIT>	Number of metrics to return (default is server default)
--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

Table 52.118. 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 52.119. CSV Formatter

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

Table 52.120. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.121. Table Formatter

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.

52.27. metric metric show

Deprecated: Show a metric.

Usage:

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

Table 52.122. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 52.123. Optional Arguments

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

Table 52.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 52.125. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.126. Shell Formatter

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

Table 52.127. Table Formatter

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.

52.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] [--noindent]
                                              [--prefix PREFIX]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--type RESOURCE_TYPE]
                                              query

Table 52.128. Positional Arguments

Value

Summary

query

Table 52.129. Optional Arguments

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

Table 52.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 52.131. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.132. Shell Formatter

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

Table 52.133. Table Formatter

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.

52.29. metric resource create

Create a resource.

Usage:

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

Table 52.134. Positional Arguments

Value	Summary
resource_id	Id of the resource

Table 52.135. Optional Arguments

Value	Summary
-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 :
-m ADD_METRIC, --add-metric ADD_METRIC	Name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC	Name:archive_policy_name of a metric to create

Table 52.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 52.137. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.138. Shell Formatter

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

Table 52.139. Table Formatter

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.

52.30. metric resource delete

Delete a resource.

Usage:

openstack metric resource delete [-h] resource_id

Table 52.140. Positional Arguments

Value	Summary
resource_id	Id of the resource

Table 52.141. Optional Arguments

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

52.31. metric resource history

Show the history of a resource.

Usage:

openstack metric resource history [-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]
                                         [--details] [--limit <LIMIT>]
                                         [--marker <MARKER>] [--sort <SORT>]
                                         [--type RESOURCE_TYPE]
                                         resource_id

Table 52.142. Positional Arguments

Value	Summary
resource_id	Id of a resource

Table 52.143. Optional Arguments

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

Table 52.144. 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 52.145. CSV Formatter

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

Table 52.146. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.147. Table Formatter

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.

52.32. metric resource list

List resources.

Usage:

openstack metric resource 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] [--details]
                                      [--history] [--limit <LIMIT>]
                                      [--marker <MARKER>] [--sort <SORT>]
                                      [--type RESOURCE_TYPE]

Table 52.148. Optional Arguments

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

Table 52.149. 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 52.150. CSV Formatter

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

Table 52.151. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.152. Table Formatter

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.

52.33. metric resource search

Search resources with specified query rules.

Usage:

openstack metric resource search [-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]
                                        [--details] [--history]
                                        [--limit <LIMIT>] [--marker <MARKER>]
                                        [--sort <SORT>] [--type RESOURCE_TYPE]
                                        query

Table 52.153. Positional Arguments

Value

Summary

query

Table 52.154. Optional Arguments

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

Table 52.155. 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 52.156. CSV Formatter

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

Table 52.157. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.158. Table Formatter

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.

52.34. metric resource show

Show a resource.

Usage:

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

Table 52.159. Positional Arguments

Value	Summary
resource_id	Id of a resource

Table 52.160. Optional Arguments

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

Table 52.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 52.162. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.163. Shell Formatter

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

Table 52.164. Table Formatter

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.

52.35. metric resource-type create

Create a resource type.

Usage:

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

Table 52.165. Positional Arguments

Value	Summary
name	Name of the resource type

Table 52.166. 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 52.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 52.168. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.169. Shell Formatter

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

Table 52.170. Table Formatter

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.

52.36. metric resource-type delete

Delete a resource type.

Usage:

openstack metric resource-type delete [-h] name

Table 52.171. Positional Arguments

Value	Summary
name	Name of the resource type

Table 52.172. Optional Arguments

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

52.37. metric resource-type list

List resource types.

Usage:

openstack metric resource-type 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 52.173. Optional Arguments

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

Table 52.174. 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 52.175. CSV Formatter

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

Table 52.176. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.177. Table Formatter

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.

52.38. metric resource-type show

Show a resource type.

Usage:

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

Table 52.178. Positional Arguments

Value	Summary
name	Name of the resource type

Table 52.179. Optional Arguments

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

Table 52.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 52.181. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.182. Shell Formatter

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

Table 52.183. Table Formatter

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.

52.39. metric resource-type update

Create a resource type.

Usage:

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

Table 52.184. Positional Arguments

Value	Summary
name	Name of the resource type

Table 52.185. 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
-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE	Attribute name

Table 52.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 52.187. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.188. Shell Formatter

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

Table 52.189. Table Formatter

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.

52.40. metric resource update

Update a resource.

Usage:

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

Table 52.190. Positional Arguments

Value	Summary
resource_id	Id of the resource

Table 52.191. Optional Arguments

Value	Summary
-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 :
-m ADD_METRIC, --add-metric ADD_METRIC	Name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC	Name:archive_policy_name of a metric to create
-d DELETE_METRIC, --delete-metric DELETE_METRIC	Name of a metric to delete

Table 52.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 52.193. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.194. Shell Formatter

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

Table 52.195. Table Formatter

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.

52.41. metric server version

Show the version of Gnocchi server.

Usage:

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

Table 52.196. Optional Arguments

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

Table 52.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 52.198. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.199. Shell Formatter

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

Table 52.200. Table Formatter

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.

52.42. metric show

Show a metric.

Usage:

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

Table 52.201. Positional Arguments

Value	Summary
metric	Id or name of the metric

Table 52.202. Optional Arguments

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

Table 52.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 52.204. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.205. Shell Formatter

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

Table 52.206. Table Formatter

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.

52.43. metric status

Show the status of measurements processing.

Usage:

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

Table 52.207. Optional Arguments

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

Table 52.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 52.209. JSON Formatter

Value	Summary
--noindent	Whether to disable indenting the json

Table 52.210. Shell Formatter

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

Table 52.211. Table Formatter

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.

Language and Page Formatting Options

Chapter 52. metric

52.1. metric aggregates

52.2. metric archive-policy create

52.3. metric archive-policy delete

52.4. metric archive-policy list

52.5. metric archive-policy-rule create

52.6. metric archive-policy-rule delete

52.7. metric archive-policy-rule list

52.8. metric archive-policy-rule show

52.9. metric archive-policy show

52.10. metric archive-policy update

52.11. metric benchmark measures add

52.12. metric benchmark measures show

52.13. metric benchmark metric create

52.14. metric benchmark metric show

52.15. metric capabilities list

52.16. metric create

52.17. metric delete

52.18. metric list

52.19. metric measures add

52.20. metric measures aggregation

52.21. metric measures batch-metrics

52.22. metric measures batch-resources-metrics

52.23. metric measures show

52.24. metric metric create

52.25. metric metric delete

52.26. metric metric list

52.27. metric metric show

52.28. metric resource batch delete

52.29. metric resource create

52.30. metric resource delete

52.31. metric resource history

52.32. metric resource list

52.33. metric resource search

52.34. metric resource show

52.35. metric resource-type create

52.36. metric resource-type delete

52.37. metric resource-type list

52.38. metric resource-type show

52.39. metric resource-type update

52.40. metric resource update

52.41. metric server version

52.42. metric show

52.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