configuration.export

Descrição

string configuration.export(object parameters)

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

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte Funções de usuário para mais informações.

Parâmetros

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

Parâmetro	Tipo	Descrição
format	string	Formato em que os dados devem ser exportados. Valores possíveis: `yaml` - YAML; `xml` - XML; `json` - JSON; `raw` - array PHP não processado. Comportamento do parâmetro: - obrigatório
prettyprint	boolean	Torna a saída mais legível para humanos, adicionando indentação. Valores possíveis: `true` - adiciona indentação; `false` - (padrão) não adiciona indentação.
options	object	Objetos a serem exportados. O objeto `options` possui os seguintes parâmetros: `host_groups` - `(array)` IDs dos grupos de hosts a serem exportados; `hosts` - `(array)` IDs dos hosts a serem exportados; `images` - `(array)` IDs das imagens a serem exportadas; `maps` - `(array)` IDs dos mapas a serem exportados; `mediaTypes` - `(array)` IDs dos tipos de mídia a serem exportados; `template_groups` - `(array)` IDs dos grupos de templates a serem exportados; `templates` - `(array)` IDs dos templates a serem exportados. Usuários dos tipos Admin e User podem exportar apenas aqueles objetos para os quais possuem permissão de somente leitura ou leitura e gravação, bem como imagens, mas não tipos de mídia. Comportamento do parâmetro: - obrigatório

Valores de retorno

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

Exemplos

Exportando um template

Exporte a configuração do template "10571" como uma string XML.

Requisição:

{
           "jsonrpc": "2.0",
           "method": "configuration.export",
           "params": {
               "options": {
                   "templates": [
                       "10571"
                   ]
               },
               "format": "xml"
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": "<?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>&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>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)&gt;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
       }

Fonte

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

Documentation