[comment]: # ({c0df6427-c0df6427})
# hostprototype.update

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

[comment]: # ({7da22d8d-796670ab})
### 説明

`object hostprototype.update(object/array hostPrototypes)`

このメソッドは、既存のホストプロトタイプを更新します。

::: noteclassic
このメソッドは *管理者* および *スーパ管理者* ユーザータイプでのみ利用できます。メソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細は[ユーザーロール](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/7da22d8d-796670ab})

[comment]: # ({0881900c-50727275})
### パラメータ

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

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

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

|パラメータ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|groupLinks|array|ホストプロトタイプ上の現在のグループリンクを置き換える[グループリンク](/manual/api/reference/hostprototype/object#group-link)。<br><br>[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):<br>- 継承されたオブジェクトでは *read-only*|
|groupPrototypes|array|ホストプロトタイプ上の既存のグループプロトタイプを置き換える[グループプロトタイプ](/manual/api/reference/hostprototype/object#group-prototype)。<br><br>リクエストに含まれていないすべてのグループプロトタイプは削除されます。<br><br>[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):<br>- 継承されたオブジェクトでは *read-only*|
|macros|object/array|現在のユーザーマクロを置き換える[ユーザーマクロ](/manual/api/reference/usermacro/object)。<br>リクエストに含まれていないすべてのマクロは削除されます。|
|tags|object/array|現在のタグを置き換える[ホストプロトタイプタグ](/manual/api/reference/hostprototype/object#host-prototype-tag)。<br>リクエストに含まれていないすべてのタグは削除されます。<br><br>[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):<br>- 継承されたオブジェクトでは *read-only*|
|interfaces|object/array|現在のインターフェースを置き換える、ホストプロトタイプの[カスタムインターフェース](/manual/api/reference/hostprototype/object#custom-interface)。<br>カスタムインターフェースオブジェクトには、そのすべてのパラメータを含める必要があります。<br>リクエストに含まれていないすべてのインターフェースは削除されます。<br><br>[パラメータの動作](/manual/api/reference_commentary#parameter-behavior):<br>- [Host prototype object](/manual/api/reference/usermacro/object#host-prototype) の `custom_interfaces` が "use host prototypes custom interfaces" に設定されている場合に *supported*<br>- 継承されたオブジェクトでは *read-only*|
|templates|object/array|現在リンクされているテンプレートを置き換える[テンプレート](/manual/api/reference/template/object)。<br><br>テンプレートでは `templateid` プロパティのみを定義する必要があります。|

[comment]: # ({/0881900c-50727275})

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

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

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

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

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

[comment]: # ({b9437ec2-9e34a671})
#### ホストプロトタイプの無効化

ホストプロトタイプを無効にします。つまり、ステータスを "1" に設定します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "hostprototype.update",
    "params": {
        "hostid": "10092",
        "status": 1
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/b9437ec2-9e34a671})

[comment]: # ({4592dcdd-440003e2})
#### ホストプロトタイプタグの更新

ホストプロトタイプタグを新しいものに置き換えます。

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

```json
{
    "jsonrpc": "2.0",
    "method": "hostprototype.update",
    "params": {
        "hostid": "10092",
        "tags": [
            {
                "tag": "datacenter",
                "value": "{#DATACENTER.NAME}"
            },
            {
                "tag": "instance-type",
                "value": "{#INSTANCE_TYPE}"
            }
        ]
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/4592dcdd-440003e2})

[comment]: # ({5195d3ed-7a7b18a4})
#### ホストプロトタイプのカスタムインターフェースの更新

継承されたインターフェースをホストプロトタイプのカスタムインターフェースに置き換えます。

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

```json
{
    "jsonrpc": "2.0",
    "method": "hostprototype.update",
    "params": {
        "hostid": "10092",
        "custom_interfaces": "1",
        "interfaces": [
            {
                "main": "1",
                "type": "2",
                "useip": "1",
                "ip": "127.0.0.1",
                "dns": "",
                "port": "161",
                "details": {
                    "version": "2",
                    "bulk": "1",
                    "community": "{$SNMP_COMMUNITY}"
                }
            }
        ]
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/5195d3ed-7a7b18a4})

[comment]: # ({508c69b6-c4a38bf3})
### 関連項目

-   [グループリンク](object#group-link)
-   [グループプロトタイプ](object#group-prototype)
-   [ホストプロトタイプタグ](object#host-prototype-tag)
-   [カスタムインターフェース](object#custom-interface)
-   [ユーザー
    マクロ](/manual/api/reference/usermacro/object#hosttemplate-level-macro)

[comment]: # ({/508c69b6-c4a38bf3})

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

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

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