このページで
configuration.import
説明
boolean configuration.import(object parameters)
このメソッドは、シリアル化された文字列から設定データをインポートすることができます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(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 | ホストまたはテンプレートの value map をインポートする方法に関するルールです。 サポートされるパラメータ: createMissing - (boolean) true に設定すると、新しい value map が作成されます。既定値: false;updateExisting - (boolean) true に設定すると、既存の value map が更新されます。既定値: false;deleteMissing - (boolean) true に設定すると、インポートされたデータに存在しない value map がデータベースから削除されます。既定値: 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>7.4</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
}
Response:
{
"jsonrpc": "2.0",
"result": true,
"id": 1
}
ソース
CConfiguration::import() in ui/include/classes/api/services/CConfiguration.php.