configuration.import

描述

boolean configuration.import(object parameters)

此方法允许从序列化的 string 中 import 配置数据。

此方法可供任何类型的用户使用。 调用该方法的权限可以在用户角色设置中撤销。 更多信息请参见 User roles。

参数

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

Parameter Type Description
format string 序列化字符串的格式。

可能的值：
yaml - YAML；
xml - XML；
json - JSON。

参数行为：
- required
source string 包含配置数据的序列化字符串。

参数行为：
- required
rules object 关于如何导入新对象和现有对象的规则。

Admin 类型用户只能导入其具有 read-write 权限的对象，以及地图。例如，只有当用户组对将要归属该导入主机的主机组具有权限时，才能导入主机及其实体（监控项、触发器、图形等）。Admin 类型用户不能导入图像和媒体类型。

rules 参数的详细说明见下表。

参数行为：
- required

如果未给出任何规则，则不会更新配置。

rules 对象支持以下参数。

Parameter Type Description
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。
host_groups object 关于如何导入主机组的规则。

支持的参数：
createMissing - (boolean) 如果设为 true，将创建新的主机组；默认值：false；
updateExisting - (boolean) 如果设为 true，将更新现有的主机组；默认值：false。
template_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 文件中的模板配置 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>&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>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)&gt;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
}

响应：

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

来源

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