configuration.export

Apraksts

string configuration.export(object parameters)

Šī metode ļauj eksportēt konfigurācijas datus kā serializētu virkni.

Šī metode ir pieejama jebkura tipa lietotājiem. Tiesības izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object) Parametri, kas definē eksportējamos objektus un izmantojamo formātu.

Parameter Type Description
format string Formāts, kādā dati ir jāeksportē.

Iespējamās vērtības:
yaml - YAML;
xml - XML;
json - JSON;
raw - neapstrādāts PHP masīvs.

Parameter behavior:
- required
prettyprint boolean Padara izvadi cilvēkam lasāmāku, pievienojot atkāpes.

Iespējamās vērtības:
true - pievienot atkāpes;
false - (default) nepievienot atkāpes.
options object Eksportējamie objekti.

Objektam options ir šādi parametri:
host_groups - (array) eksportējamo host grupu ID;
hosts - (array) eksportējamo hosts ID;
images - (array) eksportējamo attēlu ID;
maps - (array) eksportējamo karšu ID;
mediaTypes - (array) eksportējamo multivides tipu ID;
template_groups - (array) eksportējamo veidņu grupu ID;
templates - (array) eksportējamo veidņu ID;
dashboards - (array) eksportējamo informācijas paneļu ID;
global_regexes - (array) eksportējamo globālo regulāro izteiksmju ID.

Admin un User tipa lietotāji var eksportēt tikai tos objektus, kuriem viņiem ir read-only vai read-write atļauja, kā arī attēlus, bet ne multivides tipus.

Parameter behavior:
- required.

Atgrieztās vērtības

(string) Atgriež serializētu virkni, kas satur pieprasītos konfigurācijas datus.

Piemēri

Veidnes eksportēšana

Eksportējiet veidnes "10571" konfigurāciju kā XML virkni.

Pieprasījums:

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

Atbilde:

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

Avots

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