6.9. alarm update

アラームを更新します。

使用方法

openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--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>]
                              [--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>]

表6.48 表の書式設定

概要

--print-empty

表示するデータがない場合は空のテーブルを出力します。

--max-width <integer>

表示の幅の最大値 <1 は無効にする。CLIFF_MAX_TERM_MYBACKUPDIRTH 環境変数を使用することもできますが、パラメーターが優先されます。

--fit-width

表示幅にテーブルを適合させます。--max- width が 0 よりも大きい場合は暗黙的になります。常に有効にするには、環境変数を CLIFF_FIT_MYBACKUPDIRTH=1 に設定します。

表6.49 位置引数

概要

<ALARM ID または NAME>

アラームの ID または名前。

表6.50 出力形式の設定

概要

出力フォーマッターオプション -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

表6.51 common gnocchi alarm rules

概要

--aggregation-method <AGGR_METHOD>

しきい値と比較する aggregation_method

--granularity <GRANULARITY>

クエリーを行う時間範囲 (秒単位)。

表6.52 event alarm

概要

--event-type <EVENT_TYPE>

評価対象のイベントタイプ

表6.53 gnocchi resource threshold alarm

概要

--resource-id <RESOURCE_ID>

リソースの ID。

--resource-type <RESOURCE_TYPE>

リソースのタイプ。

表6.54 JSON 書式設定

概要

--noindent

Json のインデントを無効にするかどうか。

表6.55 composite alarm

概要

--composite-rule <COMPOSITE_RULE>

Json 形式の複合しきい値ルール。形式として、"and"や"or" で gnocchi ルールを組み合わせた、ネスト化ディクショナリーを指定できます。形式例: {"or":[RULE1, RULE2, {"and": [RULE3, RULE4]}]}。

表6.56 その他の引数 (オプション):

概要

--ok-action <Webhook URL>

状態が ok に切り替わったときに呼び出す URL。複数回使用できます。

--user-id <USER_ID>

アラームに関連付けるユーザー (管理ユーザーだけが設定可能)

--name <NAME>

アラームの名前

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

アラームのタイプ:event、composite、gnocchi_resources_threshold、gnocchi_aggregation_by_metrics_threshold、gnocchi_aggregation_by_resources_threshold のいずれかです。

--repeat-actions {True

False}

アラームがターゲット状態にある時にアクションを繰り返し通知する場合は True

--state <STATE>

アラームの状態。以下のいずれか:[ok, alarm, insufficient data]

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]] です。

--project-id <PROJECT_ID>

アラームに関連付けるプロジェクト (管理ユーザーだけが設定可能)

--insufficient-data-action <Webhook URL>

状態が insufficient data に切り替わったときに呼び出す URL。複数回の使用が可能です。

--severity <SEVERITY>

アラームの重大度。以下のいずれか [low, moderate,critical]

--alarm-action <Webhook URL>

状態が alarm に切り替わったときに呼び出す URL。複数回使用できます。

-h, --help

ヘルプメッセージを表示して終了します。

--description <DESCRIPTION>

アラームのフリーテキストの説明

--enabled {True

False}

アラーム評価が有効な場合は true。

表6.57 common alarm rules

概要

--evaluation-periods <EVAL_PERIODS>

評価する期間の数

--query <QUERY>

アラームのイベントタイプ: key[op]data_type::value; list。data_type はオプションですが、指定する場合には、文字列、整数、浮動またはブール型にする必要があります。gnocchi_aggregation_by_resources_threshold タイプのアラーム: {"and": [{"=": {"ended_at": null}}, …​]} のように、複雑なクエリー json 文字列を指定する必要があります。

--comparison-operator <OPERATOR>

比較するオペレーター:[lt,le,eq,ne,ge,gt] のいずれか。

--metric <METRIC>

評価対象のメトリック。

--threshold <THRESHOLD>

評価するしきい値。

表6.58 メトリクスアラームによる Gnocchi の集計

概要

--metrics <METRICS>

メトリクス ID の一覧。

表6.59 Shell フォーマッター

概要

UNIX シェルが解析できる形式(variable="value")--prefix PREFIX

すべての変数名に接頭辞を追加します。