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() in ui/include/classes/api/services/CConfiguration.php.

Documentation

configuration.import

説明

パラメーター

戻り値

例

テンプレートのインポート

ソース