configuration.import

説明

boolean configuration.import(object parameters)

このメソッドを使用すると、シリアライズされた文字列から設定データをインポートできます。

このメソッドは、あらゆる種類のユーザーが利用できます。 このメソッドの呼び出し権限は、ユーザーロール設定で取り消すことができます。 詳細は User roles を参照してください。

パラメーター

(object) インポートするデータと、そのデータをどのように処理するかのルールを含むパラメーターです。

Parameter Type Description
format string シリアライズされた文字列の形式です。

指定可能な値:
yaml - YAML;
xml - XML;
json - JSON.

Parameter behavior:
- required
source string 設定データを含むシリアライズされた文字列です。

Parameter behavior:
- required
rules object 新規オブジェクトおよび既存オブジェクトをどのようにインポートするかのルールです。

Admin タイプのユーザーは、read-write permission を持つオブジェクトとマップのみをインポートできます。たとえば、ホストとそのエンティティー(アイテム、トリガー、グラフなど)は、インポートされるホストが属するホストグループに対してユーザーのユーザーグループが権限を持っている場合にのみインポートできます。画像とメディアタイプは、Admin タイプのユーザーはインポートできません。

rules パラメーターの詳細は、以下の表で説明します。

Parameter behavior:
- required
returnMissingObjects boolean レスポンスオブジェクトに不足しているオブジェクトの情報を含めるかどうかのルールです。デフォルト: false

ルールが指定されていない場合、設定は更新されません。

rules オブジェクトは、次のパラメーターをサポートします。

Parameter Type Description
dashboards object ダッシュボードをどのようにインポートするかのルールです。

サポートされるパラメーター:
createMissing - (boolean) true に設定すると、新しいダッシュボードが作成されます。デフォルト: false;
updateExisting - (boolean) true に設定すると、システムに存在する特定のインポート可能なダッシュボードが完全に更新されます。ページとウィジェットは新しい内容で完全に上書きされます。デフォルト: false
discoveryRules object LLD ルールをどのようにインポートするかのルールです。

サポートされるパラメーター:
createMissing - (boolean) true に設定すると、新しい LLD ルールが作成されます。デフォルト: false;
updateExisting - (boolean) true に設定すると、既存の LLD ルールが更新されます。デフォルト: false;
deleteMissing - (boolean) true に設定すると、インポートされたデータに存在しない LLD ルールがデータベースから削除されます。デフォルト: false
global_regexes object グローバル正規表現をどのようにインポートするかのルールです。

サポートされるパラメーター:
createMissing - (boolean) true に設定すると、新しいグローバル正規表現が作成されます。デフォルト: false;
updateExisting - (boolean) true に設定すると、既存のグローバル正規表現が更新され、そのサブ式は完全に上書きされます。デフォルト: 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
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
templateDashboards object テンプレートダッシュボードをどのようにインポートするかのルールです。

サポートされるパラメーター:
createMissing - (boolean) true に設定すると、新しいテンプレートダッシュボードが作成されます。デフォルト: false;
updateExisting - (boolean) true に設定すると、既存のテンプレートダッシュボードが更新されます。デフォルト: false;
deleteMissing - (boolean) true に設定すると、インポートされたデータに存在しないテンプレートダッシュボードがデータベースから削除されます。デフォルト: false
template_groups 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
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>8.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() in ui/include/classes/api/services/CConfiguration.php.