configuration.export

Descrição

string configuration.export(object parameters)

Este método permite exportar os dados de configuração como uma string serializada.

Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.

Parâmetros

(object) Parâmetros que definem os objetos a serem exportados e o formato usar.

|Parâmetro|Tipo|Descrição| |---------|----------------------------------- ------------|-----------| |formato
(obrigatório)|string|Formato no qual os dados devem ser exportados.

Valores possíveis:
yaml - YAML;
xml - XML ;
json - JSON;
raw - array PHP não processado.| |prettyprint|boolean|Torne a saída mais legível adicionando recuo.

Valores possíveis:
true - adiciona recuo;
false - (padrão) não adiciona recuo .| |options
(obrigatório)|object|Objetos a serem exportados.

O objeto options tem os seguintes parâmetros:
groups - (array) IDs de grupos de hosts para exportar;
hosts - (array) IDs de hosts para exportar;
images - (array) IDs de imagens para exportar;
maps - ( array) IDs de mapas a serem exportados;
mediaTypes - (array) IDs de tipos de mídia a serem exportados;
templates - (array) IDs de modelos a serem exportados.
|

Valores de retorno

(string) Retorna uma string serializada contendo os dados de configuração solicitados.

Exemplos

Exportando um host

Exporta a configuração de um host como uma string XML.

Requisição:

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

Resposta:

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

Fonte

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

Documentation