configuration.export

Descrizione

string configuration.export(object parameters)

Questo metodo consente di esportare i dati di configurazione come stringa serializzata.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere User roles.

Parametri

(object) Parametri che definiscono gli oggetti da esportare e il formato da utilizzare.

Parameter Type Description
format string Formato in cui i dati devono essere esportati.

Valori possibili:
yaml - YAML;
xml - XML;
json - JSON;
raw - array PHP non elaborato.

Comportamento del parametro:
- required
prettyprint boolean Rende l'output più leggibile per l'utente aggiungendo l'indentazione.

Valori possibili:
true - aggiunge l'indentazione;
false - (default) non aggiunge l'indentazione.
options object Oggetti da esportare.

L'oggetto options ha i seguenti parametri:
host_groups - (array) ID dei gruppi host da esportare;
hosts - (array) ID degli host da esportare;
images - (array) ID delle immagini da esportare;
maps - (array) ID delle mappe da esportare;
mediaTypes - (array) ID dei tipi di media da esportare;
template_groups - (array) ID dei gruppi template da esportare;
templates - (array) ID dei template da esportare;
dashboards - (array) ID delle dashboard da esportare;
global_regexes - (array) ID delle espressioni regolari globali da esportare.

Gli utenti di tipo Admin e User possono esportare solo gli oggetti per i quali dispongono dell'autorizzazione di sola lettura o lettura e scrittura permission, oltre alle immagini, ma non ai tipi di media.

Comportamento del parametro:
- required.

Valori restituiti

(string) Restituisce una stringa serializzata contenente i dati di configurazione richiesti.

Esempi

Esportazione di un template

Esporta la configurazione del template "10571" come stringa XML.

Richiesta:

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

Risposta:

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

Sorgente

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