[comment]: # ({c572a02a-c572a02a})
# host.update

[comment]: # ({/c572a02a-c572a02a})

[comment]: # ({a740c7d4-12e31652})
### 説明

`object host.update(object/array hosts)`

このメソッドは、既存のホストを更新することができます。

::: noteclassic
このメソッドは、*Admin*および*Super admin*タイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細は[ユーザーの役割](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/a740c7d4-12e31652})

[comment]: # ({7c7a9b0d-3a8eac6a})
### パラメータ

`(object/array)` 更新するホストのプロパティ。

各ホストについて `hostid` プロパティを定義する必要があり、その他の
プロパティはすべて任意です。更新されるのは指定されたプロパティのみで、
それ以外は変更されません。

ただし、ホストの技術名を更新すると、その値でホストの表示名も更新されます
（表示名が別途指定されていない場合）。

このメソッドは、[標準のホストプロパティ](object#host) に加えて、
以下のパラメータを受け付けます。

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|groups|object/array|ホストが所属する現在のホストグループを置き換えるための [ホストグループ](/manual/api/reference/hostgroup/object#host-group)。<br>リクエストに記載されていないホストグループはすべてリンク解除されます。<br><br>ホストグループでは `groupid` プロパティのみを定義する必要があります。|
|interfaces|object/array|現在のホストインターフェースを置き換えるための [ホストインターフェース](/manual/api/reference/hostinterface/object)。<br>リクエストに記載されていないインターフェースはすべて削除されます。|
|tags|object/array|現在のホストタグを置き換えるための [ホストタグ](/manual/api/reference/host/object#host-tag)。<br>リクエストに記載されていないタグはすべて削除されます。|
|inventory|object|[ホストインベントリ](/manual/api/reference/host/object#host-inventory) のプロパティ。|
|macros|object/array|現在のユーザーマクロを置き換えるための [ユーザーマクロ](/manual/api/reference/usermacro/object)。<br>リクエストに記載されていないマクロはすべて削除されます。|
|templates|object/array|現在リンクされているテンプレートを置き換えるための [テンプレート](/manual/api/reference/template/object)。<br>リクエストに記載されていないテンプレートはリンク解除のみ行われます。<br><br>テンプレートでは `templateid` プロパティのみを定義する必要があります。|
|templates\_clear|object/array|ホストからリンク解除してクリアするための [テンプレート](/manual/api/reference/template/object)。<br><br>テンプレートでは `templateid` プロパティのみを定義する必要があります。|

[comment]: # ({/7c7a9b0d-3a8eac6a})

[comment]: # ({d166b99b-d166b99b})
### 戻り値

`(object)` `hostids` プロパティの下で更新されたホストの ID を含むオブジェクトを返します。

[comment]: # ({/d166b99b-d166b99b})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({bcd7b728-ce50c453})
#### ホストの有効化

ホストの監視を有効にする、つまりステータスを0にします。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10126",
        "status": 0
    },
    "id": 1
}
```

レスポンス :

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10126"
        ]
    },
    "id": 1
}
```

[comment]: # ({/bcd7b728-ce50c453})

[comment]: # ({56f46465-bea1db7e})
#### テンプレートのリンク削除

ホストから2つのテンプレートのリンクを削除してクリアします。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10126",
        "templates_clear": [
            {
                "templateid": "10124"
            },
            {
                "templateid": "10125"
            }
        ]
    },
    "id": 1
}
```

レスポンス :

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10126"
        ]
    },
    "id": 1
}
```

[comment]: # ({/56f46465-bea1db7e})

[comment]: # ({b789e636-98dcfd68})
#### ホストマクロの更新

すべてのホストマクロを新しい2つのマクロに置き換えます。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10126",
        "macros": [
            {
                "macro": "{$PASS}",
                "value": "password"
            },
            {
                "macro": "{$DISC}",
                "value": "sda",
                "description": "Updated description"
            }
        ]
    },
    "id": 1
}
```

レスポンス :

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10126"
        ]
    },
    "id": 1
}
```

[comment]: # ({/b789e636-98dcfd68})

[comment]: # ({72eb8ecc-da99f3b8})
#### ホストインベントリの更新

インベントリモードの変更とロケーションの追加をします。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10387",
        "inventory_mode": 0,
        "inventory": {
            "location": "Latvia, Riga"
        }
    },
    "id": 1
}
```

レスポンス :

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10387"
        ]
    },
    "id": 1
}
```

[comment]: # ({/72eb8ecc-da99f3b8})

[comment]: # ({603ba164-5cc5d950})
#### ホストタグの更新

すべてのホストタグを新しいものに置き換えます。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10387",
        "tags": {
            "tag": "os",
            "value": "rhel-7"
        }
    },
    "id": 1
}
```

レスポンス:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10387"
        ]
    },
    "id": 1
}
```

[comment]: # ({/603ba164-5cc5d950})

[comment]: # ({58eba4cd-ae2d89bf})
#### 検出されたホストマクロの更新

作成した検出ルールの"自動"マクロを"手動"に変換し、その値を"new-value"に変更します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10387",
        "macros": {
            "hostmacroid": "5541",
            "value": "new-value",
            "automatic": "0"
        }
    },
    "id": 1
}
```

レスポンス :

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10387"
        ]
    },
    "id": 1
}
```

[comment]: # ({/58eba4cd-ae2d89bf})

[comment]: # ({1948c7c9-f620e859})
#### ホスト暗号化の更新

ホスト"10590"を更新して、ホストからZabbixサーバーへの接続にのみPSK暗号化を使用するようにし、PSK IDとPSKキーを変更します。

ホストは[PSKを使用するように事前設定](/manual/encryption/using_pre_shared_keys#configuring-psk-for-server-agent-communication-example)する必要があることに注意してください。

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

```json
{
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "10590",
        "tls_connect": 1,
        "tls_accept": 2,
        "tls_psk_identity": "PSK 002",
        "tls_psk": "e560cb0d918d26d31b4f642181f5f570ad89a390931102e5391d08327ba434e9"
    },
    "id": 1
}
```

レスポンス:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10590"
        ]
    },
    "id": 1
}
```

[comment]: # ({/1948c7c9-f620e859})

[comment]: # ({78cf261e-23501347})
### 関連項目

-   [host.massadd](massadd)
-   [host.massupdate](massupdate)
-   [host.massremove](massremove)
-   [ホストグループ](/manual/api/reference/hostgroup/object#host-group)
-   [テンプレート](/manual/api/reference/template/object#template)
-   [ユーザーマクロ](/manual/api/reference/usermacro/object#hosttemplate-level-macro)
-   [ホストインターフェース](/manual/api/reference/hostinterface/object#host-interface)
-   [ホストインベントリ](object#host-inventory)
-   [ホストタグ](object#host-tag)
-   [プロキシ](/manual/api/reference/proxy/object#proxy)
-   [プロキシグループ](/manual/api/reference/proxygroup/object#proxy-group)

[comment]: # ({/78cf261e-23501347})

[comment]: # ({a39b5a01-a39b5a01})
### ソース

CHost::update() in *ui/include/classes/api/services/CHost.php*.

[comment]: # ({/a39b5a01-a39b5a01})