23 問題
説明
これらのパラメータと、それぞれのダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値は、dashboard.createおよびdashboard.updateメソッドで障害ウィジェットを設定することを可能にします。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。
障害ウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。
パラメーター
Problems ウィジェットでサポートされるパラメーターは次のとおりです。
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 更新しない; 10 - 10秒; 30 - 30秒; 60 - (default) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| Show | 0 | show | 1 - (default) 最近の障害; 2 - 履歴; 3 - 障害。 |
|
| Host groups | 2 | groupids.0 | ホストグループ ID。 Note: 複数のホストグループを設定するには、プロパティ名の番号を増やした各ホストグループごとに dashboard widget field オブジェクトを作成します。 このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。 |
|
| Host groups (Widget) | 1 | groupids._reference | ホストグループ ID の代わりに:ABCDE._hostgroupids - 互換ウィジェット をデータソースとしてホストグループに設定します（Reference パラメーターを "ABCDE" に設定）。このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。 |
|
| Exclude host groups | 2 | exclude_groupids.0 | ホストグループ ID。 Note: 複数のホストグループを除外するには、プロパティ名の番号を増やした各ホストグループごとに dashboard widget field オブジェクトを作成します。 このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。 |
|
| Hosts | 3 | hostids.0 | ホスト ID。 Note: 複数のホストを設定するには、プロパティ名の番号を増やした各ホストごとに dashboard widget field オブジェクトを作成します。複数のホストを指定する場合、パラメーター Host groups は未設定であるか、設定したホストが属するホストグループを少なくとも 1 つ含めて設定する必要があります。 このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。 |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | ホスト ID の代わりに:DASHBOARD.hostids - Host セレクター をホストのデータソースとして設定します。ABCDE._hostids - 互換ウィジェット をデータソースとしてホストに設定します（Reference パラメーターを "ABCDE" に設定）。このパラメーターは、template dashboard でウィジェットを設定する場合はサポートされません。 |
|
| Problem | 1 | problem | 障害の イベント名（大文字小文字を区別せず、完全一致または部分一致）。 | |
| Severity | 0 | severities.0 | 0 - 未分類; 1 - 情報; 2 - Warning; 3 - Average; 4 - High; 5 - Disaster. Default: 空（すべて有効）。 Note: 複数の値を設定するには、プロパティ名の番号を増やした各値ごとに dashboard widget field オブジェクトを作成します。 |
|
| Problem tags | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | tags.0.tag | 任意の文字列値。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - required if configuring Problem tags |
|
| Operator | 0 | tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - required if configuring Problem tags |
|
| Tag value | 1 | tags.0.value | 任意の文字列値。 Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。 Parameter behavior: - required if configuring Problem tags |
|
| Show tags | 0 | show_tags | 0 - (default) なし; 1 - 1; 2 - 2; 3 - 3. |
|
| Tag name (format) | 0 | tag_name_format | 0 - (default) 完全; 1 - 短縮; 2 - なし。 Parameter behavior: - supported if Show tags is set to "1", "2", or "3" |
|
| Tag display priority | 1 | tag_priority | カンマ区切りのタグ一覧。 Parameter behavior: - supported if Show tags is set to "1", "2", or "3" |
|
| Show operational data | 0 | show_opdata | 0 - (default) なし; 1 - 個別に; 2 - 障害名とともに。 |
|
| Show suppressed problems | 0 | show_suppressed | 0 - (default) 無効; 1 - 有効。 |
|
| Acknowledgement status | 0 | acknowledgement_status | 0 - (default) すべて; 1 - 未確認; 2 - 確認済み。 |
|
| By me | 0 | acknowledged_by_me | 0 - (default) 無効; 1 - 有効。 |
|
| Sort entries by | 0 | sort_triggers | 1 - 深刻度（降順）; 2 - ホスト（昇順）; 3 - 時刻（昇順）; 4 - (default) 時刻（降順）; 13 - 深刻度（昇順）; 14 - ホスト（降順）; 15 - 障害（昇順）; 16 - 障害（降順）。 "時刻（降順）" と "時刻（昇順）" を除くすべての値で、Show timeline パラメーターを "Disabled" に設定する必要があります。 "ホスト（昇順）" と "ホスト（降順）" の値は、template dashboard でウィジェットを設定する場合はサポートされません。 |
|
| Show timeline | 0 | show_timeline | 0 - 無効; 1 - (default) 有効。 Parameter behavior: - supported if Sort entries by is set to "Time (descending)" or "Time (ascending)" |
|
| Highlight whole row | 0 | highlight_row | 0 - (default) 無効; 1 - 有効。 このパラメーターは高コントラストテーマではサポートされません。 このオプションは Zabbix 7.4.3 以降でサポートされます。 |
|
| Show lines | 0 | show_lines | 指定可能な値は 1-100 です。 Default: 25. |
|
| Reference | 1 | reference | 5 文字からなる任意の文字列値（例: ABCDE または JBPNL）。この値は、ウィジェットが属する dashboard 内で一意である必要があります。Parameter behavior: - required |
|
例
次の例は、障害ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、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
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}