このページで
30 Web monitoring
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでWeb監視ウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
Web監視ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
Webモニタリングウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | < | type | name | value | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 更新間隔 | < | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
||||||
| ホスト グループ | < | 2 | groupids.0 | ホスト グループ ID 注: 複数のホスト グループを構成するには、プロパティ名に増分番号を含む各ホスト グループのダッシュボード ウィジェット フィールド オブジェクトを作成します。 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
||||||
| ホスト グループ (ウィジェット) | 1 | groupids._reference | ホスト グループ ID:ABCDE._hostgroupids の代わりに、ホスト グループのデータ ソースとして 互換性のあるウィジェット (Reference パラメーターを "ABCDE に設定) を設定します。テンプレート ダッシュボード でウィジェットを構成する場合、このパラメーターはサポートされません。 |
|||||||
| ホストグループを除外 | < | 2 | exclude_groupids.0 | ホストグループ ID 注: 複数のホストグループを除外するには、プロパティ名に増分番号を含むダッシュボードウィジェットフィールドオブジェクトをホストグループごとに作成します。 このパラメーターは、テンプレートダッシュボードでウィジェットを構成する場合、サポートされません。 |
||||||
| ホスト | < | 3 | hostids.0 | ホスト ID 注: 複数のホストを構成するには、プロパティ名に増分番号を含むダッシュボードウィジェットフィールドオブジェクトをホストごとに作成します。複数のホストの場合、パラメーター ホスト グループ はまったく構成されていないか、構成されたホストが属する少なくとも 1 つのホスト グループで構成されている必要があります。 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
< | ホスト (ウィジェット/ダッシュボード) | 1 | hostids._reference | ホスト ID の代わりに:DASHBOARD.hostids - ホスト セレクター をホストのデータソースとして設定します。ABCDE._hostids - 互換性のあるウィジェット (Reference パラメーターを "ABCDE に設定) をホストのデータソースとして設定します。このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| シナリオ タグ | < | < | < | < | ||||||
| < | 評価タイプ | 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 | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - シナリオ タグ を構成する場合は 必須 |
||||||
| メンテナンス中のホストを表示 | < | 0 | メンテナンス | 0 - 無効; 1 - (デフォルト) 有効 |
||||||
| 参照 | < | 1 | 参照 | 5文字からなる任意の文字列値（例：ABCDE または JBPNL）この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメーターの動作: - 必須 |
||||||
Webモニタリングウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | < | type | name | value | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 更新間隔 | < | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分 |
||||||
| ホスト グループ | < | 2 | groupids.0 | ホスト グループ ID 注: 複数のホスト グループを構成するには、プロパティ名に増分番号を含む各ホスト グループのダッシュボード ウィジェット フィールド オブジェクトを作成します。 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
||||||
| ホスト グループ (ウィジェット) | 1 | groupids._reference | ホスト グループ ID:ABCDE._hostgroupids の代わりに、ホスト グループのデータ ソースとして 互換性のあるウィジェット (Reference パラメーターを "ABCDE に設定) を設定します。テンプレート ダッシュボード でウィジェットを構成する場合、このパラメーターはサポートされません。 |
|||||||
| ホストグループを除外 | < | 2 | exclude_groupids.0 | ホストグループ ID 注: 複数のホストグループを除外するには、プロパティ名に増分番号を含むダッシュボードウィジェットフィールドオブジェクトをホストグループごとに作成します。 このパラメーターは、テンプレートダッシュボードでウィジェットを構成する場合、サポートされません。 |
||||||
| ホスト | < | 3 | hostids.0 | ホスト ID 注: 複数のホストを構成するには、プロパティ名に増分番号を含むダッシュボードウィジェットフィールドオブジェクトをホストごとに作成します。複数のホストの場合、パラメーター ホスト グループ はまったく構成されていないか、構成されたホストが属する少なくとも 1 つのホスト グループで構成されている必要があります。 このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
< | ホスト (ウィジェット/ダッシュボード) | 1 | hostids._reference | ホスト ID の代わりに:DASHBOARD.hostids - ホスト セレクター をホストのデータソースとして設定します。ABCDE._hostids - 互換性のあるウィジェット (Reference パラメーターを "ABCDE に設定) をホストのデータソースとして設定します。このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| シナリオ タグ | < | < | < | < | ||||||
| < | 評価タイプ | 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 | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメーターの動作: - シナリオ タグ を構成する場合は 必須 |
||||||
| メンテナンス中のホストを表示 | < | 0 | メンテナンス | 0 - 無効; 1 - (デフォルト) 有効 |
||||||
| 参照 | < | 1 | 参照 | 5文字からなる任意の文字列値（例：ABCDE または JBPNL）この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメーターの動作: - 必須 |
||||||
例
次の例は、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
}