对比导入

说明

array configuration.importcompare(object parameters)

此方法允许将导入文件与当前系统元素进行比较，并显示如果导入此文件将发生哪些更改。

此方法适用于任何类型的用户。 可以在用户角色设置中撤销调用此方法的权限。 有关更多信息，请参阅用户角色。

参数

(object) 包含要导入的可能数据和数据处理规则的参数。

参数类型描述
formatstring序列化字符串的格式。

可能值：
yaml - YAML;
xml - XML;
json - JSON。

参数行为：
- 必填
sourcestring包含配置数据的序列化字符串。

参数行为：
- 必填
rulesobject关于如何比较新对象和现有对象的规则。

rules参数在以下表格中有详细描述。

参数行为：
- 必填

如果没有给出规则，则不会更新任何内容，结果将为空。

仅对主机组和模板进行比较。 仅对导入的模板进行触发器和图形的比较，其他任何内容都将被视为“新的”。

rules 对象支持以下参数。

参数类型描述
discoveryRulesobject关于如何导入LLD规则的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的LLD规则；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的LLD规则；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则将从数据库中删除导入数据中不存在的LLD规则；默认值：false。
graphsobject关于如何导入图形的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的图形；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的图形；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则将从数据库中删除导入数据中不存在的图形；默认值：false。
host_groupsobject关于如何导入主机组的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的主机组；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的主机组；默认值：false。
template_groupsobject关于如何导入模板组的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的模板组；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的模板组；默认值：false。
hostsobject关于如何导入主机的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的主机；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的主机；默认值：false。

此参数对输出没有影响。仅允许与 configuration.import 保持一致。
httptestsobject关于如何导入Web场景的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的Web场景；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的Web场景；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则会从数据库中删除导入数据中不存在的Web场景；默认值：false。
imagesobject关于如何导入图片的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的图片；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的图片；默认值：false。

此参数对输出没有影响。仅允许与 configuration.import 保持一致。
itemsobject关于如何导入项目的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的监控项；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的监控项；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则会从数据库中删除导入数据中不存在的监控项；默认值：false。
mapsobject关于如何导入地图的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的地图；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的地图；默认值：false。

此参数对输出没有影响。仅允许与 configuration.import 保持一致。
mediaTypesobject关于如何导入媒体类型的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的媒体类型；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的媒体类型；默认值：false。

此参数对输出没有影响。仅允许与 configuration.import 保持一致。
templateLinkageobject关于如何导入模板链接的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会链接导入数据中存在但尚未链接到被导入主机或模板的模板；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则会取消链接被导入主机或模板已链接但导入数据中不存在的模板，但不会删除从已取消链接的模板中继承的实体（监控项、触发器等）；默认值：false。
templatesobject关于如何导入模板的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的模板；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的模板；默认值：false。
templateDashboardsobject关于如何导入模板仪表盘的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的模板仪表盘；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的模板仪表盘；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则导入数据中不存在的模板仪表盘将从数据库中删除；默认值：false。
triggersobject关于如何导入触发器的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的触发器；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的触发器；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则导入数据中不存在的触发器将从数据库中删除；默认值：false。
valueMapsobject关于如何导入主机或模板值映射的规则。

支持的参数：
createMissing - (布尔型) 如果设置为 true，则会创建新的值映射；默认值：false；
updateExisting - (布尔型) 如果设置为 true，则会更新现有的值映射；默认值：false；
deleteMissing - (布尔型) 如果设置为 true，则导入数据中不存在的值映射将从数据库中删除；默认值：false。

返回值

(array) 返回一个数组，其中包含将进行更改的配置。

示例

比较模板导入

将XML字符串中包含的模板与当前系统元素进行比较， 并显示如果导入此模板将发生哪些更改。

请求：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "configuration.importcompare",
  4.            "params": {
  5.                "format": "xml",
  6.                "rules": {
  7.                    "discoveryRules": {
  8.                        "createMissing": true,
  9.                        "updateExisting": true,
  10.                        "deleteMissing": true
  11.                    },
  12.                    "graphs": {
  13.                        "createMissing": true,
  14.                        "updateExisting": true,
  15.                        "deleteMissing": true
  16.                    },
  17.                    "host_groups": {
  18.                        "createMissing": true,
  19.                        "updateExisting": true
  20.                    },
  21.                    "template_groups": {
  22.                        "createMissing": true,
  23.                        "updateExisting": true
  24.                    },
  25.                    "httptests": {
  26.                        "createMissing": true,
  27.                        "updateExisting": true,
  28.                        "deleteMissing": true
  29.                    },
  30.                    "items": {
  31.                        "createMissing": true,
  32.                        "updateExisting": true,
  33.                        "deleteMissing": true
  34.                    },
  35.                    "templateLinkage": {
  36.                        "createMissing": true,
  37.                        "deleteMissing": true
  38.                    },
  39.                    "templates": {
  40.                        "createMissing": true,
  41.                        "updateExisting": true
  42.                    },
  43.                    "templateDashboards": {
  44.                        "createMissing": true,
  45.                        "updateExisting": true,
  46.                        "deleteMissing": true
  47.                    },
  48.                    "triggers": {
  49.                        "createMissing": true,
  50.                        "updateExisting": true,
  51.                        "deleteMissing": true
  52.                    },
  53.                    "valueMaps": {
  54.                        "createMissing": true,
  55.                        "updateExisting": true,
  56.                        "deleteMissing": true
  57.                    }
  58.                },
  59.                "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"
  60.            },
  61.            "id": 1
  62.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "templates": {
  5.                    "updated": [
  6.                        {
  7.                            "before": {
  8.                                "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
  9.                                "template": "New template",
  10.                                "name": "New template",
  11.                                "groups": [
  12.                                    {
  13.                                        "name": "Templates"
  14.                                    }
  15.                                ]
  16.                            },
  17.                            "after": {
  18.                                "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
  19.                                "template": "New template",
  20.                                "name": "New template",
  21.                                "groups": [
  22.                                    {
  23.                                        "name": "Templates"
  24.                                    }
  25.                                ]
  26.                            },
  27.                            "items": {
  28.                                "added": [
  29.                                    {
  30.                                        "after": {
  31.                                            "uuid": "648006da5971424ead0c47ddbbf1ea2e",
  32.                                            "name": "CPU utilization",
  33.                                            "key": "system.cpu.util",
  34.                                            "value_type": "FLOAT",
  35.                                            "units": "%"
  36.                                        },
  37.                                        "triggers": {
  38.                                            "added": [
  39.                                                {
  40.                                                    "after": {
  41.                                                        "uuid": "736225012c534ec480c2a66a91322ce0",
  42.                                                        "expression": "avg(/New template/system.cpu.util,3m)>70",
  43.                                                        "name": "CPU utilization too high on 'New host' for 3 minutes",
  44.                                                        "priority": "WARNING"
  45.                                                    }
  46.                                                }
  47.                                            ]
  48.                                        }
  49.                                    }
  50.                                ],
  51.                                "removed": [
  52.                                    {
  53.                                        "before": {
  54.                                            "uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
  55.                                            "name": "CPU load",
  56.                                            "key": "system.cpu.load",
  57.                                            "value_type": "FLOAT"
  58.                                        },
  59.                                        "triggers": {
  60.                                            "removed": [
  61.                                                {
  62.                                                    "before": {
  63.                                                        "uuid": "ab4c2526c2bc42e48a633082255ebcb3",
  64.                                                        "expression": "avg(/New template/system.cpu.load,3m)>2",
  65.                                                        "name": "CPU load too high on 'New host' for 3 minutes",
  66.                                                        "priority": "WARNING"
  67.                                                    }
  68.                                                }
  69.                                            ]
  70.                                        }
  71.                                    }
  72.                                ],
  73.                                "updated": [
  74.                                    {
  75.                                        "before": {
  76.                                            "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
  77.                                            "name": "Zabbix agent ping",
  78.                                            "key": "agent.ping"
  79.                                        },
  80.                                        "after": {
  81.                                            "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
  82.                                            "name": "Zabbix agent ping",
  83.                                            "key": "agent.ping",
  84.                                            "delay": "3m"
  85.                                        }
  86.                                    }
  87.                                ]
  88.                            }
  89.                        }
  90.                    ]
  91.                }
  92.            },
  93.            "id": 1
  94.        }

源码位置

CConfiguration::importcompare() 在 ui/include/classes/api/services/CConfiguration.php 文件中。