Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

2.37. openstack alarm update

usage: openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--name <NAME>] [-t <TYPE>]
                              [--project-id <PROJECT_ID>]
                              [--user-id <USER_ID>]
                              [--description <DESCRIPTION>] [--state <STATE>]
                              [--severity <SEVERITY>] [--enabled {True|False}]
                              [--alarm-action <Webhook URL>]
                              [--ok-action <Webhook URL>]
                              [--insufficient-data-action <Webhook URL>]
                              [--time-constraint <Time Constraint>]
                              [--repeat-actions {True|False}]
                              [--query <QUERY>]
                              [--comparison-operator <OPERATOR>]
                              [--evaluation-periods <EVAL_PERIODS>]
                              [--threshold <THRESHOLD>] [--metric <METRIC>]
                              [-m <METER NAME>] [--period <PERIOD>]
                              [--statistic <STATISTIC>]
                              [--event-type <EVENT_TYPE>]
                              [--granularity <GRANULARITY>]
                              [--aggregation-method <AGGR_METHOD>]
                              [--resource-type <RESOURCE_TYPE>]
                              [--resource-id <RESOURCE_ID>]
                              [--metrics <METRICS>]
                              [--composite-rule <COMPOSITE_RULE>]
                              [<ALARM ID or NAME>]
Update an alarm

Positional arguments

<ALARM ID or NAME>


        ID or name of an alarm.

Optional arguments

-h, --help


        show this help message and exit

--name <NAME>


        Name of the alarm

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


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

--project-id <PROJECT_ID>


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

--user-id <USER_ID>


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

--description <DESCRIPTION>


      Free text description of the alarm

--state <STATE>


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

--severity <SEVERITY>


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

--enabled {True|False}


      True if alarm evaluation is enabled

--alarm-action <Webhook URL>


      URL to invoke when state transitions to alarm. May be
      used multiple times

--ok-action <Webhook URL>


      URL to invoke when state transitions to OK. May be
      used multiple times

--insufficient-data-action <Webhook URL>


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

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

--repeat-actions {True|False}


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