Documentation
configuration.importcompare
描述
array configuration.importcompare(object parameters)
此方法允许将import file与当前系统元素进行比较，并显示如果导入此import file将会发生哪些更改。
此方法可供任何类型的用户使用。 可以在用户角色设置中撤销调用该方法的权限。 更多信息请参见User roles。
参数
(object) 参数包含可用于import的可能数据以及数据应如何处理的相关规则。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| format | string | 序列化string的格式。 可选值： yaml - YAML；xml - XML；json - JSON。参数行为： - 必填 |
| source | string | 包含配置数据的序列化string。 参数行为: - 必填项 |
| rules | object | 关于新旧objects比较规则的说明。 下表详细描述了 rules参数。参数行为: - 必填项 |
如果未提供规则，则无法update，结果将为空。
仅对主机组和模板进行比较。 触发器与图形仅会针对导入的模板进行比较，其他任何内容都将被视为"新增"。
rules object 支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| discoveryRules | object | 关于如何import LLD规则的规范。 支持的参数： createMissing - 若设为true则创建新的LLD规则，类型为(boolean)；默认值：false；updateExisting - 若设为true则更新现有LLD规则，类型为(boolean)；默认值：false；deleteMissing - 若设为true则删除数据库中未在导入数据中出现的LLD规则，类型为(boolean)；默认值：false。 |
| graphs | object | 关于如何import图形的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新图形；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有图形；默认值：false；deleteMissing - (boolean) 如果设置为true，将从数据库中删除导入数据中不存在的图形；默认值：false。 |
| host_groups | object | 关于如何import主机组的规则。 支持的参数： createMissing - (boolean)如果设置为true，将创建新的主机组；默认值：false；updateExisting - (boolean)如果设置为true，将更新现有的主机组；默认值：false。 |
| template_groups | object | 关于如何import模板组的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的模板组；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的模板组；默认值：false。 |
| hosts | object | 关于如何import主机的规则。 支持的参数： createMissing - 若设为true则创建新主机，类型为(boolean)；默认值：false；updateExisting - 若设为true则更新现有主机，类型为(boolean)；默认值：false。此参数不会对输出产生影响，仅为保持与 configuration.import的一致性而保留。 |
| httptests | object | 关于如何importWeb场景的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的Web场景；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的Web场景；默认值：false；deleteMissing - (boolean) 如果设置为true，将从数据库中删除导入数据中不存在的Web场景；默认值：false。 |
| images | object | 关于如何import图像的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新图像；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有图像；默认值：false。此参数不会对输出产生任何影响。仅为了与 configuration.import保持一致而允许使用。 |
| items | object | 关于如何import监控项的规则。 支持的参数： createMissing - 若设为true则创建新的监控项，类型为(boolean)；默认值：false；updateExisting - 若设为true则更新现有监控项，类型为(boolean)；默认值：false；deleteMissing - 若设为true则删除数据库中未出现在导入数据里的监控项，类型为(boolean)；默认值：false。 |
| maps | object | 关于如何import地图的规则。 支持的参数： createMissing - (boolean)若设为true将创建新地图，默认值：false；updateExisting - (boolean)若设为true将更新现有地图，默认值：false。此参数不会影响输出。仅为保持与 configuration.import的一致性而保留。 |
| mediaTypes | object | 媒体类型import的操作规则。 支持的参数： createMissing - (boolean)若设为true，将创建新媒体类型，默认值：false；updateExisting - (boolean)若设为true，将更新现有媒体类型，默认值：false。此参数不会影响输出。仅为保持与 configuration.import的一致性而保留。 |
| templateLinkage | object | 关于如何import模板链接的规则。 支持的参数： createMissing - (boolean) 若设置为true时，未链接到主机或导入模板但存在于导入数据中的模板将被链接；默认值：false；deleteMissing - (boolean) 若设置为true时，已链接到主机或导入模板但不存在于导入数据中的模板将被解除链接（保留从该模板继承的实体如监控项、触发器等）；默认值：false。 |
| templates | object | 关于如何import模板的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新模板；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有模板；默认值：false。 |
| templateDashboards | object | 关于如何import模板仪表板的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的模板仪表板；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的模板仪表板；默认值：false；deleteMissing - (boolean) 如果设置为true，将从数据库中删除导入数据中不存在的模板仪表板；默认值：false。 |
| triggers | object | 关于如何import触发器的规则。 支持的参数： createMissing - (boolean)如果设置为true，将创建新触发器；默认值：false；updateExisting - (boolean)如果设置为true，将更新现有触发器；默认值：false；deleteMissing - (boolean)如果设置为true，导入数据中不存在的触发器将从数据库中删除；默认值：false。 |
| valueMaps | object | 关于如何import主机或模板值映射的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的值映射；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的值映射；默认值：false；deleteMissing - (boolean) 如果设置为true，将从数据库中删除导入数据中不存在的值映射；默认值：false。 |
返回值
(array) 返回一个包含配置更改的array，这些更改将被实施。
示例
比较模板导入
将 XML string 中包含的模板与当前系统元素进行比较，并显示如果导入此模板将发生哪些更改。
执行请求:
{
"jsonrpc": "2.0",
"method": "configuration.importcompare",
"params": {
"format": "xml",
"rules": {
"discoveryRules": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"graphs": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"host_groups": {
"createMissing": true,
"updateExisting": true
},
"template_groups": {
"createMissing": true,
"updateExisting": true
},
"httptests": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"templateLinkage": {
"createMissing": true,
"deleteMissing": true
},
"templates": {
"createMissing": true,
"updateExisting": true
},
"templateDashboards": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
}
},
"source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>7.0</version><template_groups><template_group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></template_group></template_groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key><delay>3m</delay></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter><dt>Server uptime: (.*)</dt></parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>648006da5971424ead0c47ddbbf1ea2e</uuid><name>CPU utilization</name><key>system.cpu.util</key><value_type>FLOAT</value_type><units>%</units><triggers><trigger><uuid>736225012c534ec480c2a66a91322ce0</uuid><expression>avg(/New template/system.cpu.util,3m)>70</expression><name>CPU utilization too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n"
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": {
"templates": {
"updated": [
{
"before": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template",
"groups": [
{
"name": "Templates"
}
]
},
"after": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template",
"groups": [
{
"name": "Templates"
}
]
},
"items": {
"added": [
{
"after": {
"uuid": "648006da5971424ead0c47ddbbf1ea2e",
"name": "CPU utilization",
"key": "system.cpu.util",
"value_type": "FLOAT",
"units": "%"
},
"triggers": {
"added": [
{
"after": {
"uuid": "736225012c534ec480c2a66a91322ce0",
"expression": "avg(/New template/system.cpu.util,3m)>70",
"name": "CPU utilization too high on 'New host' for 3 minutes",
"priority": "WARNING"
}
}
]
}
}
],
"removed": [
{
"before": {
"uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
"name": "CPU load",
"key": "system.cpu.load",
"value_type": "FLOAT"
},
"triggers": {
"removed": [
{
"before": {
"uuid": "ab4c2526c2bc42e48a633082255ebcb3",
"expression": "avg(/New template/system.cpu.load,3m)>2",
"name": "CPU load too high on 'New host' for 3 minutes",
"priority": "WARNING"
}
}
]
}
}
],
"updated": [
{
"before": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Zabbix agent ping",
"key": "agent.ping"
},
"after": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Zabbix agent ping",
"key": "agent.ping",
"delay": "3m"
}
}
]
}
}
]
}
},
"id": 1
}来源
CConfiguration::importcompare() 在 ui/include/classes/api/services/CConfiguration.php 中。