Zabbix Documentation 3.4

Sidebar

configuration.import

Description 说明

boolean configuration.import(object parameters)

This method allows to import configuration data from a serialized string.此方法允许作为序列化字符串导入配置数据。

Parameters参数

(object) Parameters containing the data to import and rules how the data should be handled.参数包含导入的数据以及如何处理数据的规则。

参数 类 说明
format
(required)(必须)
string
Format of the serialized string. 序列化字符串的格式。
Possible values: 可能的值为:
json - JSON;
xml - XML.
source
(required)(必须)
string Serialized string containing the configuration data. 序列化字符串包含的配置数据。
rules
(required) (必须)
object
Rules on how new and existing objects should be imported. 关于将新的和已有的对象 应该如何导入的规则。
The rules parameter is described in detail in the table below. 参数在下表详细描述。

If no rules are given, the configuration will not be updated.如果没有给定规则,配置将不会被更新。

The rules object supports the following parameters.对象提供以下参数。

参数 类 说明
applications object Rules on how to import applications.关于如何导入应用集的规则。

Supported parameters: 支持的参数:
createMissing - (boolean) if set to true, new applications will be created; default: false;如果设置为true,新的应用集将会被创建;默认:false;
deleteMissing - (boolean) if set to true, applications not present in the imported data will be deleted from the database; default: false. 如果设置为true,不在导入数据中的应用集将会从数据库中被删除;默认:false。
discoveryRules object Rules on how to import LLD rules.关于如何导入底层自动发现规则的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new LLD rules will be created; default: false;如果设置为true,新的底层自动发现规则将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing LLD rules will be updated; default: false; 如果设置为true,已有的底层自动发现规则将会被更新;默认:false;
deleteMissing - (boolean) if set to true, LLD rules not present in the imported data will be deleted from the database; default: false.如果设置为true,不在导入数据中的底层自动发现规则将会从数据库中被删除;默认false。
graphs object Rules on how to import graphs.关于如何导入图表的规则。

Supported parameters: 支持的参数:
createMissing - (boolean) if set to true, new graphs will be created; default: false; 新的图表将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing graphs will be updated; default: false;如何设置为true,已有的图表将会被更新;默认:false;
deleteMissing - (boolean) if set to true, graphs not present in the imported data will be deleted from the database; default: false. 如果设置为true,不在导入数据中的图表将会从数据库中被删除;默认:false。
groups object Rules on how to import host groups.关于如何导入主机组的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new host groups will be created; default: false. 如果设置为true,新的主机组将会被创建;默认:false。
hosts object Rules on how to import hosts.关于如何导入主机的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new hosts will be created; default: false; 如果设置为true,新的主机将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing hosts will be updated; default: false. 如果设置为true,已有的主机将会被更新;默认:false。
images object Rules on how to import images.关于如何导入图片的规则。

Supported parameters: 支持的参数:
createMissing - (boolean) if set to true, new images will be created; default: false; 如果设置为true,新的图片将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing images will be updated; default: false.如果设置为true,已有的图片将会被创建;默认:false。
items object Rules on how to import items. 关于如何导入监控项的规则。

Supported parameters: 支持的参数:
createMissing - (boolean) if set to true, new items will be created; default: false; 如果设置为true,新的监控项将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing items will be updated; default: false;如果设置为true,已有的监控项将会被更新;默认:false;
deleteMissing - (boolean) if set to true, items not present in the imported data will be deleted from the database; default: false. 如果设置为true,不在导入数据中的监控项将会从数据库中被删除;默认:false。
maps object Rules on how to import maps. 关于如何导入拓扑图的规则

Supported parameters: 支持的参数:
createMissing - (boolean) if set to true, new maps will be created; default: false; 如果设置为true,新的拓扑图将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing maps will be updated; default: false. 如果设置为true,已有的拓扑图将会被更新;默认:false。
screens object Rules on how to import screens. 关于如何导入屏幕的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new screens will be created; default: false; 如果设置为true,新的屏幕将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing screens will be updated; default: false.如果设置为true,已有的屏幕将会被更新;默认:false。
templateLinkage object Rules on how to import template links.关于如何导入模板链接的规则。

Supported parameters: 支持的参数:
createMissing - (boolean) if set to true, new links between templates and host will be created; default: false. .如果设置为true,新的连接模板和主机的链接将会被创建;默认:false。
templates object Rules on how to import templates.关于如何导入模板的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new templates will be created; default: false;如果设置为true,新的模板将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing templates will be updated; default: false. 如果设置为true,已有的模板将会被更新;默认:false。
templateScreens object Rules on how to import template screens. 关于如何导入屏幕模板的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new template screens will be created; default: false; 如果设置为true,新的屏幕模板将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing template screens will be updated; default: false; 如果设置为true,已有的屏幕模板将会被更新;默认:false;
deleteMissing - (boolean) if set to true, template screens not present in the imported data will be deleted from the database; default: false.如果设置为true,不在导入数据中的屏幕模板将会在数据库中被删除;默认:false。
triggers object Rules on how to import triggers.关于如何导入触发器的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new triggers will be created; default: false; 如果设置为true,新的触发器将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing triggers will be updated; default: false; 如果设置为true,已有的触发器将会被更新;默认:false;
deleteMissing - (boolean) if set to true, triggers not present in the imported data will be deleted from the database; default: false.如果设置为true,不在导入数据中的触发器将会在数据库中被删除;默认:false;
valueMaps object Rules on how to import value maps. 关于如何导入植映射的规则。

Supported parameters:支持的参数:
createMissing - (boolean) if set to true, new value maps will be created; default: false; 如果设置为true,新的植映射将会被创建;默认:false;
updateExisting - (boolean) if set to true, existing value maps will be updated; default: false. 如果设置为true,已有的植映射将会被更新;默认:false。

Return values 返回值

(boolean) Returns true if importing has been successful.如果导入成功则返回true。

Examples范例

Importing hosts and items导入主机和监控项

Import the host and items contained in the XML string. 导入的主机和监控项包含在XML字符串中。 If any items in XML are missing, they will be deleted from the database, and everything else will be left unchanged.如果在XML中遗漏了任何监控项,这些监控项将会在数据库中被删除,其他的则不改变。

Request:

{
           "jsonrpc": "2.0",
           "method": "configuration.import",
           "params": {
               "format": "xml",
               "rules": {
                   "hosts": {
                       "createMissing": true,
                       "updateExisting": true
                   },
                   "items": {
                       "createMissing": true,
                       "updateExisting": true,
                       "deleteMissing": true
                   }
               },
               "source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><zabbix_export><version>3.4</version><date>2012-04-18T11:20:14Z</date><groups><group><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><description/><proxy/><status>0</status><ipmi_authtype>-1</ipmi_authtype><ipmi_privilege>2</ipmi_privilege><ipmi_username/><ipmi_password/><tls_connect>1</tls_connect><tls_accept>1</tls_accept><tls_issuer/><tls_subject/><tls_psk_identity/><tls_psk/><templates/><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><default>1</default><type>1</type><useip>1</useip><ip>127.0.0.1</ip><dns/><port>10050</port><bulk>1</bulk><interface_ref>if1</interface_ref></interface></interfaces><applications><application><name>Application</name></application></applications><items><item><name>Item</name><type>0</type><snmp_community/><snmp_oid/><key>item.key</key><delay>30s</delay><history>90d</history><trends>365d</trends><status>0</status><value_type>3</value_type><allowed_hosts/><units/><snmpv3_contextname/><snmpv3_securityname/><snmpv3_securitylevel>0</snmpv3_securitylevel><snmpv3_authprotocol>0</snmpv3_authprotocol><snmpv3_authpassphrase/><snmpv3_privprotocol>0</snmpv3_privprotocol><snmpv3_privpassphrase/><params/><ipmi_sensor/><authtype>0</authtype><username/><password/><publickey/><privatekey/><port/><description/><inventory_link>0</inventory_link><applications><application><name>Application</name></application></applications><valuemap><name>Host status</name></valuemap><logtimefmt/><preprocessing/><interface_ref>if1</interface_ref></item></items><discovery_rules/><macros/><inventory/></host></hosts><triggers><trigger><expression>{Export host:item.key.last()}=0</expression><name>Trigger</name><url/><status>0</status><priority>2</priority><description>Host trigger</description><type>0</type><recovery_mode>1</recovery_mode><recovery_expression>{Export host:item.key.last()}=2</recovery_expression><dependencies/><tags/><correlation_mode>1</correlation_mode><correlation_tag>Tag 01</correlation_tag><manual_close>0</manual_close></trigger></triggers><graphs><graph><name>Graph</name><width>900</width><height>200</height><yaxismin>0.0000</yaxismin><yaxismax>100.0000</yaxismax><show_work_period>1</show_work_period><show_triggers>1</show_triggers><type>0</type><show_legend>1</show_legend><show_3d>0</show_3d><percent_left>0.0000</percent_left><percent_right>0.0000</percent_right><ymin_type_1>0</ymin_type_1><ymax_type_1>0</ymax_type_1><ymin_item_1>0</ymin_item_1><ymax_item_1>0</ymax_item_1><graph_items><graph_item><sortorder>0</sortorder><drawtype>0</drawtype><color>C80000</color><yaxisside>0</yaxisside><calc_fnc>7</calc_fnc><type>0</type><item><host>Export host</host><key>item.key</key></item></graph_item></graph_items></graph></graphs><value_maps><value_map><name>Host status</name><mappings><mapping><value>0</value><newvalue>Up</newvalue></mapping><mapping><value>2</value><newvalue>Unreachable</newvalue></mapping></mappings></value_map></value_maps></zabbix_export>"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

Source 来源

CConfiguration::import() in frontends/php/include/classes/api/services/CConfiguration.php.