Host Local Account Manager Remove Group

Host Local Account Manager Remove Group

Deprecated as of vSphere API 5.1, local user groups are not supported and group specific methods will throw NotSupported.

Removes a local group account.

Required privileges: Host.Local.ManageUserGroups

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/RemoveGroup
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostLocalAccountManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
RemoveGroupRequestType of type(s) application/json
Required 
"RemoveGroupRequestType Object"
string
groupName
Required

Group ID of the group account being removed.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

UserNotFound: if the specified groupName does not exist.

Returns UserNotFound of type(s) application/json 
"UserNotFound Object"
string
principal
Required

Principal value that failed lookup.

boolean
unresolved
Required

Flag to indicate whether or not the lookup was unsuccessful.

A false value indicates that the user does not exist in the directory. A true value indicates that the directory could not be contacted, possibly due to a network error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/RemoveGroup
Deprecated
On This Page
Host Local Account Manager Operations
POST
Host Local Account Manager Assign User To Group
Deprecated
POST
Host Local Account Manager Change Password
POST
Host Local Account Manager Create Group
Deprecated
POST
Host Local Account Manager Create User
POST
Host Local Account Manager Remove Group
Deprecated
POST
Host Local Account Manager Remove User
POST
Host Local Account Manager Unassign User From Group
Deprecated
POST
Host Local Account Manager Update User