Host Access Manager Update System Users

Host Access Manager Update System Users

Update the list of local system users.

The special users 'dcui' and 'vpxuser' need not be specified. They are always reported in the list of system users.

Required privileges: Global.Settings

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostAccessManager/{moId}/UpdateSystemUsers
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 8.0.2.0 APIs.

Request Body
UpdateSystemUsersRequestType of type(s) application/json
Required 
{
    "users": [
        "string"
    ]
}
array of string
users
Optional

the new list of local system users.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidArgument: If one of the specified user names is not valid, or is in Active Directory domain format.

UserNotFound: If one of the specified users is not found.

Returns UserNotFound 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"
        }
    ],
    "principal": "string",
    "unresolved": false
}
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.


On This Page
Host Access Manager Operations
POST
Host Access Manager Change Access Mode
POST
Host Access Manager Change Lockdown Mode
GET
Host Access Manager Get 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