17 アイテムナビゲーター

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでアイテムナビゲーターウィジェットを設定できます。

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

パラメータ

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

Parameter type name value
Refresh interval 0 rf_rate 0 - 更新しない;
10 - 10秒;
30 - 30秒;
60 - (default) 1分;
120 - 2分;
600 - 10分;
900 - 15分.
Host groups 2 groupids.0 ホストグループ ID.

Note: 複数のホストグループを設定するには、プロパティ名の番号を増やして、各ホストグループごとに dashboard widget field オブジェクトを作成してください。

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Host groups (Widget) 1 groupids._reference ホストグループ ID の代わりに:
ABCDE._hostgroupids - 互換ウィジェット（Reference パラメータを "ABCDE" に設定）をホストグループのデータソースとして設定します。

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

Note: 複数のホストを設定するには、プロパティ名の番号を増やして、各ホストごとに dashboard widget field オブジェクトを作成してください。複数のホストを設定する場合、パラメータ Host groups は未設定であるか、設定するホストが属するホストグループを少なくとも 1 つ含むように設定する必要があります。

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

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Host tags
Evaluation type 0 host_tags_evaltype 0 - (default) And/Or;
2 - Or.

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Tag name 1 host_tags.0.tag 任意の文字列値。

Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- Host tags を設定する場合は required

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Operator 0 host_tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- Host tags を設定する場合は required

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Tag value 1 host_tags.0.value 任意の文字列値。

Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- Host tags を設定する場合は required

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Item patterns 1 items.0 アイテム 名またはパターン。

Note: 複数の item pattern を設定するには、プロパティ名の番号を増やして、各 item pattern ごとに dashboard widget field オブジェクトを作成してください。
Item tags
Evaluation type 0 item_tags_evaltype 0 - (default) And/Or;
2 - Or.
Tag name 1 item_tags.0.tag 任意の文字列値。

Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- Item tags を設定する場合は required
Operator 0 item_tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- Item tags を設定する場合は required
Tag value 1 item_tags.0.value 任意の文字列値。

Note: プロパティ名の番号は、タグ評価リスト内のタグ順序を参照します。

Parameter behavior:
- Item tags を設定する場合は required
State 0 state -1 - (default) すべて;
0 - 正常;
1 - サポートされていません。
Show problems 0 show_problems 0 - すべて;
1 - (default) 抑制されていないもの;
2 - なし。
Group by
Attribute 0 group_by.0.attribute 0 - ホストグループ;
1 - ホスト名;
2 - ホストタグ値;
3 - アイテムタグ値。

Note: プロパティ名の番号は、グループ化属性リスト内の属性順序を参照します。

Parameter behavior:
- Group by を設定する場合は required
Value 1 group_by.0.tag_name 任意の文字列値。

Note: プロパティ名の番号は、Attribute パラメータで設定されたグループ化属性を参照します。

Parameter behavior:
- Group by を設定し、かつ Attribute が "Host tag value" または "Item tag value" に設定されている場合は required
Item limit 0 show_lines 1-9999 の範囲の値を指定できます。

Default: 100.
Reference 1 reference ABCDE や JBPNL のような 5 文字からなる任意の文字列値。この値は、ウィジェットが属する dashboard 内で一意である必要があります。

Parameter behavior:
- required

例

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

アイテムナビゲーターウィジェットの設定

最大1000個のアイテムをホスト別、さらに"コンポーネント"アイテムタグ値別にグループ化して表示するアイテムナビゲーターウィジェットを設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemnavigator",
                        "name": "Item navigator",
                        "x": "0",
                        "y": "0",
                        "width": "12",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 0,
                                "name": "group_by.0.attribute",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "group_by.1.attribute",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "group_by.1.tag_name",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "show_lines",
                                "value": 1000
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "DFNLK"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照