比较导入
描述
array configuration.importcompare(object parameters)
这个方法允许将导入文件与当前系统元素进行比较，并展示如果导入文件被导入将会发生哪些变化。
此方法适用于任何类型的用户。 可以在用户角色设置中撤销调用方法的权限。 更多信息，请参见用户角色。
参数
(object) 包含可能要导入的数据以及如何处理数据的规则。
| 参数 | 类型 | 描述 |
|---|---|---|
| format (必需) |
string | 序列化字符串的格式。 可能的值： yaml - YAML;xml - XML;json - JSON。 |
| source (必需) |
string | 包含配置数据的序列化字符串。 |
| rules (必需) |
object | 如何导入新对象和现有对象的规则。rules 参数在下面的表中详细描述。 |
如果没有给出规则，将没有内容可以更新，结果将是空的。
仅对主机组和模板进行比较。触发器和图表仅对导入的模板进行比较，其他任何内容都将被视为“新”的。
rules 对象支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| discoveryRules | object | 如何导入LLD规则的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的LLD规则；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的LLD规则；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的LLD规则；默认值：false。 |
| graphs | object | 如何导入图表的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的图表；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的图表；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的图表；默认值：false。 |
| groups | object | 如何导入主机组的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的主机组；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的主机组；默认值：false。 |
| hosts | object | 如何导入主机的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的主机；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的主机。此参数对输出没有影响。它仅被允许以与 configuration.import 保持一致性。 |
| httptests | object | 如何导入网络场景的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的网络场景；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的网络场景；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的网络场景；默认值：false。 |
| images | object | 如何导入图像的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的图像；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的图像。此参数对输出没有影响。它仅被允许以与 configuration.import 保持一致性。 |
| items | object | 如何导入监控项的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的监控项；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的监控项；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的监控项；默认值：false。 |
| maps | object | 如何导入地图的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的地图；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的地图。此参数对输出没有影响。它仅被允许以与 configuration.import 保持一致性。 |
| mediaTypes | object | 如何导入媒体类型的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的媒体类型；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的媒体类型。此参数对输出没有影响。它仅被允许以与 configuration.import 保持一致性。 |
| templateLinkage | object | 如何导入模板链接的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会将不在导入数据中但与正在导入的主机或模板链接的模板链接起来；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会将与正在导入的主机或模板链接但在导入数据中不存在的模板取消链接，但不会删除从取消链接的模板继承的实体（监控项、触发器等）；默认值：false。 |
| templates | object | 如何导入模板的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的模板；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的模板；默认值：false。 |
| templateDashboards | object | 如何导入模板仪表盘的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的模板仪表盘；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的模板仪表盘；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的模板仪表盘；默认值：false。 |
| triggers | object | 如何导入触发器的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的触发器；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的触发器；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的触发器；默认值：false。 |
| valueMaps | object | 如何导入主机或模板值映射的规则。 支持的参数： createMissing - (boolean) 如果设置为 true，则会创建新的值映射；默认值：false；updateExisting - (boolean) 如果设置为 true，则会更新现有的值映射；默认值：false；deleteMissing - (boolean) 如果设置为 true，则会从数据库中删除导入数据中不存在的值映射；默认值：false。 |
返回值
(array) 返回一个数组，包含将要进行的配置变更。
示例
模板导入比较
将XML字符串中包含的模板与当前系统元素进行比较，并展示如果该模板被导入将会发生哪些变更。
请求：
{
"jsonrpc": "2.0",
"method": "configuration.importcompare",
"params": {
"format": "xml",
"rules": {
"discoveryRules": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"graphs": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"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>6.0</version><date>2023-01-01T12:30:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></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"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": {
"templates": {
"updated": [
{
"before": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template"
},
"after": {
"uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
"template": "New template",
"name": "New template"
},
"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 文件中。