configuration.importcompare

描述

array configuration.importcompare(object parameters)

此方法允许将import file与当前系统元素进行比较,并显示导入该import file时将发生的变更。

该方法对所有类型用户可用。 调用该方法的权限可在用户角色设置中撤销。 更多信息请参阅User roles

参数

(object) 包含可能数据以import的参数及数据应如何处理的相关规则。

参数 数据类型 描述
format
(required)
string 序列化string的格式.

可选值:
yaml - YAML;
xml - XML;
json - JSON.
source
(required)
string 包含配置数据的序列化string。
rules
(required)
object 关于如何导入新旧objects的规则.

管理员普通用户类型用户仅可将新objects与已拥有只读读写权限permission的现有条目进行对比.

rules参数详情如下表所述.

如果没有给出规则,将无法update,结果将为空。

仅针对主机组和模板进行比较。 触发器与图形仅会针对导入的模板进行比较,其他任何内容都将被视为"新增"。

rules object 支持以下参数.

参数 数据类型 描述
discoveryRules object 关于如何import LLD规则的规范.

支持的参数:
createMissing - (boolean) 如果设置为true, 将创建新的LLD规则; 默认值: false;
updateExisting - (boolean) 如果设置为true, 将更新现有的LLD规则; 默认值: false;
deleteMissing - (boolean) 如果设置为true, 将从数据库中删除导入数据中不存在的LLD规则; 默认值: false.
graphs object 关于如何import图表的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新图表;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有图表;默认值: false;
deleteMissing - (boolean) 如果设置为true,导入数据中不存在的图表将从数据库中删除;默认值: false
groups object 关于如何import主机组的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新的主机组;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有的主机组;默认值: false
hosts object 关于如何import主机的规则.

支持的参数:
createMissing - (boolean) 如果设置为true, 将创建新的主机; 默认值: false;
updateExisting - (boolean) 如果设置为true, 将更新现有的主机; 默认值: false.

此参数不会对输出产生影响. 仅为了与configuration.import保持一致而允许使用.
httptests object 关于如何importWeb场景的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新的Web场景;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有的Web场景;默认值: false;
deleteMissing - (boolean) 如果设置为true,将从数据库中删除导入数据中不存在的Web场景;默认值: false
images object 关于如何import图像的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新图像;默认值:false
updateExisting - (boolean) 如果设置为true,将更新现有图像;默认值:false

此参数不会对输出产生任何影响。仅为了与configuration.import保持一致而允许使用。
items object 关于如何import监控项的规则。

支持的参数:
createMissing - 如果设置为true(boolean),将创建新的监控项;默认值: false;
updateExisting - 如果设置为true(boolean),将更新现有的监控项;默认值: false;
deleteMissing - 如果设置为true(boolean),将从数据库中删除导入数据中不存在的监控项;默认值: false
maps object 关于如何import地图的规则.

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新地图;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有地图;默认值: false.

此参数不会影响输出。仅为了与configuration.import保持一致而允许使用。
mediaTypes object 关于如何import媒介类型的规则.

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新的媒介类型;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有媒介类型;默认值: false.

此参数不会影响输出。仅为了与configuration.import保持一致而允许使用。
templateLinkage object 关于如何import模板链接的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,则未链接到主机或正在导入的模板,但存在于导入数据中的模板将被链接;默认值:false
deleteMissing - (boolean) 如果设置为true,则链接到主机或正在导入的模板,但未出现在导入数据中的模板将被取消链接,而不会移除从未链接模板继承的实体(监控项、触发器等);默认值:false
templates object 关于如何import模板的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新模板;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有模板;默认值: false
templateDashboards object 关于如何import模板仪表板的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新的模板仪表板;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有的模板仪表板;默认值: false;
deleteMissing - (boolean) 如果设置为true,将从数据库中删除导入数据中不存在的模板仪表板;默认值: false
triggers object 关于如何import触发器的规则。

支持的参数:
createMissing - (boolean) 如果设置为true,将创建新触发器;默认值: false;
updateExisting - (boolean) 如果设置为true,将更新现有触发器;默认值: false;
deleteMissing - (boolean) 如果设置为true,将从数据库中删除导入数据中不存在的触发器;默认值: false
valueMaps object 关于如何import主机或模板值映射的规则.

支持的参数:
createMissing - 如果设置为true(boolean),将创建新的值映射;默认值: false;
updateExisting - 如果设置为true(boolean),将更新现有的值映射;默认值: false;
deleteMissing - 如果设置为true(boolean),导入数据中不存在的值映射将从数据库中删除;默认值: false.

返回值

(array) 返回一个包含待执行配置变更的array

示例

比较模板导入

将XML string中包含的模板与当前系统元素进行比较, 并显示如果导入此模板将会发生哪些变更。

请求:

{
           "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>&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>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)&gt;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
       }

响应:

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

来源

CConfiguration::importcompare() 位于 ui/include/classes/api/services/CConfiguration.php 文件中。