更新

描述

object hostprototype.update(object/array hostPrototypes)

这种方法可以更新现有的主机原型。

此方法仅适用于 AdminSuper admin 用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅 用户角色

参数

(object/数组) 要更新的主机原型属性。

对于每个主机原型,必须定义 hostid 属性,所有其他属性都是可选的。仅更新传递的属性,所有其他属性将保持不变。

除了 标准主机原型属性 之外,该方法还接受以下参数。

参数 类型 描述
groupLinks 数组 组链接,用于替换主机原型上的当前组链接。

参数行为
- 只读 对于继承的对象
groupPrototypes 数组 组原型,用于替换主机原型上的现有组原型。

请求中未列出的所有组原型都将被删除。

参数行为
- 只读 对于继承的对象
macros 对象/数组 用户宏,用于替换当前用户宏。
请求中未列出的所有宏都将被删除。
tags 对象/数组 主机原型标签,用于替换当前标签。
请求中未列出的所有标签都将被删除。

参数行为
- 只读 对于继承的对象
interfaces 对象/数组 主机原型 自定义接口,用于替换当前接口。
自定义接口对象应包含其所有参数。
请求中未列出的所有接口都将被删除。

参数行为
- 支持 如果 主机原型对象custom_interfaces 设置为“使用主机原型自定义接口”
- 只读 对于继承的对象
templates 对象/数组 模板,用于替换当前链接的模板。

模板必须仅定义 templateid 属性。

返回值

(object) 返回一个对象,其中在 hostids 属性下包含更新的主机原型的 ID。

示例

禁用主机原型

禁用主机原型,即将其状态设置为 "1"。

请求

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

响应:

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

更新主机原型标签

用新的标签替换主机原型标签。

请求:

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

响应:

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

更新主机原型自定义接口

用主机原型自定义接口取代继承接口。

请求

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

响应:

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

另见

来源

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