23 問題
説明
これらのパラメータと、それぞれのダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値は、dashboard.createおよびdashboard.updateメソッドで障害ウィジェットを設定することを可能にします。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 障害ウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。
パラメーター
障害ウィジェットでサポートされているパラメーターは以下の通りです。
| パラメーター | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| 表示 | 0 | show | 1 - (デフォルト) 最近の障害; 2 - 履歴; 3 - 障害。 |
|
| ホストグループ | 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_tags | 0 - (デフォルト) なし; 1 - 1; 2 - 2; 3 - 3。 |
|
| タグ名(フォーマット) | 0 | tag_name_format | 0 - (デフォルト) フル; 1 - 省略; 2 - なし。 パラメーターの動作: - タグの表示が"1"、"2"、"3"の場合にサポート |
|
| タグ表示優先度 | 1 | tag_priority | カンマ区切りのタグリスト。 パラメーターの動作: - タグの表示が"1"、"2"、"3"の場合にサポート |
|
| 運用データの表示 | 0 | show_opdata | 0 - (デフォルト) なし; 1 - 別表示; 2 - 障害名と一緒に表示。 |
|
| 抑制された障害の表示 | 0 | show_suppressed | 0 - (デフォルト) 無効; 1 - 有効。 |
|
| 障害対応状況 | 0 | acknowledgement_status | 0 - (デフォルト) すべて; 1 - 未対応; 2 - 対応済み。 |
|
| 自分が対応 | 0 | acknowledged_by_me | 0 - (デフォルト) 無効; 1 - 有効。 |
|
| エントリの並び順 | 0 | sort_triggers | 1 - 深刻度(降順); 2 - ホスト(昇順); 3 - 時刻(昇順); 4 - (デフォルト) 時刻(降順); 13 - 深刻度(昇順); 14 - ホスト(降順); 15 - 障害(昇順); 16 - 障害(降順)。 "時刻(降順)"および"時刻(昇順)"以外のすべての値については、タイムラインの表示パラメーターを"無効"に設定する必要があります。 "ホスト(昇順)"および"ホスト(降順)"の値は、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| タイムラインの表示 | 0 | show_timeline | 0 - 無効; 1 - (デフォルト) 有効。 パラメーターの動作: - エントリの並び順が"時刻(降順)"または"時刻(昇順)"の場合にサポート |
|
| 行全体のハイライト | 0 | highlight_row | 0 - (デフォルト) 無効; 1 - 有効。 このパラメーターはハイコントラストテーマではサポートされません。 |
|
| 表示行数 | 0 | show_lines | 1-100の範囲で指定可能。 デフォルト: 25。 |
|
| 参照名 | 1 | reference | 5文字からなる任意の文字列値（例: ABCDEやJBPNL）。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。パラメーターの動作: - 必須 |
|
例
次の例は、障害ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
障害ウィジェットの設定
ホストグループ"4"で、以下の条件を満たす障害を表示する障害ウィジェットを設定します:
- "scope"という名前のタグが付いており、そのタグの値が"performance"、"availability"または"capacity"である障害。
- 深刻度が"警告"、"軽度の障害"、"重度の障害"、"致命的な障害"である障害。
さらに、タグと運用データを表示するようにウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"name": "Problems",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"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": "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": 0,
"name": "show_tags",
"value": 1
},
{
"type": 0,
"name": "show_opdata",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: