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. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

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

Parameter Type Beschrijving
format
(verplicht)
string Het formaat waarin de gegevens geëxporteerd moeten worden.

Mogelijke waarden:
yaml - YAML;
xml - XML;
json - JSON;
raw - onbewerkte PHP-array.
prettyprint boolean Maak de uitvoer leesbaarder door inspringing toe te voegen.

Mogelijke waarden:
true - voeg inspringing toe;
false - (standaard) voeg geen inspringing toe.
options
(verplicht)
object Objecten die geëxporteerd moeten worden.

Het options object heeft de volgende parameters:
groups - (array) IDs van hostgroepen om te exporteren;
hosts - (array) IDs van hosts om te exporteren;
images - (array) IDs van afbeeldingen om te exporteren;
maps - (array) IDs van kaarten om te exporteren;
mediaTypes - (array) IDs van mediatypes om te exporteren;
templates - (array) IDs van sjablonen om te exporteren.

Teruggegeven waarden

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

Voorbeelden

Exporteren van een sjabloon

Exporteer de configuratie van sjabloon "10571" als een XML string.

Aanvraag:

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

Antwoord:

{
           "jsonrpc": "2.0",
           "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:00:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></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.