[comment]: # translation:outdated

[comment]: # ({740c189c-63c2979a})
# 12 Host availability

[comment]: # ({/740c189c-63c2979a})

[comment]: # ({6fcd6d98-0a764751})
### 説明

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

[comment]: # ({/6fcd6d98-0a764751})

[comment]: # ({db2d42e6-4337d56d})
### Parameters

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

|パラメーター|<|[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分|
|*ホスト グループ*|<|2|groupids.0|[ホスト グループ](/manual/api/reference/hostgroup/get) ID<br><br>注: 複数のホスト グループを構成するには、プロパティ名に増分番号を含む各ホスト グループのダッシュボード ウィジェット フィールド オブジェクトを作成します。<br><br>このパラメーターは、[テンプレート ダッシュボード](/manual/api/reference/templatedashboard/object) でウィジェットを構成する場合はサポートされません。|
|<|*ホスト グループ (ウィジェット)*|1|groupids.\_reference|[ホスト グループ](/manual/api/reference/hostgroup/get) ID:<br>`ABCDE._hostgroupids` の代わりに、ホスト グループのデータ ソースとして [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (*Reference* パラメータを "`ABCDE` に設定) を設定します。<br><br>[テンプレート ダッシュボード](/manual/api/reference/templatedashboard/object) でウィジェットを構成する場合、このパラメータはサポートされません。|
|*インターフェース タイプ*|<|0|interface_type.0|0 - なし;<br>1 - Zabbix エージェント (パッシブ チェック);<br>2 - SNMP;<br>3 - IPMI;<br>4 - JMX;<br>5 - Zabbix エージェント (アクティブ チェック)<br><br>デフォルト: 1、2、3、4、5 (すべて有効)<br><br>注: 複数の値を設定するには、プロパティ名に増分番号を付けた各値のダッシュボード ウィジェット フィールド オブジェクトを作成します。|
|*レイアウト*|<|0|layout|0 - *(デフォルト)* 水平;<br>1 - 垂直|
|*メンテナンス中のホストを表示*|<|0|maintenance|0 - *(デフォルト)* 無効;<br>1 - 有効|
|*合計のみを表示*|<|0|only_totals|0 - *(デフォルト)* 無効;<br>1 - 有効|

[comment]: # ({/db2d42e6-4337d56d})

[comment]: # ({acd1fefc-5da77460})
### 例

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

[comment]: # ({/acd1fefc-5da77460})

[comment]: # ({5499ab7c-055ba5b7})
#### *ホスト稼働状況*ウィジェットの設定

"Zabbixエージェント"および"SNMP"インターフェースが設定されているホストグループ"4"のホストの可用性情報を(縦型レイアウトで)表示する*ホスト稼働状況*ウィジェットを設定します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "hostavail",
                        "name": "Host availability",
                        "x": 0,
                        "y": 0,
                        "width": 18,
                        "height": 3,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "interface_type",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "interface_type",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "layout",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/5499ab7c-055ba5b7})

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

-   [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-3cce45df})