更新
描述
object hostprototype.update(object/array hostPrototypes)
这种方法可以更新现有的主机原型。
此方法仅适用于 Admin 和 Super admin 用户类型。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅 用户角色。
参数
(object/array)
要更新的主机原型属性。
必须为每个主机原型定义 hostid
属性,其他属性均为可选属性。只有通过的属性才会被更新,所有其他属性将保持不变。
除了 [标准主机原型属性](object#host_prototype)外,该方法还接受以下参数。
参数 | 类型 | 说明 |
---|---|---|
groupLinks | array | 组链接来替换主机原型上的当前组链接。 参数行为: - 对继承的对象只读 |
groupPrototypes | array | 组原型 来替换主机原型上现有的组原型。 参数行为: - 对继承的对象只读 |
macros | object/array | 用户宏 to 来替换现有的用户宏。 所有未在请求中列出的宏都将被删除。 |
tags | object/array | 主机原型标签 来替换现有的标签。 所有未在请求中列出的标签都将被删除。 参数行为: - 对继承的对象只读 |
interfaces | object/array | 主机原型自定义接口 来替换现有的接口。 自定义接口对象应包含其所有参数。 所有未在请求中列出的接口都将被删除。 参数行为: - 如果 主机原型对象 的 custom_interfaces 设置成”使用主机原型自定义接口”则支持- 对继承的对象只读 |
templates | object/array | 模板 to 来替换现在链接的模板。 模板必须只定义了 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.