hostinterface.massadd

説明

object hostinterface.massadd(object parameters)

このメソッドを使用すると、複数のホストにホストインターフェースを同時に追加できます。

このメソッドは、Admin および Super admin ユーザータイプでのみ使用できます。
このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳細は、ユーザーロールを参照してください。

パラメータ

指定されたホスト上に作成するホストインターフェースを含む(object)パラメータです。

このメソッドは以下のパラメータを受け付けます。

パラメータ Type 説明
interfaces object/array 指定されたホスト上に作成するホストインターフェース。

パラメータの動作:
- 必須
hosts object/array 更新対象のホスト。

ホストでは hostid プロパティのみを定義する必要があります。

パラメータの動作:
- 必須

戻り値

(object) interfaceidsプロパティの下で作成されたホストインターフェイスのIDを含むオブジェクトを返します。

例

インターフェースの作成

2つのホストにインターフェースを作成します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostinterface.massadd",
    "params": {
        "hosts": [
            {
                "hostid": "30050"
            },
            {
                "hostid": "30052"
            }
        ],
        "interfaces": {
            "dns": "",
            "ip": "127.0.0.1",
            "main": 0,
            "port": "10050",
            "type": 1,
            "useip": 1
        }
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "interfaceids": [
            "30069",
            "30070"
        ]
    },
    "id": 1
}

参照

ソース

CHostInterface::massAdd() in ui/include/classes/api/services/CHostInterface.php.