configuration.import
Описание
boolean configuration.import(параметры объекта)
Этот метод позволяет импортировать данные конфигурации из сериализованной строки.
Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.
Параметры
(object) Параметры, содержащие данные для импорта и правила обработки этих данных.
| Параметр | Тип | Описание |
|---|---|---|
| format | string | Формат сериализованной строки. Возможные значения: yaml - YAML;xml - XML;json - JSON.Поведение параметра: - обязательный |
| source | string | Сериализованная строка, содержащая данные конфигурации. Поведение параметра: - обязательный |
| rules | object | Правила импорта новых и существующих объектов. Пользователи типа Admin могут импортировать только те объекты, на которые у них есть разрешение чтение-запись, а также карты. Например, узел сети и его сущности (элементы данных, триггеры, графики и т. д.) могут быть импортированы только в том случае, если группа пользователей пользователя имеет разрешение на группу узлов сети, к которой будет принадлежать импортируемый узел сети. Изображения и типы медиа не могут быть импортированы пользователями типа Admin. Параметр 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. |
| httptests | object | Правила импорта веб-сценариев. Поддерживаемые параметры: createMissing - (boolean) если установлено значение true, будут созданы новые веб-сценарии; по умолчанию: false;updateExisting - (boolean) если установлено значение true, существующие веб-сценарии будут обновлены; по умолчанию: false;deleteMissing - (boolean) если установлено значение true, веб-сценарии, отсутствующие в импортируемых данных, будут удалены из базы данных; по умолчанию: false. |
| images | object | Правила импорта изображений. Поддерживаемые параметры: createMissing - (boolean) если установлено значение true, будут созданы новые изображения; по умолчанию: false;updateExisting - (boolean) если установлено значение true, существующие изображения будут обновлены; по умолчанию: false. |
| items | object | Правила импорта элементов данных. Поддерживаемые параметры: createMissing - (boolean) если установлено значение true, будут созданы новые элементы данных; по умолчанию: false;updateExisting - (boolean) если установлено значение true, существующие элементы данных будут обновлены; по умолчанию: false;deleteMissing - (boolean) если установлено значение true, элементы данных, отсутствующие в импортируемых данных, будут удалены из базы данных; по умолчанию: false. |
| maps | object | Правила импорта карт. Поддерживаемые параметры: createMissing - (boolean) если установлено значение true, будут созданы новые карты; по умолчанию: false;updateExisting - (boolean) если установлено значение true, существующие карты будут обновлены; по умолчанию: false. |
| mediaTypes | object | Правила импорта типов медиа. Поддерживаемые параметры: createMissing - (boolean) если установлено значение true, будут созданы новые типы медиа; по умолчанию: false;updateExisting - (boolean) если установлено значение true, существующие типы медиа будут обновлены; по умолчанию: false. |
| 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. |
Возвращаемые значения
(логическое) Возвращает true при успешном импорте.
Примеры
Импорт шаблона
Импортируйте конфигурацию шаблона, содержащуюся в XML-строке. Если какие-либо элементы данных или триггеры в XML-строке отсутствуют, они будут удалены из базы данных, а всё остальное останется без изменений.
{
"jsonrpc": "2.0",
"method": "configuration.import",
"params": {
"format": "xml",
"rules": {
"templates": {
"createMissing": true,
"updateExisting": true
},
"items": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"triggers": {
"createMissing": true,
"updateExisting": true,
"deleteMissing": true
},
"valueMaps": {
"createMissing": true,
"updateExisting": false
}
},
"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></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>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)>2</expression><name>CPU load too high on {HOST.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": true,
"id": 1
}
Источник
CConfiguration::import() в ui/include/classes/api/services/CConfiguration.php.