Documentation
Table of Contents
27 Top triggers
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで上位トリガーウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 上位トリガーウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
上位トリガーウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - (デフォルト) 更新なし; 10 - 10秒; 30 - 30秒; 60 - 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
|
| ホスト グループ | 2 | groupids.0 | ホスト グループ ID 注: 複数のホスト グループを構成するには、プロパティ名に増分番号を含むダッシュボード ウィジェット フィールド オブジェクトをホスト グループごとに作成します。 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合、サポートされません。 |
|
| ホスト | 3 | hostids.0 | ホスト ID 注: 複数のホストを構成するには、プロパティ名に増分番号を含むダッシュボード ウィジェット フィールド オブジェクトをホストごとに作成します。複数のホストの場合、パラメータ ホスト グループ はまったく設定しないか、設定されているホストが属するホスト グループを少なくとも 1 つ設定する必要があります。 このパラメータは、テンプレート ダッシュボード でウィジェットを設定する場合、サポートされません。 |
|
| 問題 | 1 | 問題 | 問題 イベント名 (大文字と小文字を区別しない、完全な名前またはその一部) | |
| 重大度 | 0 | 重大度0 | トリガーの重大度 0 - 分類なし 1 - 情報 2 - 警告 3 - 平均 4 - 高 5 - 災害 デフォルト: 空 (すべて有効) 注: 複数の値を設定するには、プロパティ名に増分番号を付けた各値のダッシュボード ウィジェット フィールド オブジェクトを作成します。 |
|
| 問題タグ | ||||
| 評価タイプ | 0 | evaltype | 0 - (デフォルト) And/Or; 2 - Or |
|
| タグ名 | 1 | tags.0.tag | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメータの動作: - 問題タグ を構成する場合は 必須 |
|
| 演算子 | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメータの動作: - 問題のあるタグを構成する場合は必須 |
|
| タグ値 | 1 | tags.0.value | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメータの動作: - 問題のあるタグを構成する場合は必須 |
|
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - 期間セレクターをデータソースとして設定します。ABCDE._timeperiod - 互換性のあるウィジェット（Referenceパラメータを"ABCDE"に設定）をデータソースとして設定します。デフォルト: DASHBOARD._timeperiodまたは、FromパラメータとToパラメータでのみ期間を設定することもできます。 |
|
| From | 1 | time_period.from | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメータの動作: - 期間 が設定されていない場合は サポートされます。 |
|
| To | 1 | time_period.to | 絶対時刻（YYYY-MM-DD hh:mm:ss）または相対時刻構文（now、now/d、now/w-1wなど）で有効な時刻文字列パラメータの動作: - 期間が設定されていない場合はサポートされます。 |
|
| トリガー制限 | 0 | show_lines | 可能な値の範囲は1～100です。 デフォルト：10 |
|
例
次の例は、上位トリガーウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
上位トリガーウィジェットの設定
ホストグループ"4"の各トリガーのすべての障害を数えて上位5トリガーを表示する上位トリガー ウィジェットを設定します。このウィジェットには、深刻度が"警告"、"軽度の障害"、"重度の障害"、"致命的な障害"のトリガーで、名前が"scope"でタグ名に"performance"、"availability"、または"capacity"のいずれかの値が含まれる障害のみが表示されます。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "toptriggers",
"name": "Top triggers",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 0,
"name": "severities.0",
"value": 2
},
{
"type": 0,
"name": "severities.1",
"value": 3
},
{
"type": 0,
"name": "severities.2",
"value": 4
},
{
"type": 0,
"name": "severities.3",
"value": 5
},
{
"type": 1,
"name": "tags.0.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "performance"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 0
},
{
"type": 1,
"name": "tags.1.value",
"value": "availability"
},
{
"type": 1,
"name": "tags.2.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.2.operator",
"value": 0
},
{
"type": 1,
"name": "tags.2.value",
"value": "capacity"
},
{
"type": 0,
"name": "show_lines",
"value": 5
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: