configuratie.export

Beschrijving

string configuration.export(object parameters)

Deze methode maakt het mogelijk om configuratiegegevens te exporteren als een geserialiseerde tekenreeks.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemmingen om de methode te gebruiken kunnen worden ingetrokken in de gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de te exporteren objecten en het te gebruiken formaat definiëren.

Parameter	Type	Beschrijving
format	string	Formaat waarin de gegevens geëxporteerd moeten worden. Mogelijke waarden: `yaml` - YAML; `xml` - XML; `json` - JSON; `raw` - onverwerkt PHP-array. Gedrag van parameters: - verplicht
prettyprint	boolean	Maak de uitvoer leesbaarder voor mensen door inspringing toe te voegen. Mogelijke waarden: `true` - inspringing toevoegen; `false` - (standaard) geen inspringing toevoegen.
options	object	Objecten die geëxporteerd moeten worden. Het `options`-object heeft de volgende parameters: `host_groups` - `(array)` ID's van hostgroepen om te exporteren; `hosts` - `(array)` ID's van hosts om te exporteren; `images` - `(array)` ID's van afbeeldingen om te exporteren; `maps` - `(array)` ID's van plattegronden om te exporteren; `mediaTypes` - `(array)` ID's van mediatypen om te exporteren; `template_groups` - `(array)` ID's van sjabloonsgroepen om te exporteren; `templates` - `(array)` ID's van sjablonen om te exporteren. Gedrag van parameters: - verplicht

Teruggegeven waarden

(string) Geeft een geserialiseerde tekenreeks terug met de gevraagde configuratiegegevens.

Voorbeelden

Het exporteren van een sjabloon

Exporteer de configuratie van sjabloon "10571" als een XML-tekenreeks.

Verzoek:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.4</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 'New 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
       }

Bron

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

Documentation