30 トリガー概要
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでトリガーの概要ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
トリガーの概要ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
以下のパラメーターは、Trigger Overview ウィジェットでサポートされています。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (default) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| Show | 0 | show | 1 - (default) 最近の障害; 2 - すべて; 3 - 障害。 |
|
| Host groups | 2 | groupids.0 | ホストグループ ID。 注: 複数のホストグループを設定するには、プロパティ名の番号を増やしながら、各ホストグループごとに dashboard widget field オブジェクトを作成します。 このパラメーターは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Host groups (Widget) | 1 | groupids._reference | ホストグループ ID の代わりに:ABCDE._hostgroupids - 互換ウィジェット を、Reference パラメーターを "ABCDE" に設定してホストグループのデータソースとして使用します。このパラメーターは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Hosts | 3 | hostids.0 | ホスト ID。 注: 複数のホストを設定するには、プロパティ名の番号を増やしながら、各ホストごとに dashboard widget field オブジェクトを作成します。複数のホストを設定する場合、パラメーター Host groups は未設定にするか、設定するホストが属するホストグループを少なくとも1つ含めて設定する必要があります。 このパラメーターは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | ホスト ID の代わりに:DASHBOARD.hostids - Host セレクター をホストのデータソースとして設定します;ABCDE._hostids - 互換ウィジェット を、Reference パラメーターを "ABCDE" に設定してホストのデータソースとして使用します。このパラメーターは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Problem tags | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | tags.0.tag | 任意の文字列値。 注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - required Problem tags を設定する場合は必須 |
|
| Operator | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - required Problem tags を設定する場合は必須 |
|
| Tag value | 1 | tags.0.value | 任意の文字列値。 注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - required Problem tags を設定する場合は必須 |
|
| Show suppressed problems | 0 | show_suppressed | 0 - (default) 無効; 1 - 有効。 |
|
| Layout | 0 | layout | 0 - (default) 横; 1 - 縦。 |
|
例
次の例は、トリガーの概要ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
トリガーの概要ウィジェットの設定
"scope"という名前で値に"availability"を含むタグでトリガーされ、すべてのホストグループのトリガー状態を表示するトリガー概要ウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "trigover",
"name": "Trigger overview",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "tags.0.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "availability"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}