Virtual Machine Acquire Mks Ticket
Deprecated as of vSphere API 4.1, use AcquireTicket instead.
Creates and returns a one-time credential used in establishing a remote mouse-keyboard-screen connection to this virtual machine.
The correct function of this method depends on being able to retrieve TCP binding information about the server end of the client connection that is requesting the ticket. If such information is not available, the NotSupported fault is thrown. This method is appropriate for SOAP and authenticated connections, which are both TCP-based connections.
Required privileges: VirtualMachine.Interact.ConsoleInteract
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.2.0 APIs.
A one-time credential used in establishing a remote mouse-keyboard-screen connection.
{
"_typeName": "string",
"ticket": "string",
"cfgFile": "string",
"host": "string",
"port": 0,
"sslThumbprint": "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 thumbprint of the SSL cert of the host to which we are connecting.