Documentation
configuration.import
描述
boolean configuration.import(object parameters)
此方法允许从序列化的 string 中 import 配置数据。
此方法可供任何类型的用户使用。 调用该方法的权限可以在用户角色设置中撤销。 更多信息请参见 User roles。
参数
(object) 包含用于import的数据参数以及数据处理规则的参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| format | string | 序列化string的格式. 可选值: yaml - YAML;xml - XML;json - JSON.参数行为: - 必填 |
| source | string | 包含配置数据的序列化string。 参数行为: - 必填 |
| rules | object | 关于如何导入新旧objects的规则. Admin类型用户仅能import其拥有读写权限permission的objects及地图. 例如, 只有当用户所在用户组对导入主机所属的主机组具有权限时, 才能导入一个主机及其关联实体(监控项, 触发器, 图形等). Admin类型用户无法导入图片和媒体类型. 下表详细描述了 rules参数.参数行为: - 必填 |
如果没有给出规则，配置将不会更新。
rules object 支持以下参数.
| 参数 | 数据类型 | 描述 |
|---|---|---|
| discoveryRules | object | 关于如何import LLD规则的规范. 支持的参数: createMissing - 若设为true则创建新的LLD规则，类型为(boolean)；默认值：false；updateExisting - 若设为true则更新现有LLD规则，类型为(boolean)；默认值：false；deleteMissing - 若设为true则删除数据库中未出现在导入数据中的LLD规则，类型为(boolean)；默认值：false. |
| graphs | object | 关于如何import图表的规则. 支持的参数: createMissing - (boolean) 如果设置为true, 将创建新图表; 默认值: false;updateExisting - (boolean) 如果设置为true, 将更新现有图表; 默认值: false;deleteMissing - (boolean) 如果设置为true, 导入数据中不存在的图表将从数据库中删除; 默认值: false. |
| host_groups | object | 关于如何import主机组的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的主机组；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的主机组；默认值：false。 |
| template_groups | object | 关于如何import模板组的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的模板组；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的模板组；默认值：false。 |
| hosts | object | 关于如何import主机的规则. 支持的参数: createMissing - (boolean) 如果设置为true，将创建新的主机；默认值: false;updateExisting - (boolean) 如果设置为true，将更新现有的主机；默认值: false. |
| httptests | object | 关于如何import网络场景的规则。 支持的参数: createMissing - (boolean) 如果设置为true，将创建新的网络场景；默认值: false;updateExisting - (boolean) 如果设置为true，将更新现有的网络场景；默认值: false;deleteMissing - (boolean) 如果设置为true，导入数据中不存在的网络场景将从数据库中删除；默认值: false。 |
| images | object | 关于如何import图像的规则。 支持的参数: createMissing - (boolean) 如果设置为true，将创建新图像；默认值: false;updateExisting - (boolean) 如果设置为true，将更新现有图像；默认值: false。 |
| items | object | 关于如何import监控项的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新的监控项；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有的监控项；默认值：false；deleteMissing - (boolean) 如果设置为true，将从数据库中删除导入数据中不存在的监控项；默认值：false。 |
| maps | object | 关于如何import地图的规则。 支持的参数： createMissing - (boolean) 如果设置为true，将创建新地图；默认值：false；updateExisting - (boolean) 如果设置为true，将更新现有地图；默认值：false。 |
| mediaTypes | object | 关于如何import媒体类型的规则。 支持的参数: createMissing - (boolean) 如果设置为true，将创建新的媒体类型；默认值: false;updateExisting - (boolean) 如果设置为true，将更新现有媒体类型；默认值: false。 |
| templateLinkage | object | 关于如何import模板链接的规则. 支持的参数: createMissing - 如果设置为true，则(boolean)会将未链接到主机或正在导入的模板、但存在于导入数据中的模板进行链接；默认值: false;deleteMissing - 如果设置为true，则(boolean)会将链接到主机或正在导入的模板、但不存在于导入数据中的模板解除链接，同时保留从已解除链接模板继承的实体（监控项、触发器等等）；默认值: 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 - (boolean)如果设置为true，将创建新的值映射；默认：false；updateExisting - (boolean)如果设置为true，将更新现有的值映射；默认：false；deleteMissing - (boolean)如果设置为true，导入数据中不存在的值映射将从数据库中删除；默认：false。 |
返回值
(boolean) 如果导入成功则返回 true。
示例
导入模板
导入包含在 XML 文件中的模板配置 string。 如果 XML string 中的任何 监控项 或触发器缺失，它们将从数据库中被删除，其他所有内容将保持不变。
执行请求:
{
"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 {HOST.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
}响应：
来源
CConfiguration::import() 在 ui/include/classes/api/services/CConfiguration.php 中。