Host Local Account Manager Create Group

Host Local Account Manager Create Group

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

Creates a local group account using the parameters defined in the HostLocalAccountManagerAccountSpecification data object type.

For POSIX hosts, passing the HostLocalAccountManagerPosixAccountSpecification data object type allows you to control the group ID format of the group account being created.

Required privileges: Host.Local.ManageUserGroups

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/CreateGroup
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
CreateGroupRequestType of type(s) application/json
Required
{
    "group": {
        "_typeName": "string",
        "id": "string",
        "password": "string",
        "description": "string"
    }
}
group
Required

This data object type contains common parameters for local account creation.

The password and description properties are not supported for group accounts on POSIX hosts.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

AlreadyExists: if specified local group already exists.

InvalidArgument: if group name is in invalid format.

Returns AlreadyExists of type(s) application/json
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "name": "string"
}
string
name
Optional

name