13 Host card

説明

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

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

Parameters

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

パラメーター type name value
更新間隔 0 rf_rate 0 - 更新なし;
10 - 10秒;
30 - 30秒;
60 - (デフォルト) 1分;
120 - 2分;
600 - 10分;
900 - 15分
ホスト 3 hostid.0 ホスト ID

パラメーターの動作:
- ホスト (ウィジェット/ダッシュボード) が設定されていない場合は 必須

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

パラメータの動作:
- ホストが設定されていない場合は必須です

このパラメータは、 テンプレートダッシュボード.
抑制された問題を表示 0 show_suppressed 0 - (デフォルト) 無効;
1 - 有効
表示 0 sections.0 0 - ホストグループ;
1 - 説明;
2 - 監視;
3 - 可用性;
4 - 監視元;
5 - テンプレート;
6 - インベントリー;
7 - タグ.

注: プロパティ名の数字は、セクションリスト内のセクションの順序を表します。複数のセクションを設定するには、プロパティ名に番号を増分した、セクションごとにダッシュボードウィジェットフィールドオブジェクトを作成します。

表示 が"インベントリー"に設定されている場合、以下のパラメーターがサポートされます。

パラメーター type 名前
インベントリ フィールド 0 inventory.0 インベントリ ID

注: 複数のインベントリ フィールドを構成するには、プロパティ名に増分番号を含む、各インベントリ フィールドのダッシュボード ウィジェット フィールド オブジェクトを作成します。

次の例は、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
       }

参照