configuration.export

Descripció

string configuration.export(object parameters)

El mètode permet exportar la configuració com una cadena en sèrie.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu [Rols d'usuari]](/manual/web_interface/frontend_sections/administration/user_roles).

Paràmetres

(object) Paràmetres que defineixen els objectes a exportar i el format a emprar.

Paràmetre	Tipus	Descripció
format (obligatori)	cadena	Format en que la informació serà exportada. Valors possibles: `yaml` - YAML; `xml` - XML; `json` - JSON; `raw` - taula PHP no processada.
prettyprint	boolean	Fer que la sortida sigui més entenedora per les persones, afegint-t'hi sagnat. Valors possibles: `true` - afegir sagnat; `false` - (per defecte) no afegir sagnat.
options (obligatori)	objecte	Objectes a exportar. L'objecte `options` té els paràmetres següents: `groups` - `(array)` IDs dels grups d'equips a exportar; `hosts` - `(array)` IDs dels equips a exportar; `images` - `(array)` IDs de les imatges a exportar; `maps` - `(array)` IDs dels mapes a exportar; `mediaTypes` - `(array)` IDs dels tipus de medis a exportar; `templates` - `(array)` IDs de les plantilles a exportar. Els usuaris de tipus Admin i Usuari només poden exportar aquells objectes per als quals tenen permís de només lectura o lectura-escriptura (/manual/api/reference/usergroup/object#permission), així com imatges, però no tipus de suport.

Valors de retorn

(string) Retorna una cadena en sèrie continguent la informació de configuració demanada.

Exemples

Exportant un equip

Exporta la configuració d'un equip com a XML.

Petició:

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

Resposta:

{
           "jsonrpc": "2.0",
           "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>5.4</version><date>2020-03-13T15:31:45Z</date><groups><group><uuid>6f6799aa69e844b4b3918f779f2abf08</uuid><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><interface_ref>if1</interface_ref></interface></interfaces><items><item><name>Item</name><key>item.key</key><delay>30s</delay><tags><tag><tag>Application</tag><value>CPU</value></tag></tags><valuemap><name>Host status</name></valuemap><interface_ref>if1</interface_ref><request_method>POST</request_method></item></items><valuemaps><valuemap><name>Host status</name><mappings><mapping><value>0</value><newvalue>Up</newvalue></mapping><mapping><value>2</value><newvalue>Unreachable</newvalue></mapping></mappings></valuemap></valuemaps></host></hosts></zabbix_export>\n",
           "id": 1
       }

Font

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

Documentation