Chapter 6. alarm

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

--granularity <GRANULARITY>

The time range in seconds over which to query.

--event-type <EVENT_TYPE>

Event type to evaluate against

--resource-id <RESOURCE_ID>

The id of a resource.

--resource-type <RESOURCE_TYPE>

The type of resource.

--noindent

Whether to disable indenting the json

--composite-rule <COMPOSITE_RULE>

Composite threshold rule with json format, the form can be a nested dict which combine gnocchi rules by "and", "or". For example, the form is like: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}.

--ok-action <Webhook URL>

Url to invoke when state transitions to ok. may be used multiple times

--user-id <USER_ID>

User to associate with alarm (configurable by admin users only)

--name <NAME>

Name of the alarm

-t <TYPE>, --type <TYPE>

Type of alarm, should be one of: event, composite, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold.

--repeat-actions {True

False}

True if actions should be repeatedly notified while alarm remains in target state

--state <STATE>

State of the alarm, one of: [ok, alarm, insufficient data]

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--project-id <PROJECT_ID>

Project to associate with alarm (configurable by admin users only)

--insufficient-data-action <Webhook URL>

Url to invoke when state transitions to insufficient data. May be used multiple times

--severity <SEVERITY>

Severity of the alarm, one of: [low, moderate, critical]

--alarm-action <Webhook URL>

Url to invoke when state transitions to alarm. may be used multiple times

-h, --help

Show this help message and exit

--description <DESCRIPTION>

Free text description of the alarm

--enabled {True

False}

True if alarm evaluation is enabled

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--query <QUERY>

For alarms of type event: key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean. For alarms of type gnocchi_aggregation_by_resources_threshold: need to specify a complex query json string, like: {"and": [{"=": {"ended_at": null}}, …​]}.

--comparison-operator <OPERATOR>

Operator to compare with, one of: [lt, le, eq, ne, ge, gt]

--metric <METRIC>

Metric to evaluate against.

--threshold <THRESHOLD>

Threshold to evaluate against.

--metrics <METRICS>

The list of metric ids.

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<ALARM ID or NAME>

Id or name of an alarm.

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

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

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--query QUERY

Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

alarm_id

Id of an alarm

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

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--noindent

Whether to disable indenting the json

--sort <SORT_KEY:SORT_DIR>

Sort of resource attribute. e.g. timestamp:desc

--limit <LIMIT>

Number of resources to return (default is server default)

-h, --help

Show this help message and exit

--marker <MARKER>

Last item of the previous listing. return the next results after this value,the supported marker is event_id.

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

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

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--noindent

Whether to disable indenting the json

--sort <SORT_KEY:SORT_DIR>

Sort of resource attribute, e.g. name:asc

--filter <KEY1=VALUE1;KEY2=VALUE2…​>

Filter parameters to apply on returned alarms.

--query QUERY

Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar

--marker <MARKER>

Last item of the previous listing. return the next results after this value,the supported marker is alarm_id.

--limit <LIMIT>

Number of resources to return (default is server default)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<ALARM ID or NAME>

Id or name of an alarm.

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<ALARM ID or NAME>

Id or name of an alarm.

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<ALARM ID or NAME>

Id or name of an alarm.

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--name <NAME>

Name of the alarm

-h, --help

Show this help message and exit

--state <STATE>

State of the alarm, one of: [ok, alarm, insufficient data]

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

<ALARM ID or NAME>

Id or name of an alarm.

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--aggregation-method <AGGR_METHOD>

The aggregation_method to compare to the threshold.

--granularity <GRANULARITY>

The time range in seconds over which to query.

--event-type <EVENT_TYPE>

Event type to evaluate against

--resource-id <RESOURCE_ID>

The id of a resource.

--resource-type <RESOURCE_TYPE>

The type of resource.

--noindent

Whether to disable indenting the json

--composite-rule <COMPOSITE_RULE>

Composite threshold rule with json format, the form can be a nested dict which combine gnocchi rules by "and", "or". For example, the form is like: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}.

--ok-action <Webhook URL>

Url to invoke when state transitions to ok. may be used multiple times

--user-id <USER_ID>

User to associate with alarm (configurable by admin users only)

--name <NAME>

Name of the alarm

-t <TYPE>, --type <TYPE>

Type of alarm, should be one of: event, composite, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold.

--repeat-actions {True

False}

True if actions should be repeatedly notified while alarm remains in target state

--state <STATE>

State of the alarm, one of: [ok, alarm, insufficient data]

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]

--project-id <PROJECT_ID>

Project to associate with alarm (configurable by admin users only)

--insufficient-data-action <Webhook URL>

Url to invoke when state transitions to insufficient data. May be used multiple times

--severity <SEVERITY>

Severity of the alarm, one of: [low, moderate, critical]

--alarm-action <Webhook URL>

Url to invoke when state transitions to alarm. may be used multiple times

-h, --help

Show this help message and exit

--description <DESCRIPTION>

Free text description of the alarm

--enabled {True

False}

True if alarm evaluation is enabled

--evaluation-periods <EVAL_PERIODS>

Number of periods to evaluate over

--query <QUERY>

For alarms of type event: key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean. For alarms of type gnocchi_aggregation_by_resources_threshold: need to specify a complex query json string, like: {"and": [{"=": {"ended_at": null}}, …​]}.

--comparison-operator <OPERATOR>

Operator to compare with, one of: [lt, le, eq, ne, ge, gt]

--metric <METRIC>

Metric to evaluate against.

--threshold <THRESHOLD>

Threshold to evaluate against.

--metrics <METRICS>

The list of metric ids.

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names