Chapter 46. metric

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.

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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

name

Name of the archive policy

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Name of the archive policy

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

name

Name of the archive policy

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Name of the archive policy

-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 ':'

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Rule name

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Name of the archive policy rule

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

name

Name of the archive policy rule

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

metric

Id or name of the metric

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

metric

Id or name of the metric

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

metric

Id or name of the metrics

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

METRIC_NAME

Name of the metric

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

metric

Ids or names of the metric

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

ID of the resource

-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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

metric

Id or name of the metric

-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 '@'

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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

file

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

-h, --help

Show this help message and exit

file

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

-h, --help

Show this help message and exit

--create-metrics

Create unknown metrics

metric

Id or name of the metric

-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)

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

METRIC_NAME

Name of the metric

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

metric

Ids or names of the metric

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

ID of the resource

-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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

metric

Id or name of the metric

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

ID of the resource

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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.

-h, --help

Show this help message and exit

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

resource_id

Id of the resource

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

resource_id

Id of the resource

-h, --help

Show this help message and exit

resource_id

Id of a resource

-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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

-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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

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.

-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

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

resource_id

Id of a resource

-h, --help

Show this help message and exit

--type RESOURCE_TYPE, -t RESOURCE_TYPE

Type of resource

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

resource_id

Id of the resource

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Name of the resource type

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Name of the resource type

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

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

when to include quotes, defaults to nonnumeric

name

Name of the resource type

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

name

Name of the resource type

-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

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

metric

Id or name of the metric

-h, --help

Show this help message and exit

--resource-id RESOURCE_ID, -r RESOURCE_ID

ID of the resource

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

-h, --help

Show this help message and exit

-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

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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names