configuration.importcompare

Описание

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

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(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 Правила импорта веб-сценариев.

Поддерживаемые параметры:
createMissing - (boolean) если установлено в true, будут созданы новые веб-сценарии; по умолчанию: false;
updateExisting - (boolean) если установлено в true, существующие веб-сценарии будут обновлены; по умолчанию: false;
deleteMissing - (boolean) если установлено в true, веб-сценарии, отсутствующие в импортируемых данных, будут удалены из базы данных; по умолчанию: 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.