Documentation
Table of Contents
hostprototype.update
説明
object hostprototype.update(object/array hostPrototypes)
このメソッドでは、既存のホストプロトタイプを更新できます。
このメソッドはAdminおよびSuperadminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object/array) 更新されるホストプロトタイププロパティ。
hostidプロパティは、ホストプロトタイプごとに定義する必要があり、すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。
標準のホストプロトタイププロパティに加えて、このメソッドは次のパラメーターを受け入れます。
| パラメータ | タイプ | 説明 |
|---|---|---|
| groupLinks | array | ホストプロトタイプの現在のグループリンクを置き換えます。 |
| groupPrototypes | array | ホストプロトタイプ上の既存のグループプロトタイプを置き換えます。 |
| macros | object/array | 現在のユーザーマクロを置き換えます。 リクエストにリストされていないマクロはすべて削除されます。 |
| tags | object/array | ホストプロトタイプタグを使用して現在のタグを置き換えます。 リクエストにリストされていないタグはすべて削除されます。 |
| interfaces | object/array | 現在のインターフェースを置き換えるためのプロトタイプカスタムインターフェースをホストします。 カスタムインターフェースオブジェクトには、そのすべてのパラメーターが含まれている必要があります。 リクエストにリストされていないインターフェースはすべて削除されます。 |
| templates | object/array | 現在リンクされているテンプレートを置き換えます。 テンプレートには templateidプロパティが定義されている必要があります。 |
戻り値
(object) hostidsプロパティの下で更新されたホストプロトタイプのIDを含むオブジェクトを返します。
例
ホストプロトタイプの無効化
ホストプロトタイプを無効にするため、ステータスを1に設定します。
Request:
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"status": 1
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
ホストプロトタイプタグの更新
ホストプロトタイプタグを新しいタグに置き換えます。
Request:
{
"jsonrpc": "2.0",
"method": "hostprototype.update",
"params": {
"hostid": "10092",
"tags": [
{
"tag": "Datacenter",
"value": "{#DATACENTER.NAME}"
},
{
"tag": "Instance type",
"value": "{#INSTANCE_TYPE}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
ホストプロトタイプカスタムインターフェイスの更新
継承されたインターフェイスをホストプロトタイプのカスタムインターフェイスに置き換えます。
Request:
{
"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}"
}
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
参照
ソース
CHostPrototype::update() in ui/include/classes/api/services/CHostPrototype.php.