hostinterface.massremove

説明

object hostinterface.massremove(object parameters)

このメソッドでは、指定されたホストからホストインターフェースを削除できます。

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

パラメータ

更新するホストのIDと、削除するインターフェースを含む (object) パラメータです。

パラメータ Type 説明
interfaces object/array 指定したホストから削除するホストインターフェース。

ホストインターフェースオブジェクトでは、ip、dns、port プロパティのみを定義する必要があります。

パラメータの動作:
- 必須
hostids ID/array 更新するホストのID。

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

戻り値

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

例

インターフェースの削除

2つのホストから "127.0.0.1" のSNMPインターフェースを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostinterface.massremove",
    "params": {
        "hostids": [
            "30050",
            "30052"
        ],
        "interfaces": {
            "dns": "",
            "ip": "127.0.0.1",
            "port": "161"
        }
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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