Sidebar

Zabbix Summit 2022
View presentations

configuration.export

Описание

string configuration.export(object parameters)

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

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

Параметры

(object) Параметры, определяющие экспортируемые объекты и формат использования.

Параметр Тип Описание
format
(обязательно)
string Формат, в котором должны быть экспортированы данные.

Возможные значения:
yaml - YAML;
xml - XML ;
json - JSON;
raw - необработанный массив PHP.
prettyprint boolean Делает вывод более удобочитаемым, добавив отступы.

Возможные значения:
true – добавить отступы;
false – (по умолчанию) не добавлять отступы .
options
(обязательно)
object Экспортируемые объекты.

Объект options имеет следующие параметры:
groups - (массив) ID группы хостов для экспорта;
hosts - (массив) идентификаторов хостов для экспорта;
images - (массив) идентификаторов изображений для экспорта;
maps - ( array) идентификаторы карт для экспорта;
mediaTypes - (массив) идентификаторов типов мультимедиа для экспорта;
templates - (массив) идентификаторов шаблонов для экспорта.

Возвращаемые значения

(string) Возвращает сериализованную строку, содержащую запрошенные данные конфигурации.

Примеры

Экспорт хоста

Экспортирует конфигурацию хоста в виде строки XML.

Запрос:

{
          "jsonrpc": "2.0",
          "method": "configuration.export",
          "params": {
             "options": {
                "hosts": [
                   "10161"
                ]
             },
             "format": "xml"
          },
          "auth": "038e1d7b1735c6a5436ee9eae095879e",
          "id": 1
       }

Ответ:

{
          "jsonrpc": "2.0",
          "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>5.4</version><date>2020-03-13T15:31:45Z</date><groups><group><uuid>6f6799aa69e844b4b3918f779f2abf08</uuid><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><interface_ref>if1</interface_ref></interface></interfaces><items><item><name>Item</name><key>item.key</key><delay>30s</delay><tags><tag><tag>Application</tag><value>CPU</value></tag></tags><valuemap><name>Host status</name></valuemap><interface_ref>if1</interface_ref><request_method>POST</request_method></item></items><valuemaps><valuemap><name>Host status</name><mappings><mapping><value>0</value><newvalue>Up</newvalue></mapping><mapping><value>2</value><newvalue>Unreachable</newvalue></mapping></mappings></valuemap></valuemaps></host></hosts></zabbix_export>\n",
          "id": 1
       }

Источник

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