Documentation
Table of Contents
configuration.importcompare
Description
array configuration.importcompare(object parameters)
Cette m¨¦thode permet de comparer le fichier d'importation avec les ¨¦l¨¦ments actuels du syst¨¨me et montre ce qui sera chang¨¦ si ce fichier d'importation est import¨¦.
Cette m¨¦thode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la m¨¦thode peuvent ¨ºtre r¨¦voqu¨¦es dans les param¨¨tres du r?le utilisateur. Voir les r?les utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ contenant les donn¨¦es possibles ¨¤ importer et les r¨¨gles de traitement des donn¨¦es.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| format (obligatoire) |
string | Format de la cha?ne s¨¦rialis¨¦e. Valeurs possibles : yaml - YAML;xml - XML;json - JSON. |
| source (obligatoire) |
string | Cha?ne s¨¦rialis¨¦e contenant les donn¨¦es de configuration. |
| rules (obligatoire) |
object | R¨¨gles sur la fa?on dont les objets nouveaux et existants doivent ¨ºtre import¨¦s. Le param¨¨tre rules est d¨¦crit en d¨¦tail dans le tableau ci-dessous. |
Si aucune r¨¨gle n'est donn¨¦e, il n'y aura rien ¨¤ mettre ¨¤ jour et le r¨¦sultat sera vide.
La comparaison sera effectu¨¦e uniquement pour les groupes d'h?tes et les mod¨¨les. Les d¨¦clencheurs et les graphiques seront compar¨¦s uniquement pour les mod¨¨les import¨¦s, tout autre sera consid¨¦r¨¦ comme "nouveau".
L'objet rules prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| discoveryRules | object | R¨¨gles sur la fa?on d'importer les r¨¨gles LLD. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing - (boolean) Si initialis¨¦ ¨¤ true, les nouvelles r¨¨gles LLD seront cr¨¦¨¦es ; par d¨¦faut: false ;updateExisting - (boolean) Si initialis¨¦ ¨¤ true, les r¨¨gles LLD existantes seront mises ¨¤ jour; par d¨¦faut: false ;deleteMissing - (boolean) Si initialis¨¦ ¨¤ true, Les r¨¨gles LLD non pr¨¦sentes dans les donn¨¦es import¨¦es seront supprim¨¦es de la base de donn¨¦es ; par d¨¦faut: false. |
| graphs | object | R¨¨gles sur la fa?on d'importer des graphiques. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing - (boolean) Si initialis¨¦ ¨¤ true, les nouveaux graphiques seront cr¨¦¨¦s ; par d¨¦faut: false ;updateExisting - (boolean) Si initialis¨¦ ¨¤ true, les graphiques existants seront mis ¨¤ jour ; par d¨¦faut: false ;deleteMissing - (boolean) Si initialis¨¦ ¨¤ true, les graphiques non pr¨¦sents dans les donn¨¦es import¨¦es seront supprim¨¦s de la base de donn¨¦es ; par d¨¦faut: false. |
| groups | object | R¨¨gles sur l'importation des groupes d'h?tes. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing - (boolean) Si initialis¨¦ ¨¤ true, les nouveaux groupes d'h?tes seront cr¨¦¨¦s ; par d¨¦faut : false ;updateExisting - (boolean) Si initialis¨¦ ¨¤ true, les groupes d'h?tes existants seront mis ¨¤ jour ; par d¨¦faut: false. |
| hosts | object | R¨¨gles sur la fa?on d'importer des h?tes. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing - (boolean) Si initialis¨¦ ¨¤ true, les nouveaux h?tes seront cr¨¦¨¦s ; par d¨¦faut : false;updateExisting - (boolean) Si initialis¨¦ ¨¤ true, les h?tes existants seront mis ¨¤ jour ; par d¨¦faut: false.Ce param¨¨tre ne fera aucune diff¨¦rence sur la sortie. Il est autoris¨¦ uniquement pour la coh¨¦rence avec configuration.import. |
| httptests | object | R¨¨gles sur la fa?on d'importer des sc¨¦narios Web. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing` - `(boolean)` Si initialis¨¦ ¨¤ `true`, les nouveaux scenarios web seront cr¨¦¨¦s ; par d¨¦faut: `false` ;createMissing-(boolean)Si initialis¨¦ ¨¤true, les nouveaux ¨¦l¨¦ments seront cr¨¦¨¦s ; par d¨¦faut:false;updateExisting-(boolean)Si initialis¨¦ ¨¤true, les ¨¦l¨¦ments existants seront mis ¨¤ jour ; par d¨¦faut:false;deleteMissing-(boolean)Si initialis¨¦ ¨¤true, les ¨¦l¨¦ments non pr¨¦sents dans les donn¨¦es import¨¦es seront supprim¨¦s de la base de donn¨¦es ; par d¨¦faut:false.| |maps|object|R¨¨gles sur la fa?on d'importer des cartes.createMissing-(boolean)Si initialis¨¦ ¨¤true, les nouvelles cartes seront cr¨¦¨¦es ; par d¨¦faut :false;updateExisting-(boolean)Si initialis¨¦ ¨¤true, les cartes existantes seront mises ¨¤ jour ; par d¨¦faut:false.configuration.import.| |mediaTypes|object|R¨¨gles sur la fa?on d'importer des types de m¨¦dias.createMissing-(boolean)Si initialis¨¦ ¨¤true, les nouveaux types de m¨¦dias seront cr¨¦¨¦s ; par d¨¦faut :false;updateExisting-(boolean)Si initialis¨¦ ¨¤true, les types de m¨¦dias existants seront mis ¨¤ jour ; par d¨¦faut:false.configuration.import.| |templateLinkage|object|R¨¨gles sur la fa?on d'importer les liens de mod¨¨les. - (boolean) Si initialis¨¦ ¨¤ true, les nouveaux liens entre mod¨¨les et h?tes seront cr¨¦¨¦s ; par d¨¦faut: false ;deleteMissing - (boolean) Si initialis¨¦ ¨¤ true, les liens non pr¨¦sents dans les donn¨¦es import¨¦es seront supprim¨¦s de la base de donn¨¦es ; par d¨¦faut: false. |
| templates | object | R¨¨gles sur l'importation des mod¨¨les. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing - (boolean) Si initialis¨¦ ¨¤ true, les nouveaux mod¨¨les seront cr¨¦¨¦s ; par d¨¦faut : false ;updateExisting - (boolean) Si initialis¨¦ ¨¤ true, les mod¨¨les existants seront mis ¨¤ jour ; par d¨¦faut: false. |
| templateDashboards | object | R¨¨gles sur la fa?on d'importer des tableaux de bord des mod¨¨les. ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ pris en charge : createMissing` - `(boolean)` Si initialis¨¦ ¨¤ `true`, les nouveaux tableaux de bord seront cr¨¦¨¦s ; par d¨¦faut: `false` ;createMissing-(boolean)Si initialis¨¦ ¨¤true, les nouveaux d¨¦clencheurs seront cr¨¦¨¦s ; par d¨¦faut:false;updateExisting-(boolean)Si initialis¨¦ ¨¤true, les d¨¦clencheurs existants seront mis ¨¤ jour ; par d¨¦faut:false;deleteMissing-(boolean)Si initialis¨¦ ¨¤true, les d¨¦clencheurs non pr¨¦sents dans les donn¨¦es import¨¦es seront supprim¨¦s de la base de donn¨¦es ; par d¨¦faut:false.| |valueMaps|object|R¨¨gles sur la fa?on d'importer des tables de correspondance. - (boolean) Si initialis¨¦ ¨¤ true, les nouvelles tables de correspondance seront cr¨¦¨¦es ; par d¨¦faut: false ;updateExisting - (boolean) Si initialis¨¦ ¨¤ true, les tables de correspondance existantes seront mises ¨¤ jour ; par d¨¦faut: false ;deleteMissing - (boolean) Si initialis¨¦ ¨¤ true, les tables de correspondance non pr¨¦sentes dans les donn¨¦es import¨¦es seront supprim¨¦es de la base de donn¨¦es ; par d¨¦faut: false. |
Valeurs retourn¨¦es
(array) Renvoie un tableau avec les changements de configuration qui seront effectu¨¦s.
Exemples
Comparer l'importation d'un mod¨¨le
Compare le mod¨¨le contenu dans la cha?ne XML aux ¨¦l¨¦ments syst¨¨me actuels, et montre ce qui sera chang¨¦ si ce mod¨¨le est import¨¦.
Requ¨ºte :
{
"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>Áú»¢¶Ä²© 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>Áú»¢¶Ä²© 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
}R¨¦ponse :
{
"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": "Áú»¢¶Ä²© agent ping",
"key": "agent.ping"
},
"after": {
"uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
"name": "Áú»¢¶Ä²© agent ping",
"key": "agent.ping",
"delay": "3m"
}
}
]
}
}
]
}
},
"id": 1
}Source
CConfiguration::importcompare() dans ui/include/classes/api/services/CConfiguration.php.