对比导入

说明

array configuration.importcompare(object parameters)

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

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

参数

(object) 包含要导入的可能数据以及应如何处理这些数据的规则的参数。

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

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

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

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

Admin 和 User 类型的用户只能将新对象与其具有 只读 或 读写 权限 的现有对象进行比较。

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。
host_groups object 关于如何导入主机组的规则。

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

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

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

此参数不会对输出产生任何影响。仅允许使用它以保持与 configuration.import 的一致性。
httptests object 关于如何导入 web 场景的规则。

支持的参数：
createMissing - (boolean) 如果设置为 true，将创建新的 web 场景；默认值：false；
updateExisting - (boolean) 如果设置为 true，将更新现有的 web 场景；默认值：false；
deleteMissing - (boolean) 如果设置为 true，数据库中存在但导入数据中不存在的 web 场景将被删除；默认值：false。
images object 关于如何导入图像的规则。

支持的参数：
createMissing - (boolean) 如果设置为 true，将创建新的图像；默认值：false；
updateExisting - (boolean) 如果设置为 true，将更新现有的图像；默认值：false。

此参数不会对输出产生任何影响。仅允许使用它以保持与 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，将更新现有的拓扑图；默认值：false。

此参数不会对输出产生任何影响。仅允许使用它以保持与 configuration.import 的一致性。
mediaTypes object 关于如何导入媒介类型的规则。

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

此参数不会对输出产生任何影响。仅允许使用它以保持与 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
            },
            "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>8.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>&lt;dt&gt;Server uptime: (.*)&lt;/dt&gt;</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)&gt;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 文件中。