configuration.export

Descripción

string configuration.export(object parameters)

Este método permite exportar datos de configuración como una cadena serializada.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.

Parámetros

(object) Parámetros que definen los objetos a exportar y el formato a utilizar.

Parámetro	Tipo	Descripción
format	string	Formato en el que se deben exportar los datos. Valores posibles: `yaml` - YAML; `xml` - XML; `json` - JSON; `raw` - array PHP sin procesar. Comportamiento del parámetro: - obligatorio
prettyprint	boolean	Hace que la salida sea más legible para humanos añadiendo sangría. Valores posibles: `true` - añadir sangría; `false` - (por defecto) no añadir sangría.
options	object	Objetos a exportar. El objeto `options` tiene los siguientes parámetros: `host_groups` - `(array)` IDs de grupos de equipos a exportar; `hosts` - `(array)` IDs de equipos a exportar; `images` - `(array)` IDs de imágenes a exportar; `maps` - `(array)` IDs de mapas a exportar; `mediaTypes` - `(array)` IDs de tipos de medios a exportar; `template_groups` - `(array)` IDs de grupos de plantillas a exportar; `templates` - `(array)` IDs de plantillas a exportar. Comportamiento del parámetro: - obligatorio

Valores de retorno

(string) Devuelve una cadena serializada que contiene los datos de configuración solicitados.

Ejemplos

Exportando una plantilla

Exportar la configuración de la plantilla "10571" como una cadena XML.

Solicitud:

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

Respuesta:

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

Fuente

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

Documentation