Documentation
Table of Contents
22 Problems
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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 | 表示 | 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 | 問題 | 問題 イベント名 (大文字と小文字を区別しない、完全な名前またはその一部) | |
| 重大度 | 0 | 重大度 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_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 | show_lines | 可能な値の範囲は 1 ～ 100 です。 デフォルト: 25 |
|
| 参照 | 1 | 参照 | 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
}レスポンス: