hostgroup.massremove

説明

object hostgroup.massremove(object parameters)

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

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

パラメータ

(object) 更新する host group の ID と削除するオブジェクトを含むパラメータ

パラメータ Type 説明
groupids
(required)		 string/array IDs of the host groups to be updated.
hostids string/array Hosts to remove from all host groups.
templateids string/array Templates to remove from all host groups.

戻り値

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

例

host group から host を削除する

与えられた host group から 2 つの host を削除します。

Request:

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

Response:

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

ソース

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