Host Access Manager Change Access Mode

Host Access Manager Change Access Mode

Update the access mode for a user or group.

If the host is in lockdown mode, this operation is allowed only on users in the exceptions list - see QueryLockdownExceptions, and trying to change the access mode of other users or groups will fail with SecurityError.

Required privileges: Global.Settings

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostAccessManager/{moId}/ChangeAccessMode
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 HostAccessManager/{moId}.

string
release
Required

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

Request Body
ChangeAccessModeRequestType of type(s) application/json
Required 
"ChangeAccessModeRequestType Object"
string
principal
Required

The affected user or group.

boolean
isGroup
Required

True if principal refers to a group account, false otherwise.

accessMode
Required

AccessMode to be granted. accessOther is meaningless and will result in InvalidArgument exception.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

AuthMinimumAdminPermission: if this change would render the ESXi host inaccessible for local non-system users. The API ChangeLockdownMode may be used instead.

InvalidArgument: if accessMode is not valid.

SecurityError: if the host is in lockdown mode and 'principal' is not in the exceptions list.

UserNotFound: if the specified user is not found.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostAccessManager/{moId}/ChangeAccessMode
On This Page
Virtual Infrastructure Operations
POST
Host Access Manager Change Access Mode
POST
Host Access Manager Change Lockdown Mode
POST
Host Access Manager Query Lockdown Exceptions
POST
Host Access Manager Query System Users
POST
Host Access Manager Retrieve Host Access Control Entries
POST
Host Access Manager Update Lockdown Exceptions
POST
Host Access Manager Update System Users
GET
Host Access Manager Get Lockdown Mode