You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

configuration.import

Descripció

boolean configuration.import(object parameters)

El mètode permet importar la configuració des d'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 els rols d'usuari.

Paràmetres

(object) Els paràmetres que contenen la informació a importar i les regles sobre com s'ha de gestionar aquesta informació.

Paràmetre Tipus Descripció
format
(obligatori)
string Format de la cadena en sèrie.

Valors possibles:
yaml - YAML;
xml - XML;
json - JSON.
source
(obligatori)
string Cadena en sèrie que conté la informació de configuració.
rules
(obligatori)
object Regles sobre com s'han d'importar els objectes nous i existents.

el paràmetre rules es descriu en detall a la taula de sota.

Si no es donen regles, la configuració no s'actualitzarà pas.

L'objecte rules admet els següents paràmetres:

Paràmetre Tipus Descripció
discoveryRules object Regles sobre com importar les regles LLD.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan noves regles LLD; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, les regles LLD s'actualitzaran; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, les regles LLD que no siguin a la informació importada s'esborrarà de la base de dades; per defecte: false.
graphs object Regles sobre importació de gràfics.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan els nous gràfics; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els gràfics existents; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els gràfics que no siguin pas a la informació importada s'esborraran de la base de dades; per defecte: false.
groups object Regles sobre importar grups d'equips.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan nous grups d'equips; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els grups d'equips existents; per defecte: false.
hosts object Regles d'importació d'equips.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan els nous equips; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els equips existents; per defecte: false.
httptests object Regles d'importació d'escenaris web.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan els nous escenaris web; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els escenaris web existents; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els escenaris web que no siguin pas a la informació importada s'esborraran de la base de dades; per defecte: false.
images object Regles sobre importació d'imatges.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan les noves imatges; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran les imatges existents; per defecte: false.
items object Regles d'importació d'elements.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan els nous elements; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els elements existents; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els elements que no siguin pas presents a la informació importada s'esborraran de la base de dades; per defecte: false.
maps object Regles d'importació de mapes.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan els nous mapes; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, existing maps will be updated; per defecte: false.
mediaTypus object Regles d'importació de tipus de suport.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan nous tipus de suport; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els tipus de suport existents; per defecte: false.
templateLinkage object Regles d'importació d'enllaços de plantilles.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan nous enllaços entre plantilles i equips; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els enllaços de plantilles que no siguin pas a la informació importada s'esborraran de la base de dades; per defecte: false.
templates object Rules on how to import templates.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan noves plantilles; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran les plantilles existents; per defecte: false.
templateDashboards object Regles d'importació de taulers de plantilles.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan nous taulers de plantilles; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els taulers de plantilles existents; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els taulers de plantilles que no siguin pas a la informació importada s'esborraran de la base de dades; per defecte: false.
triggers object Regles d'importació de triggers.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan nous triggers; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els triggers existents; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els triggers que no siguin pas a la informació importada s'esborraran de la base de dades; per defecte: false.
valueMaps object Regles d'importació d'equips o mapes de correspondència.

Paràmetres admesos:
createMissing - (boolean) Si s'estableix a true, es crearan nous mapes de correspondència; per defecte: false;
updateExisting - (boolean) Si s'estableix a true, s'actualitzaran els mapes de correspondència; per defecte: false;
deleteMissing - (boolean) Si s'estableix a true, els mapes de correspondència que no siguin a la informació importada s'esborraran de la base de dades; per defecte: false.

Valors de retorn

(boolean) Retorna true si la importació ha anat bé.

Exemples

Importar una plantilla

Importa la configuració d'un model contingut a la cadena XML. Si manquen elements o triggers de la cadena XML, s'esborraran de la base de dades i la resta es mantindrà sense canvis.

Consulta:

{
           "jsonrpc": "2.0",
           "method": "configuration.import",
           "params": {
               "format": "xml",
               "rules": {
                   "templates": {
                       "createMissing": true,
                       "updateExisting": true
                   },
                   "items": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "triggers": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   },
                   "valueMaps": {
                       "createMissing": true,
                       "updateExisting": false
                   }
               },
               "source": "<?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><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
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }

Font

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