configuration.importcompare

Descripció

array configuration.importcompare(object parameters)

Aquest mètode permet comparar l'arxiu importat amb els elements de sistema actuals, i mostra quins canvis hi haurà en cas d'importar l'arxiu.

Aquest mètode és disponible per a usuaris de qualsevol tipus. Els permisos per fer la crida al mètode es poden revocar a la configuració de rol d'usuaris. Per tindre més informació, veieu els rols d'usuaris.

Paràmetres

(object) Paràmetres que contenen les dades possibles a importar i les regles de tractament de les dades.

Paràmetre	Tipus	Descripció
format (obligatori)	string	Format de la cadena serialitzada. Valors possibles: `yaml` - YAML; `xml` - XML; `json` - JSON.
source (obligatori)	string	Cadena serialitzada continguent la informació de configuració.
rules (obligatori)	object	regles sobre com s'han d'importar els nous i existents objectes. El paràmetre `rules` es descriu en detall a la taula de sota.

Si no es donen regles, no hi haurà pas res a actualitzar; i el resultat serà buit.

La comparació es farà només per a grups d'equips i plantilles. Els triggers i gràfics es compararan només per a les plantilles importades; qualsevol altra es considerarà com a nova.

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

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 existents s'actualitzaran; per defecte: `false`; `deleteMissing` - `(boolean)` si s'estableix a `true`, les regles LLD que no són pas presents 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 nous gràfics; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, els gràfics existents s'actualitzaran; per defecte: `false`; `deleteMissing` - `(boolean)` si s'estableix a `true`, els gràfics que no són pas presents a la informació importada s'esborraran de la base de dades; per defecte: `false`.
groups	object	Regles sobre importació de grups d'equips. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, els nous grups d'equips es crearan; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, els grups d'equips existents s'actualitzaran; per defecte: `false`.
hosts	object	Regles sobre importació d'equips. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, els nous equips es crearan; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, els equips existents s'actualitzaran; per defecte: `false`. Aquest paràmetre no modificarà pas la sortida. És disponible només per consistència amb `configuration.import`.
httptests	object	Regles sobre importació d'escenaris web. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, els nous escenaris web es crearan; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, els escenaris web existents s'actualitzaran; per defecte: `false`; `deleteMissing` - `(boolean)` si s'estableix a `true`, els escenaris web no presents a la informació importada seran esborrats 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`, les imatges existents s'actualitzaran; per defecte: `false`. Aquest paràmetre no modificarà pas la sortida. Només és habilitat per consistència amb `configuration.import`.
items	object	Regles sobre importació de nous 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 són presents a la informació importada s'esborraran de la base de dades; per defecte: `false`.
maps	object	Regles sobre 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`, s'actualitzaran els mapes existents; per defecte: `false`. Aquest paràmetre no modificarà pas la sortida. Només és habilitat per consistència amb `configuration.import`.
mediaTypes	object	regles sobre importació de tipus de suport. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, es crearan els nous tipus de suport; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, s'actualitzaran els tipus de suport existents; per defecte: `false`. Aquest paràmetre no modificarà pas la sortida. Només és habilitat per consistència amb `configuration.import`.
templateLinkage	object	Regles sobre importació de plantilles d'enllaços. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, es crearan els nous enllaços entre plantilles; per defecte: `false`; `deleteMissing` - `(boolean)` si s'estableix a `true`, els enllaços entre plantilles que no siguin presents a la informació importada s'esborraran de la base de dades; per defecte: `false`.
templates	object	Regles sobre importació de plantilles. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, es crearan les noves plantilles; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, les plantilles existents s'actualitzaran; per defecte: `false`.
templateDashboards	object	Regles sobre importació dels taulers de plantilles. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, es crearan els 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 no existents a la informació importada s'esborraran de la base de dades; per defecte: `false`.
triggers	object	Regles sobre importació de triggers. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, es crearan els 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 no existents a la informació importada s'esborrarà de la base de dades; per defecte: `false`.
valueMaps	object	Regles sobre importació d'equips o plantilles de correspondència. Paràmetres admesos: `createMissing` - `(boolean)` si s'estableix a `true`, es crearan les noves plantilles de correspondència; per defecte: `false`; `updateExisting` - `(boolean)` si s'estableix a `true`, s'actualitzaran les plantilles de correspondència existents; per defecte: `false`; `deleteMissing` - `(boolean)` si s'estableix a `true`, les plantilles de correspondència que no són pas presents a la informació importada s'esborrarà de la base de dades; per defecte: `false`.

Valors de retorn

(array) Retorna una taula amb els canvis de configuració que es duran a terme.

Exemples

Comparar la importació d'un model

Compara el model contingut a la cadena XML dels elements de sistema actuals, i ensenya el que canviarà si s'importa aquest model.

Petició:

{
        · "jsonrpc": "2.0",
        · "method": "configuration.importcompare",
        · "params": {
        · "format": "xml",
        · "rules": {
        · "discoveryRules": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · },
        · "graphs": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · },
        · "groups": {
        · "createMissing": true,
        · "updateExisting": true
        · },
        · "httptests": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · },
        · "items": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · },
        · "templateLinkage": {
        · "createMissing": true,
        · "deleteMissing": true
        · },
        · "templates": {
        · "createMissing": true,
        · "updateExisting": true
        · },
        · "templateDashboards": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · },
        · "triggers": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · },
        · "valueMaps": {
        · "createMissing": true,
        · "updateExisting": true,
        · "deleteMissing": true
        · }
        · },
        · "source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:30:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></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><delay>3m</delay></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>648006da5971424ead0c47ddbbf1ea2e</uuid><name>CPU utilization</name><key>system.cpu.util</key><value_type>FLOAT</value_type><units>%</units><triggers><trigger><uuid>736225012c534ec480c2a66a91322ce0</uuid><expression>avg(/New template/system.cpu.util,3m)>70</expression><name>CPU utilization 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"
        · },
        · "auth": "038e1d7b1735c6a5436ee9eae095879e",
        · "id": 1
       }

Resposta:

{
        · "jsonrpc": "2.0",
        · "result": {
        · "templates": {
        · "updated": [
        · {
        · "before": {
        · "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
        · "template": "New template",
        · "name": "New template"
        · },
        · "after": {
        · "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
        · "template": "New template",
        · "name": "New template"
        · },
        · "items": {
        · "added": [
        · {
        · "after": {
        · "uuid": "648006da5971424ead0c47ddbbf1ea2e",
        · "name": "CPU utilization",
        · "key": "system.cpu.util",
        · "value_type": "FLOAT",
        · "units": "%"
        · },
        · "triggers": {
        · "added": [
        · {
        · "after": {
        · "uuid": "736225012c534ec480c2a66a91322ce0",
        · "expression": "avg(/New template/system.cpu.util,3m)>70",
        · "name": "CPU utilization too high on 'New host' for 3 minutes",
        · "priority": "WARNING"
        · }
        · }
        · ]
        · }
        · }
        · ],
        · "removed": [
        · {
        · "before": {
        · "uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
        · "name": "CPU load",
        · "key": "system.cpu.load",
        · "value_type": "FLOAT"
        · },
        · "triggers": {
        · "removed": [
        · {
        · "before": {
        · "uuid": "ab4c2526c2bc42e48a633082255ebcb3",
        · "expression": "avg(/New template/system.cpu.load,3m)>2",
        · "name": "CPU load too high on 'New host' for 3 minutes",
        · "priority": "WARNING"
        · }
        · }
        · ]
        · }
        · }
        · ],
        · "updated": [
        · {
        · "before": {
        · "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
        · "name": "Zabbix agent ping",
        · "key": "agent.ping"
        · },
        · "after": {
        · "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
        · "name": "Zabbix agent ping",
        · "key": "agent.ping",
        · "delay": "3m"
        · }
        · }
        · ]
        · }
        · }
        · ]
        · }
        · },
        · "id": 1
       }

Font

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

Documentation