This is a translation of the original English documentation page. Help us make it better.

hostgroup.delete

説明

object hostgroup.delete(array hostGroupIds)

このメソッドでは、host group を削除することができます。

以下の場合、ホストグループを削除することはできません。

  • このグループに属するホストのみが含まれている。
  • 内部グループとしてマークされている。
  • ホストプロトタイプで使用されている。
  • グローバルスクリプトで使用されている。
  • 相関関係で使用されている。

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

パラメータ

(array) 削除する host group のID配列

戻り値

(object) groupids プロパティの下にある、削除された host group のIDを含むオブジェクトを返す。

複数の host group を削除する

2つの host group を削除します。

Request:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.delete",
           "params": [
               "107824",
               "107825"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "groupids": [
                   "107824",
                   "107825"
               ]
           },
           "id": 1
       }

ソース

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