Session Manager Acquire Generic Service Ticket

Creates and returns a one-time credential that may be used to make the specified request.

Required privileges: System.Anonymous

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/SessionManager/{moId}/AcquireGenericServiceTicket

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 SessionManager/{moId}.

string

release

Required

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

Request Body

AcquireGenericServiceTicketRequestType of type(s) application/json

Required

Show optional properties

{
    "spec": {}
}

{
    "spec": {
        "_typeName": "string"
    }
}

SessionManagerServiceRequestSpec

spec

Required

This data object type describes a request to a service.

It is used as argument to AcquireGenericServiceTicket. This is the base class for more specific service request specifications. E.g. for HTTP services the derived class will provide a URL property.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

a ticket that may be used to invoke the specified request. The first choice for authenticating the host is GenericServiceTicket#sslCertificate. If GenericServiceTicket#sslCertificate is unset, the following logic is used to authenticate the host: 1. If the VC system supports the crypto hash algorithm of the sslThumbprint or certThumbprintList (if set), they will be verified against that of the server certificate. If they doesn't match, the CA certificates will be used to authenticate the host. 2. If the VC system does not support the crypto hash algorithm of sslThumbprint or certThumbprintList, only the CA certificates will be used to authenticate the host.

Returns SessionManagerGenericServiceTicket of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "id": "string",
    "hostName": "string",
    "sslThumbprint": "string",
    "certThumbprintList": [
        {
            "_typeName": "string",
            "thumbprint": "string",
            "hashAlgorithm": "string"
        }
    ],
    "ticketType": "string"
}

string As password As password

Required

A unique string identifying the ticket.

string

hostName

Optional

The name of the host that the service is running on

string

sslThumbprint

Optional

The expected thumbprint of the SSL certificate of the host.

If it is empty, the host must be authenticated by name.

array of VirtualMachineCertThumbprint

certThumbprintList

Optional

List of expected thumbprints of the certificate of the host to which we are connecting.

The list can be configured on the host to include only certain hash types. The default configuration includes all hash types that are considered secure. See vmware.com for the current security standards.

Since: vSphere API Release 7.0.3.1

string

ticketType

Optional

Type of the ticket See { @Vim::SessionManager::GenericServiceTicket::TicketType }

Since: vSphere API Release 7.0.2.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication