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

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

[comment]: # ({24146d56-069ae59d})
### Описание

`array configuration.importcompare(параметры объектов)`

Этот метод позволяет сравнить файл импорта с текущими элементами системы и показывает, что изменится, если этот файл импорта будет импортирован.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/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* [permission](/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|Правила импорта веб-сценариев.<br><br>Поддерживаемые параметры:<br>`createMissing` - `(boolean)` если установлено в `true`, новые веб-сценарии будут созданы; по умолчанию: `false`;<br>`updateExisting` - `(boolean)` если установлено в `true`, существующие веб-сценарии будут обновлены; по умолчанию: `false`;<br>`deleteMissing` - `(boolean)` если установлено в `true`, веб-сценарии, отсутствующие в импортируемых данных, будут удалены из базы данных; по умолчанию: `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)` Возвращает массив с изменениями в конфигурации, которые будут сделаны.

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

[comment]: # ({b41637d2-b41637d2})
### Примеры

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

[comment]: # ({ee3ffa2c-d979e902})
#### Сравнение импорта шаблона

Сравните шаблон, содержащийся в XML-строке, с текущими элементами системы и покажите, что будет изменено, если этот шаблон будет импортирован.

[Запрос](/manual/api#performing-requests):

```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.4</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]: # ({/ee3ffa2c-d979e902})

[comment]: # ({f4cf61e8-c9a0185c})
### Источник

CConfiguration::importcompare() в *ui/include/classes/api/services/CConfiguration.php*.

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