hostprototype.update

描述

object hostprototype.update(object/array hostPrototypes)

此方法用于update现有的主机原型。

此方法仅对Admin和Super admin用户类型可用。 可以在用户角色设置中撤销调用该方法的权限。更多信息请参见User roles。

参数

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

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

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

Parameter Type Description
groupLinks array 用于替换主机原型当前组链接的组链接。

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

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

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

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

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

模板必须仅定义 templateid 属性。

返回值

(object) 返回一个 object，其中包含更新后的 主机 原型的 ID，这些 ID 位于 hostids 属性下。

示例

禁用主机原型

禁用 一个主机 原型，即将其状态设置为 "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() 在 ui/include/classes/api/services/CHostPrototype.php 中。