host.massremove

説明

object host.massremove(object parameters)

このメソッドでは、複数のホストから関連オブジェクトを削除できます。

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

パラメータ

(object) 更新するホストのIDと、削除する必要があるオブジェクトを含むパラメータです。

パラメータ Type 説明
hostids ID/array 更新するホストのIDです。

パラメータの動作:
- 必須
groupids ID/array 指定したホストを削除するホストグループのIDです。
interfaces object/array 指定したホストから削除するホストインターフェースです。

ホストインターフェースオブジェクトでは、ip、dns、port プロパティのみを定義する必要があります。
macros string/array 指定したホストから削除するユーザーマクロです。
templateids ID/array 指定したホストからリンク解除するテンプレートのIDです。
templateids_clear ID/array 指定したホストからリンク解除してクリアするテンプレートのIDです。

戻り値

(object) hostids プロパティの下で更新されたホストの ID を含むオブジェクトを返します。

例

テンプレートのリンク解除

2つのホストからテンプレートのリンクを解除し、テンプレート化されたすべてのエンティティを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "host.massremove",
    "params": {
        "hostids": ["69665", "69666"],
        "templateids_clear": "325"
    },
    "id": 1
}

レスポンス:

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

関連項目

ソース

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