2022 Zabbix中国峰会
2022 Zabbix中国峰会

configuration.import

描述

boolean configuration.import(object parameters)

此方法允许从序列化的字符串导入配置数据。

此方法适用于所有类型的用户。 可以在用户角色设置中撤销调用此方法的权限。 有关更多信息,请参阅用户角色

参数

(object) 包含要导入的数据以及如何处理数据的规则。

参数 类型说明 描述
format
(必需)
string 序列化字符串的格式。

可能的值:
yaml - YAML格式;
xml - XML格式;
json - JSON格式。
source
(必需)
string 包含配置数据的序列化字符串。
rules
(必需)
object 关于如何导入新对象和现有对象的规则。

rules 参数在下面的表格中有详细描述。

如果没有给出规则,配置将不会被更新。

rules 对象支持以下参数。

参数 类型说明 描述
discoveryRules object 关于如何导入LLD规则的规则。

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

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

支持的参数:
createMissing - (boolean) 如果设置为 true,则会创建缺失的主机组;默认:false
updateExisting - (boolean) 如果设置为 true,则会更新现有的主机组;默认:false
hosts object 主机导入规则。

支持的参数:
createMissing - (boolean) 如果设置为 true,则会创建新的主机;默认:false
updateExisting - (boolean) 如果设置为 true,则会更新现有的主机;默认:false
httptests object Web场景导入规则。

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

支持的参数:
createMissing - (boolean) 如果设置为 true,则会创建新的图像;默认:false
updateExisting - (boolean) 如果设置为 true,则会更新现有的图像;默认:false
items object 监控项导入规则。

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

支持的参数:
createMissing - (boolean) 如果设置为 true,则会创建新的地图;默认:false
updateExisting - (boolean) 如果设置为 true,则会更新现有的地图;默认:false
mediaTypes object 媒体类型导入规则。

支持的参数:
createMissing - (boolean) 如果设置为 true,则会创建新的媒体类型;默认:false
updateExisting - (boolean) 如果设置为 true,则会更新现有的媒体类型;默认:false
templateLinkage object 模板链接导入规则。

支持的参数:
createMissing - (boolean) 如果设置为 true,则会链接导入数据中存在但未链接到主机或模板的模板;默认:false
deleteMissing - (boolean) 如果设置为 true,则会取消链接主机或模板导入中不存在但链接自已链接模板的模板,且不会删除从取消链接的模板继承的实体(监控项、触发器等);默认:false
templates object 模板导入规则。

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

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

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

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

返回值

(boolean)如果导入成功将返回 true

示例

导入模板

导入XML字符串中包含的模板配置。 如果XML字符串中的任何监控项或触发器缺失,它们将从数据库中删除,其他所有内容将保持不变。

请求:

{
           "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>6.0</version><date>2023-01-01T12:00: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></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"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

源码

CConfiguration::import() 在 ui/include/classes/api/services/CConfiguration.php 文件中。