configuration.importcompare

説明

array configuration.importcompare(object parameters)

このメソッドは、インポートファイルを現在のシステム要素と比較し、このインポートファイルがインポートされる場合に何が変更されるかを表示することができます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメータ

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

パラメータ 型 説明
format string シリアライズされた文字列のフォーマット。

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

パラメータの動作:
- 必須
source string 設定データを含むシリアライズされた文字列。

パラメータの動作:
- 必須
rules object 新規および既存オブジェクトをどのように比較するかのルール。

Admin および User タイプのユーザーは、読み取り専用 または 読み書き の権限を持つ既存のオブジェクトとのみ新規オブジェクトを比較できます。

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。
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。

このパラメータは出力に影響しません。configuration.importとの整合性のためにのみ許可されています。
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。

このパラメータは出力に影響しません。configuration.importとの整合性のためにのみ許可されています。
items object アイテムのインポート方法のルール。

サポートされるパラメータ:
createMissing - (boolean) trueの場合、新しいアイテムが作成されます。デフォルト: false;
updateExisting - (boolean) trueの場合、既存のアイテムが更新されます。デフォルト: false;
deleteMissing - (boolean) trueの場合、インポートデータに存在しないアイテムがデータベースから削除されます。デフォルト: false。
maps object マップのインポート方法のルール。

サポートされるパラメータ:
createMissing - (boolean) trueの場合、新しいマップが作成されます。デフォルト: false;
updateExisting - (boolean) trueの場合、既存のマップが更新されます。デフォルト: false。

このパラメータは出力に影響しません。configuration.importとの整合性のためにのみ許可されています。
mediaTypes object メディアタイプのインポート方法のルール。

サポートされるパラメータ:
createMissing - (boolean) trueの場合、新しいメディアタイプが作成されます。デフォルト: false;
updateExisting - (boolean) trueの場合、既存のメディアタイプが更新されます。デフォルト: false。

このパラメータは出力に影響しません。configuration.importとの整合性のためにのみ許可されています。
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。

戻り値

(array) 行われる設定の変更を含む配列を返します。

例

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

XML文字列に含まれるテンプレートを現在のシステム要素と比較し、このテンプレートをインポートした場合に何が変更されるかを表示します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "configuration.importcompare",
    "params": {
        "format": "xml",
        "rules": {
            "discoveryRules": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            },
            "graphs": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            },
            "host_groups": {
                "createMissing": true,
                "updateExisting": true
            },
            "template_groups": {
                "createMissing": true,
                "updateExisting": true
            },
            "httptests": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            },
            "items": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            },
            "templateLinkage": {
                "createMissing": true,
                "deleteMissing": true
            },
            "templates": {
                "createMissing": true,
                "updateExisting": true
            },
            "templateDashboards": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            },
            "triggers": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            },
            "valueMaps": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            }
        },
        "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><delay>3m</delay></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>648006da5971424ead0c47ddbbf1ea2e</uuid><name>CPU utilization</name><key>system.cpu.util</key><value_type>FLOAT</value_type><units>%</units><triggers><trigger><uuid>736225012c534ec480c2a66a91322ce0</uuid><expression>avg(/New template/system.cpu.util,3m)&gt;70</expression><name>CPU utilization 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"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "templates": {
            "updated": [
                {
                    "before": {
                        "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
                        "template": "New template",
                        "name": "New template",
                        "groups": [
                            {
                                "name": "Templates"
                            }
                        ]
                    },
                    "after": {
                        "uuid": "5aef0444a82a4d8cb7a95dc4c0c85330",
                        "template": "New template",
                        "name": "New template",
                        "groups": [
                            {
                                "name": "Templates"
                            }
                        ]
                    },
                    "items": {
                        "added": [
                            {
                                "after": {
                                    "uuid": "648006da5971424ead0c47ddbbf1ea2e",
                                    "name": "CPU utilization",
                                    "key": "system.cpu.util",
                                    "value_type": "FLOAT",
                                    "units": "%"
                                },
                                "triggers": {
                                    "added": [
                                        {
                                            "after": {
                                                "uuid": "736225012c534ec480c2a66a91322ce0",
                                                "expression": "avg(/New template/system.cpu.util,3m)>70",
                                                "name": "CPU utilization too high on 'New host' for 3 minutes",
                                                "priority": "WARNING"
                                            }
                                        }
                                    ]
                                }
                            }
                        ],
                        "removed": [
                            {
                                "before": {
                                    "uuid": "6805d4c39a624a8bab2cc8ab63df1ab3",
                                    "name": "CPU load",
                                    "key": "system.cpu.load",
                                    "value_type": "FLOAT"
                                },
                                "triggers": {
                                    "removed": [
                                        {
                                            "before": {
                                                "uuid": "ab4c2526c2bc42e48a633082255ebcb3",
                                                "expression": "avg(/New template/system.cpu.load,3m)>2",
                                                "name": "CPU load too high on 'New host' for 3 minutes",
                                                "priority": "WARNING"
                                            }
                                        }
                                    ]
                                }
                            }
                        ],
                        "updated": [
                            {
                                "before": {
                                    "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
                                    "name": "Zabbix agent ping",
                                    "key": "agent.ping"
                                },
                                "after": {
                                    "uuid": "7f1e6f1e48aa4a128e5b6a958a5d11c3",
                                    "name": "Zabbix agent ping",
                                    "key": "agent.ping",
                                    "delay": "3m"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    },
    "id": 1
}

ソース

CConfiguration::importcompare() in ui/include/classes/api/services/CConfiguration.php.