hostgroup.massremove

説明

object hostgroup.massremove(object parameters)

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

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

パラメータ

(object) 更新するホストグループのIDと、 削除するオブジェクトを含むパラメータ。

パラメータ Type 説明
groupids ID/array 更新するホストグループのID。

パラメータの動作:
- 必須
hostids ID/array すべてのホストグループから削除するホストのID。

戻り値

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

例

ホストグループからのホストの削除

指定されたホストグループから2つのホストを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.massremove",
    "params": {
        "groupids": [
            "5",
            "6"
        ],
        "hostids": [
            "30050",
            "30001"
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "groupids": [
            "5",
            "6"
        ]
    },
    "id": 1
}

ソース

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