32 Web監視
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでWeb監視ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
Web監視ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメータ
以下のパラメータは Web monitoring ウィジェットでサポートされています。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (default) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| Host groups | 2 | groupids.0 | ホストグループ ID。 注: 複数のホストグループを設定するには、プロパティ名の番号を増やしながら、ホストグループごとに dashboard widget field オブジェクトを作成します。 このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Host groups (Widget) | 1 | groupids._reference | ホストグループ ID の代わりに:ABCDE._hostgroupids - 互換ウィジェット をデータソースとしてホストグループに設定します（Reference パラメータを "ABCDE" に設定）。このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Exclude host groups | 2 | exclude_groupids.0 | ホストグループ ID。 注: 複数のホストグループを除外するには、プロパティ名の番号を増やしながら、ホストグループごとに dashboard widget field オブジェクトを作成します。 このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| 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" に設定）。このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| Scenario tags | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | tags.0.tag | 任意の文字列値。 注: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 パラメータの動作: - required if configuring Scenario tags |
|
| Operator | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 注: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 パラメータの動作: - required if configuring Scenario tags |
|
| Tag value | 1 | tags.0.value | 任意の文字列値。 注: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 パラメータの動作: - required if configuring Scenario tags |
|
| Show hosts in maintenance | 0 | maintenance | 0 - 無効; 1 - (default) 有効。 |
|
| Reference | 1 | reference | 5 文字からなる任意の文字列値（例: ABCDE または JBPNL）。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - required |
|
例
次の例は、Web監視ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
Web監視ウィジェットの設定
ホストグループ"4"のアクティブなWeb監視シナリオのステータス概要を表示するWeb監視ウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "web",
"name": "Web monitoring",
"x": 0,
"y": 0,
"width": 18,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}