23 問題

説明

これらのパラメータと、それぞれのダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値は、dashboard.createおよびdashboard.updateメソッドで障害ウィジェットを設定することを可能にします。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 障害ウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。

パラメータ

以下のパラメータは、障害ウィジェットでサポートされています。

パラメータ タイプ 名前
更新間隔 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 障害のevent name (大文字と小文字を区別しない、完全な名前またはその一部)。
深刻度 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 - 有効。

このパラメータはハイコントラストテーマではサポートされません。

このオプションはZabbix 7.4.3以降でサポートされています。
表示行数 0 show_lines 指定可能な値の範囲は1~100です。

デフォルト: 25。
Reference 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
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参照