Virtual Machine Acquire Ticket
Creates and returns a one-time credential used in establishing a specific connection to this virtual machine, for example, a ticket type of mks can be used to establish a remote mouse-keyboard-screen connection.
A client using this ticketing mechanism must have network connectivity to the ESX server where the virtual machine is running, and the ESX server must be reachable to the management client from the address made available to the client via the ticket.
Acquiring a virtual machine ticket requires different privileges depending on the types of ticket:
- VirtualMachine.Interact.DeviceConnection if requesting a device ticket.
- VirtualMachine.Interact.GuestControl if requesting a guestControl or guestIntegrity ticket.
- VirtualMachine.Interact.ConsoleInteract if requesting an mks or webmks ticket.
- VirtualMachine.Interact.DnD if requesting a drag and drop ticket.
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 VirtualMachine/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
{
"ticketType": "string"
}The type of service to acquire, the set of possible values is described in VirtualMachineTicketTypeEnum.
A one-time credential used in establishing a remote connection to this virtual machine.
{
"_typeName": "string",
"ticket": "string",
"cfgFile": "string",
"host": "string",
"port": 0,
"sslThumbprint": "string",
"certThumbprintList": [
{
"_typeName": "string",
"thumbprint": "string",
"hashAlgorithm": "string"
}
],
"url": "string"
}The ticket name.
This is used as the username and password for the MKS connection.
The name of the configuration file for the virtual machine.
The host with which to establish a connection.
If the host is not specified, it is assumed that the requesting entity knows the appropriate host with which to connect.
The port number to use.
If the port is not specified, it is assumed that the requesting entity knows the appropriate port to use when making a new connection.
The expected SHA1 thumbprint of the SSL cert of the host to which we are connecting.
This field can be enabled or disabled on the host.
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
Websocket URL.
Some tickets are "websocket" tickets and are best expressed as a URL.
InvalidState: if the virtual machine is not connected.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}