31 トリガーの概要

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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 - 参照パラメータを"ABCDE"に設定した互換性のあるウィジェットをホストグループのデータソースとして設定します。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト 3 hostids.0 ホストのID。

注: 複数のホストを設定するには、プロパティ名の番号を増やして各ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストを設定する場合、ホストグループパラメータは未設定であるか、設定したホストが属する少なくとも1つのホストグループで設定する必要があります。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト(ウィジェット/ダッシュボード) 1 hostids._reference ホストのIDの代わりに:
DASHBOARD.hostids - ダッシュボードのホストセレクタをホストのデータソースとして設定します;
ABCDE._hostids - 参照パラメータを"ABCDE"に設定した互換性のあるウィジェットをホストのデータソースとして設定します。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
障害タグ
評価タイプ 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 layout 0 - (デフォルト) 水平;
1 - 垂直。

例

次の例は、トリガーの概要ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

トリガーの概要ウィジェットの設定

"scope"という名前で値に"availability"を含むタグでトリガーされ、すべてのホストグループのトリガー状態を表示するトリガー概要ウィジェットを設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "trigover",
                        "name": "Trigger overview",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "scope"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "availability"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照