hostprototype.update

描述

object hostprototype.update(object/array hostPrototypes)

此方法允许update现有的主机原型.

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

参数

(object/array) 主机 原型属性待更新.

每个主机原型必须定义hostid属性,其他 属性均为可选。仅传递的属性会被更新,所有 其他属性将保持不变.

主机原型外,该方法还接受以下 参数.

参数 数据类型 描述
groupLinks array 用于替换主机原型上当前组链接的组组链接.
groupPrototypes array 用于替换主机原型上现有组原型的组组原型.

未在请求中列出的所有组原型将被移除.
macros object/array 用于替换当前用户宏的User macros.

未在请求中列出的所有宏将被移除.
tags object/array 用于替换当前标签的主机原型主机原型标签.

未在请求中列出的所有标签将被移除.
interfaces object/array 用于替换当前接口的主机原型自定义接口.

自定义接口object应包含其所有参数.
未在请求中列出的所有接口将被移除.
templates object/array 用于替换当前链接模板的Templates.

模板必须已定义templateid属性.

返回值

(object) 返回一个包含更新后的object ID的主机原型数组,存储在hostids属性下。

示例

禁用主机原型

禁用一个主机原型,即将其状态设置为1.

请求:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.update",
           "params": {
               "hostid": "10092",
               "status": 1
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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}"
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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}"
                       }
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

另请参阅

来源

CHostPrototype::update() 位于 ui/include/classes/api/services/CHostPrototype.php 文件中.