これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで障害中のホストウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 障害中のホストウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
障害ホストウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | 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"に設定した互換性のあるウィジェットをホストのデータソースとして設定します。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| 障害 | 1 | problem | 障害イベント名(大文字小文字を区別しない、完全一致または部分一致)。 | |
| 深刻度 | 0 | severities.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 | 任意の文字列値。 注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - 必須(障害タグを設定する場合) |
|
| 抑止中の障害を表示 | 0 | show_suppressed | 0 - (デフォルト) 無効; 1 - 有効。 |
|
| 障害のないグループを非表示 | 0 | hide_empty_groups | 0 - (デフォルト) 無効; 1 - 有効。 このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| 障害の表示 | 0 | ext_ack | 0 - (デフォルト) すべて; 1 - 未確認のみ; 2 - 分離。 |
|
| Reference | 1 | reference | 5文字からなる任意の文字列値(例: ABCDE または JBPNL)。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメーターの動作: - 必須 |
|
次の例は、障害中のホストウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
ホストグループ"2"と"4"に属する、名前に"CPU"という文字列が含まれ、深刻度が"警告"、"軽度の障害"、"重度の障害"、"致命的な障害"の障害が発生しているホストを表示する障害中のホストウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problemhosts",
"name": "Problem hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 2
},
{
"type": 2,
"name": "groupids.1",
"value": 4
},
{
"type": 1,
"name": "problem",
"value": "cpu"
},
{
"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
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: