[comment]: # ({b933518c-49270b24})
# 13 Host card

[comment]: # ({/b933518c-49270b24})

[comment]: # ({9c4a7c19-dbef1114})
### 説明

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

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

[comment]: # ({/9c4a7c19-dbef1114})

[comment]: # ({13078533-7ad965d8})
### パラメータ

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

|パラメータ|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*更新間隔*|<|0|rf_rate|0 - 更新なし;<br>10 - 10秒;<br>30 - 30秒;<br>60 - *(デフォルト)* 1分;<br>120 - 2分;<br>600 - 10分;<br>900 - 15分。|
|*ホスト*|<|3|hostid.0|[ホスト](/manual/api/reference/host/get)のID。<br><br>[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *必須*（*ホスト（ウィジェット/ダッシュボード）*が設定されていない場合）<br><br>このパラメータは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|<|*ホスト（ウィジェット/ダッシュボード）*|1|hostid.\_reference|[ホスト](/manual/api/reference/host/get)のIDの代わりに：<br>`DASHBOARD.hostid` - ダッシュボードの[ホストセレクタ](/manual/web_interface/frontend_sections/dashboards/widgets#override-host)をホストのデータソースとして設定;<br>`ABCDE._hostid` - [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（*参照*パラメータが"`ABCDE`"に設定されているもの）をホストのデータソースとして設定。<br><br>[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *必須*（*ホスト*が設定されていない場合）<br><br>このパラメータは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|*抑制された障害を表示*|<|0|show_suppressed|0 - *(デフォルト)* 無効;<br>1 - 有効。|
|*表示*|<|0|sections.0|0 - ホストグループ;<br>1 - 説明;<br>2 - 監視;<br>3 - 可用性;<br>4 - 監視サーバー;<br>5 - テンプレート;<br>6 - インベントリ;<br>7 - タグ。<br><br>注：プロパティ名の数字はセクションリスト内のセクション順序を参照します。複数のセクションを設定するには、各セクションごとにプロパティ名の数字を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。|

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

|パラメータ|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*インベントリフィールド*|0|inventory.0|[インベントリ](/manual/api/reference/host/object#host-inventory)のID。<br><br>注：複数のインベントリフィールドを設定するには、各インベントリフィールドごとにプロパティ名の数字を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。|

[comment]: # ({/13078533-7ad965d8})

[comment]: # ({8ad3bebf-9735261c})
### 例

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

[comment]: # ({/8ad3bebf-9735261c})

[comment]: # ({baeb35ec-095f7dfe})
#### Configuring a *Host card* widget

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

[リクエスト](/manual/api#performing-requests):

```json
{
    "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
}
```

レスポンス:

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

[comment]: # ({/baeb35ec-095f7dfe})

[comment]: # ({e9d30322-bc2b8a1f})
### 参照

-   [Dashboard widget field](/manual/api/reference/dashboard/object#dashboard-widget-field)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-bc2b8a1f})