Chapter 50. metric
This chapter describes the commands under the metric
command.
50.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 50.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. |
Table 50.2. Command 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 50.3. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.4. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.5. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.6. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.7. Positional arguments
Value | Summary |
---|---|
name | Name of the archive policy |
Table 50.8. Command 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 50.9. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.10. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.11. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.12. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.3. metric archive-policy delete
Delete an archive policy.
Usage:
openstack metric archive-policy delete [-h] name
Table 50.13. Positional arguments
Value | Summary |
---|---|
name | Name of the archive policy |
Table 50.14. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
50.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 50.15. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.16. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.17. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.18. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.19. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.20. Positional arguments
Value | Summary |
---|---|
name | Rule name |
Table 50.21. Command 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 50.22. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.23. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.24. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.25. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.6. metric archive-policy-rule delete
Delete an archive policy rule.
Usage:
openstack metric archive-policy-rule delete [-h] name
Table 50.26. Positional arguments
Value | Summary |
---|---|
name | Name of the archive policy rule |
Table 50.27. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
50.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 50.28. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.29. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.30. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.31. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.32. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.33. Positional arguments
Value | Summary |
---|---|
name | Name of the archive policy rule |
Table 50.34. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.35. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.36. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.37. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.38. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.39. Positional arguments
Value | Summary |
---|---|
name | Name of the archive policy |
Table 50.40. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.41. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.42. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.43. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.44. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.45. Positional arguments
Value | Summary |
---|---|
name | Name of the archive policy |
Table 50.46. Command 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 50.47. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.48. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.49. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.50. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.51. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metric |
Table 50.52. Command 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 50.53. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.54. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.55. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.56. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.57. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metric |
Table 50.58. Command 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 50.59. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--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 50.60. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.61. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.62. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.63. Command 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 50.64. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.65. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.66. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.67. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.68. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metrics |
Table 50.69. Command 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 50.70. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.71. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.72. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.73. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.74. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.75. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.76. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.77. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.78. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.79. Positional arguments
Value | Summary |
---|---|
METRIC_NAME | Name of the metric |
Table 50.80. Command 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 50.81. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.82. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.83. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.84. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.17. metric delete
Delete a metric.
Usage:
openstack metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
Table 50.85. Positional arguments
Value | Summary |
---|---|
metric | Ids or names of the metric |
Table 50.86. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--resource-id RESOURCE_ID, -r RESOURCE_ID | Id of the resource |
50.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 50.87. Command 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 50.88. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.89. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.90. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.91. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.19. metric measures add
Add measurements to a metric.
Usage:
openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric
Table 50.92. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metric |
Table 50.93. Command 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 @ |
50.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 50.94. Command 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 50.95. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.96. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.97. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.98. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.21. metric measures batch-metrics
Usage:
openstack metric measures batch-metrics [-h] file
Table 50.99. Positional arguments
Value | Summary |
---|---|
file | File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format |
Table 50.100. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
50.22. metric measures batch-resources-metrics
Usage:
openstack metric measures batch-resources-metrics [-h] [--create-metrics] file
Table 50.101. Positional arguments
Value | Summary |
---|---|
file | File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format |
Table 50.102. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--create-metrics | Create unknown metrics |
50.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 50.103. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metric |
Table 50.104. Command 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 50.105. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.106. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.107. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.108. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.109. Positional arguments
Value | Summary |
---|---|
METRIC_NAME | Name of the metric |
Table 50.110. Command 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 50.111. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.112. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.113. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.114. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.25. metric metric delete
Deprecated: Delete a metric.
Usage:
openstack metric metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
Table 50.115. Positional arguments
Value | Summary |
---|---|
metric | Ids or names of the metric |
Table 50.116. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--resource-id RESOURCE_ID, -r RESOURCE_ID | Id of the resource |
50.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 50.117. Command 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 50.118. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.119. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.120. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.121. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.122. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metric |
Table 50.123. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--resource-id RESOURCE_ID, -r RESOURCE_ID | Id of the resource |
Table 50.124. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.125. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.126. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.127. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.128. Positional arguments
Value | Summary |
---|---|
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. |
Table 50.129. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | Type of resource |
Table 50.130. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.131. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.132. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.133. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.134. Positional arguments
Value | Summary |
---|---|
resource_id | Id of the resource |
Table 50.135. Command 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 50.136. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.137. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.138. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.139. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.30. metric resource delete
Delete a resource.
Usage:
openstack metric resource delete [-h] resource_id
Table 50.140. Positional arguments
Value | Summary |
---|---|
resource_id | Id of the resource |
Table 50.141. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
50.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 50.142. Positional arguments
Value | Summary |
---|---|
resource_id | Id of a resource |
Table 50.143. Command 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 50.144. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.145. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.146. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.147. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.148. Command 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 50.149. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.150. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.151. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.152. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.153. Positional arguments
Value | Summary |
---|---|
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. |
Table 50.154. Command 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 50.155. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.156. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.157. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.158. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.159. Positional arguments
Value | Summary |
---|---|
resource_id | Id of a resource |
Table 50.160. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--type RESOURCE_TYPE, -t RESOURCE_TYPE | Type of resource |
Table 50.161. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.162. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.163. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.164. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.165. Positional arguments
Value | Summary |
---|---|
name | Name of the resource type |
Table 50.166. Command 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 50.167. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.168. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.169. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.170. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.36. metric resource-type delete
Delete a resource type.
Usage:
openstack metric resource-type delete [-h] name
Table 50.171. Positional arguments
Value | Summary |
---|---|
name | Name of the resource type |
Table 50.172. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
50.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 50.173. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.174. Output formatter options
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 50.175. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 50.176. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.177. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.178. Positional arguments
Value | Summary |
---|---|
name | Name of the resource type |
Table 50.179. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.180. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.181. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.182. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.183. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.184. Positional arguments
Value | Summary |
---|---|
name | Name of the resource type |
Table 50.185. Command 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 50.186. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.187. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.188. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.189. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.190. Positional arguments
Value | Summary |
---|---|
resource_id | Id of the resource |
Table 50.191. Command 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 50.192. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.193. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.194. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.195. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.196. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.197. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.198. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.199. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.200. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.201. Positional arguments
Value | Summary |
---|---|
metric | Id or name of the metric |
Table 50.202. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--resource-id RESOURCE_ID, -r RESOURCE_ID | Id of the resource |
Table 50.203. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.204. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.205. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.206. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
50.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 50.207. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 50.208. Output formatter options
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 50.209. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 50.210. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 50.211. Table formatter options
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |