[comment]: # ({2956300c-2956300c})
# configuration.importcompare

[comment]: # ({/2956300c-2956300c})

[comment]: # ({24146d56-069ae59d})
### 描述

`array configuration.importcompare(object parameters)`

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

::: noteclassic
此方法可供任何类型的用户使用。
可以在用户角色设置中撤销调用该方法的权限。
更多信息请参见[User roles](/manual/web_interface/frontend_sections/users/user_roles)。
:::

[comment]: # ({/24146d56-069ae59d})

[comment]: # ({fa5f4195-0ae26f0f})
### 参数

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|format|string|序列化字符串的格式。<br><br>可能的值：<br>`yaml` - YAML；<br>`xml` - XML；<br>`json` - JSON。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- *required*|
|source|string|包含配置数据的序列化字符串。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- *required*|
|rules|object|用于比较新对象和现有对象的规则。<br><br>*Admin* 和 *User* 类型用户只能将新对象与其具有 *read-only* 或 *read-write* [权限](/manual/api/reference/usergroup/object#permission)的现有对象进行比较。<br><br>`rules` 参数的详细说明见下表。<br><br>[参数行为](/manual/api/reference_commentary#parameter-behavior)：<br>- *required*|

::: noteimportant
如果未提供任何规则，则不会有任何内容可更新，结果将为空。
:::

::: notetip
仅会对主机组和模板进行比较。
触发器和图形仅会针对已导入的模板进行比较，其他内容都将视为“新建”。
:::

`rules` 对象支持以下参数。

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|discoveryRules|object|导入 LLD 规则的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的 LLD 规则；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的 LLD 规则；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的 LLD 规则；默认值：`false`。|
|graphs|object|导入图形的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的图形；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的图形；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的图形；默认值：`false`。|
|host_groups|object|导入主机组的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的主机组；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的主机组；默认值：`false`。|
|template_groups|object|导入模板组的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的模板组；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的模板组；默认值：`false`。|
|hosts|object|导入主机的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的主机；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的主机；默认值：`false`。<br><br>此参数不会对输出产生任何影响。仅为与 `configuration.import` 保持一致而允许使用。|
|httptests|object|导入 web 场景的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的 web 场景；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的 web 场景；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的 web 场景；默认值：`false`。|
|images|object|导入图像的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的图像；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的图像；默认值：`false`。<br><br>此参数不会对输出产生任何影响。仅为与 `configuration.import` 保持一致而允许使用。|
|items|object|导入监控项的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的监控项；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的监控项；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的监控项；默认值：`false`。|
|maps|object|导入地图的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的地图；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的地图；默认值：`false`。<br><br>此参数不会对输出产生任何影响。仅为与 `configuration.import` 保持一致而允许使用。|
|mediaTypes|object|导入媒体类型的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的媒体类型；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的媒体类型；默认值：`false`。<br><br>此参数不会对输出产生任何影响。仅为与 `configuration.import` 保持一致而允许使用。|
|templateLinkage|object|导入模板链接的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将链接未与正在导入的主机或模板关联、但存在于导入数据中的模板；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将取消与正在导入的主机或模板关联、但不存在于导入数据中的模板的链接，而不删除从已取消链接模板继承的实体（监控项、触发器等）；默认值：`false`。|
|templates|object|导入模板的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的模板；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的模板；默认值：`false`。|
|templateDashboards|object|导入模板仪表板的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的模板仪表板；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的模板仪表板；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的模板仪表板；默认值：`false`。|
|triggers|object|导入触发器的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的触发器；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的触发器；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的触发器；默认值：`false`。|
|valueMaps|object|导入主机或模板值映射的规则。<br><br>支持的参数：<br>`createMissing` - `(boolean)` 如果设为 `true`，将创建新的值映射；默认值：`false`；<br>`updateExisting` - `(boolean)` 如果设为 `true`，将更新现有的值映射；默认值：`false`；<br>`deleteMissing` - `(boolean)` 如果设为 `true`，将从数据库中删除导入数据中不存在的值映射；默认值：`false`。|

[comment]: # ({/fa5f4195-0ae26f0f})

[comment]: # ({5ee9fb6b-43693d8e})
### 返回值

`(array)` 返回一个包含配置更改的array，这些更改将被实施。

[comment]: # ({/5ee9fb6b-43693d8e})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({e4aded1b-d979e902})
#### 比较模板导入

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

[执行请求](/manual/api#执行请求):


```json
{
    "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>&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
}
```
响应：


```json
{
    "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
}
```

[comment]: # ({/e4aded1b-d979e902})

[comment]: # ({f4cf61e8-c9a0185c})
### 来源

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

[comment]: # ({/f4cf61e8-c9a0185c})
