hostgroup.delete

説明

object hostgroup.delete(array hostGroupIds)

このメソッドを使用すると、ホストグループを削除できます。

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

  • そのグループにのみ所属しているホストが含まれている場合
  • 内部用としてマークされている場合
  • ホストプロトタイプで使用されている場合
  • グローバルスクリプトで使用されている場合
  • 相関条件で使用されている場合

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

パラメーター

(array) 削除するホストグループのID。

戻り値

(object) groupidsプロパティの下にある削除されたホストグループのIDを含むオブジェクトを返します。

例

複数のホストグループの削除

2つのホストグループを削除します。

リクエスト:

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

レスポンス:

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

ソース

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