configuration.export

Beschreibung

string configuration.export(object parameters)

Diese Methode ermöglicht den Export von Konfigurationsdaten als serialisierte Zeichenkette.

Diese Methode steht allen Benutzern zur Verfügung. Die Berechtigung zum Aufrufen der Methode kann in den Benutzerrolleneinstellungen entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die zu exportierenden Objekte und das zu verwendende Format definieren.

Parameter Type Beschreibung
format string Format, in dem die Daten exportiert werden müssen.

Mögliche Werte:
yaml - YAML;
xml - XML;
json - JSON;
raw - unverarbeitetes PHP-Array.

Parameterverhalten:
- erforderlich
prettyprint boolean Macht die Ausgabe durch Einrückung besser lesbar.

Mögliche Werte:
true - Einrückung hinzufügen;
false - (Standard) keine Einrückung hinzufügen.
options object Zu exportierende Objekte.

Das Objekt options hat die folgenden Parameter:
host_groups - (array) IDs der Hostgruppen, die exportiert werden sollen;
hosts - (array) IDs der Hosts, die exportiert werden sollen;
images - (array) IDs der Bilder, die exportiert werden sollen;
maps - (array) IDs der Karten, die exportiert werden sollen;
mediaTypes - (array) IDs der Medientypen, die exportiert werden sollen;
template_groups - (array) IDs der Vorlagengruppen, die exportiert werden sollen;
templates - (array) IDs der Vorlagen, die exportiert werden sollen.

Admin- und User-Benutzer dürfen nur solche Objekte exportieren, für die sie über die Berechtigung nur lesen oder lesen und schreiben permission verfügen, sowie Bilder, jedoch keine Medientypen.

Parameterverhalten:
- erforderlich

Rückgabewerte

(string) Gibt eine serialisierte Zeichenfolge zurück, welche die angeforderten Konfigurationsdaten enthält.

Beispiele

Exportieren einer Vorlage

Exportieren Sie die Konfiguration der Vorlage "10571" als XML-String.

Anfrage:

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

Antwort:

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

Quelle

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