13 Host card

説明

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

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

パラメータ

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

Parameter type name value
Refresh interval 0 rf_rate 0 - 更新しない;
10 - 10秒;
30 - 30秒;
60 - (default) 1分;
120 - 2分;
600 - 10分;
900 - 15分。
Host 3 hostid.0 ホスト ID。

Parameter behavior:
- required if Host (Widget/Dashboard) is not set

This parameter is not supported if configuring the widget on a template dashboard.
Host (Widget/Dashboard) 1 hostid._reference ホスト ID の代わりに:
DASHBOARD.hostid - Host セレクター をホストのデータソースとして設定します;
ABCDE._hostid - 互換ウィジェットReference パラメータを "ABCDE" に設定)をホストのデータソースとして設定します。

Parameter behavior:
- required if Host is not set

This parameter is not supported if configuring the widget on a template dashboard.
Show suppressed problems 0 show_suppressed 0 - (default) 無効;
1 - 有効。
Show 0 sections.0 0 - ホストグループ;
1 - 説明;
2 - 監視;
3 - 可用性;
4 - 監視元;
5 - テンプレート;
6 - インベントリ;
7 - タグ。

Note: プロパティ名の数値は、セクション一覧内のセクション順を示します。複数のセクションを設定するには、各セクションごとに、プロパティ名の数値を増やした dashboard widget field オブジェクトを作成してください。

Show が "Inventory" に設定されている場合、以下のパラメータがサポートされます。

Parameter type name value
Inventory fields 0 inventory.0 インベントリ ID。

Note: 複数のインベントリフィールドを設定するには、各インベントリフィールドごとに、プロパティ名の数値を増やした dashboard widget field オブジェクトを作成してください。

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

Configuring a Host card widget

"監視"、"可用性"、"監視元"、"インベントリ"、"タグ"の各セクションを表示する ホストカード ウィジェットを設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "hostcard",
                        "name": "Host card",
                        "x": 0,
                        "y": 0,
                        "width": 14,
                        "height": 7,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostid.0",
                                "value": 10084
                            },
                            {
                                "type": 0,
                                "name": "show_suppressed",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "sections.0",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "sections.1",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "sections.2",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "sections.3",
                                "value": 6
                            },
                            {
                                "type": 0,
                                "name": "sections.4",
                                "value": 7
                            },
                            {
                                "type": 0,
                                "name": "inventory.0",
                                "value": 25
                            },
                            {
                                "type": 0,
                                "name": "inventory.1",
                                "value": 26
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照