Guest Auth Manager Acquire Credentials In Guest

Guest Auth Manager Acquire Credentials In Guest

Authenticates in the guest and returns a GuestAuthentication object with the acquired credentials for use in subsequent guest operation calls.

This can be used to authenticate inside the guest and obtain a GuestAuthentication object for supported authentication types. This operation is not needed for Name and Password Authentication. To use Name and Password Authentication, see NamePasswordAuthentication. For SSPI authentication, requestAuth should be of the type SSPIAuthentication.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/GuestAuthManager/{moId}/AcquireCredentialsInGuest
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 GuestAuthManager/{moId}.

string
release
Required

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

Request Body
AcquireCredentialsInGuestRequestType of type(s) application/json
Required 
{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "requestedAuth": {
        "_typeName": "string",
        "interactiveSession": false
    },
    "sessionID": 0
}
MoRefVirtualMachine
vm
Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication
requestedAuth
Required

GuestAuthentication is an abstract base class for authentication in the guest.

integer As int64 As int64
sessionID
Optional

The sessionID number should be provided only when responding to a server challenge. The sessionID number to be used with the challenge is found in the GuestAuthenticationChallenge object.

Authentication
This operation uses the following authentication methods.
Responses
200

Returns a GuestAuthentication object that can be used in guest operation calls.

Returns GuestAuthentication of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "interactiveSession": false
}
boolean
interactiveSession
Required

This is set to true if the client wants an interactive session in the guest.

Setting this is supported only for NamePasswordAuthentication.


500

GuestOperationsFault: if there is an error processing a guest operation.

GuestOperationsUnavailable: if the VM agent for guest operations is not running.

InvalidPowerState: if the VM is not powered on.

InvalidState: if the operation cannot be performed because of the virtual machine's current state.

TaskInProgress: if the virtual machine is busy.

GuestAuthenticationChallenge: if the credential information provided requires a challenge to authenticate.

GuestComponentsOutOfDate: if the guest agent is too old to support the operation.

OperationNotSupportedByGuest: if the operation is not supported by the guest OS.

OperationDisabledByGuest: if the operation is not enabled due to guest agent configuration.

TooManyGuestLogons: if there are too many concurrent login sessions active in the guest.

InvalidGuestLogin: if the the guest authentication information was not accepted.

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

On This Page
Guest Auth Manager Operations
POST
Guest Auth Manager Acquire Credentials In Guest
POST
Guest Auth Manager Release Credentials In Guest
POST
Guest Auth Manager Validate Credentials In Guest