Host System Acquire Cim Services Ticket

Host System Acquire Cim Services Ticket

Creates and returns a credential used to establish a remote connection to a Web Based Management (CIM) interface.

Valid only when ESXi wbem authentication mode is set to password. The ticket provides the port for the service and sslThumbprint should be used by client to validate ssl connection. This ticket is valid for 2 minutes then will expire and is non-renewable.

Required privileges: Host.Cim.CimInteraction

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/AcquireCimServicesTicket

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

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

OK

Returns HostServiceTicket of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "host": "string",
    "port": 0,
    "sslThumbprint": "string",
    "service": "string",
    "serviceVersion": "string",
    "sessionId": "string"
}

string

host

Optional

The name of the host providing the service for which the ticket applies.

If omitted, then the client uses the host name for the server that issued the ticket.

integer As int32 As int32

port

Optional

Access to some services is made possible by connecting to a port on a server.

If the service for which a ticket is issued is available on a particular port, that port number is specified with this property. If omitted, except in the case of connecting to CIM interfaces, the port number for the service that issued the ticket is used. In the case of connecting to a CIM interface the standard well known port for the particular service will be used for the connection.

string

sslThumbprint

Optional

The expected thumbprint of the SSL cert of the host to which we are connecting.

string

service

Required

The name of the service to which to connect.

string

serviceVersion

Required

A dot-separated string identifying the service protocol version.

For example, 1.0 is used for NFC hosted by vpxa on ESX 2.5, and 1.1 is used for NFC hosted by hostd on ESX 3.0.

string As password As password

sessionId

Required

An identifying string for the session created for the ticketed connection.

This is used by the host service to identify the operations permitted within the session.

On This Page

Request

Path Parameters

200 Response Body

Host System Operations

Host System Acquire Cim Services Ticket

Host System Configure Crypto Key

Host System Destroy Task

Host System Disconnect Host Task

Host System Enable Crypto

Host System Enter Lockdown Mode

Host System Enter Maintenance Mode Task

Host System Exit Lockdown Mode

Host System Exit Maintenance Mode Task

Host System Get Alarm Actions Enabled

Host System Get Answer File Validation Result

Host System Get Answer File Validation State

Host System Get Available Field

Host System Get Capability

Host System Get Compliance Check Result

Host System Get Compliance Check State

Host System Get Config

Host System Get Config Issue

Host System Get Config Manager

Host System Get Config Status

Host System Get Custom Value

Host System Get Datastore

Host System Get Datastore Browser

Host System Get Declared Alarm State

Host System Get Disabled Method

Host System Get Effective Role

Host System Get Hardware

Host System Get Licensable Resource

Host System Get Name

Host System Get Network

Host System Get Overall Status

Host System Get Parent

Host System Get Permission

Host System Get Precheck Remediation Result

Host System Get Recent Task

Host System Get Remediation Result

Host System Get Remediation State

Host System Get Runtime

Host System Get Summary

Host System Get System Resources

Host System Get Tag

Host System Get Triggered Alarm State

Host System Get Value

Host System Get Vm

Host System Power Down Host To Stand By Task

Host System Power Up Host From Stand By Task

Host System Prepare Crypto

Host System Query Host Connection Info

Host System Query Memory Overhead

Host System Query Memory Overhead Ex

Host System Query Product Locker Location

Host System Query Tpm Attestation Report

Host System Reboot Host Task

Host System Reconfigure Host For DAS Task

Host System Reconnect Host Task

Host System Reload

Host System Rename Task

Host System Retrieve Free Epc Memory

Host System Retrieve Hardware Uptime

Host System Set Custom Value

Host System Shutdown Host Task

Host System Update Flags

Host System Update Ipmi

Host System Update Product Locker Location Task

Host System Update System Resources

Host System Update System Swap Configuration