hostprototype.create

説明

object hostprototype.create(object/array hostPrototypes)

このメソッドは新しいホストプロトタイプを作成します。

このメソッドは管理者およびスーパ管理者ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメーター

(object/array) 作成するホストプロトタイプ。

標準のホストプロトタイププロパティに加えて、このメソッドは以下のパラメーターを受け付けます。

パラメーター 型 説明
groupLinks array ホストプロトタイプに作成するグループリンク。

パラメーターの動作:
- 必須
ruleid ID ホストプロトタイプが属するLLDルールのID。

パラメーターの動作:
- 必須
groupPrototypes array ホストプロトタイプに作成するグループプロトタイプ。
macros object/array ホストプロトタイプに作成するユーザーマクロ。
tags object/array ホストプロトタイプタグ。
interfaces object/array ホストプロトタイプのカスタムインターフェース。
templates object/array ホストプロトタイプにリンクするテンプレート。

テンプレートにはtemplateidプロパティのみが定義されている必要があります。

戻り値

(object) hostidsプロパティの下で作成されたホストプロトタイプのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたホストプロトタイプの順序と一致します。

例

ホストプロトタイプの作成

グループプロトタイプ"{#HV.NAME}"、タグペア"datacenter": "{#DATACENTER.NAME}"、カスタムSNMPv2インターフェース127.0.0.1:161（コミュニティ{$SNMP_COMMUNITY}）を持つLLDルール"23542"上にホストプロトタイプ"{#VM.NAME}"を作成します。ホストグループ"2"にリンクします。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostprototype.create",
    "params": {
        "host": "{#VM.NAME}",
        "ruleid": "23542",
        "custom_interfaces": "1",
        "groupLinks": [
            {
                "groupid": "2"
            }
        ],
        "groupPrototypes": [
            {
                "name": "{#HV.NAME}"
            }
        ],
        "tags": [
            {
                "tag": "datacenter",
                "value": "{#DATACENTER.NAME}"
            }
        ],
        "interfaces": [
            {
                "main": "1",
                "type": "2",
                "useip": "1",
                "ip": "127.0.0.1",
                "dns": "",
                "port": "161",
                "details": {
                    "version": "2",
                    "bulk": "1",
                    "community": "{$SNMP_COMMUNITY}"
                }
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10103"
        ]
    },
    "id": 1
}

参照

ソース

CHostPrototype::create() in ui/include/classes/api/services/CHostPrototype.php.