VirtualMachineTicket

VirtualMachineTicket
VirtualMachineTicket

This data object contains the information needed to establish a connection to a running virtual machine.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "ticket": "string",
    "cfgFile": "string",
    "host": "string",
    "port": 0,
    "sslThumbprint": "string",
    "certThumbprintList": [
        {
            "_typeName": "string",
            "thumbprint": "string",
            "hashAlgorithm": "string"
        }
    ],
    "url": "string"
}
string As password As password
ticket
Required

The ticket name.

This is used as the username and password for the MKS connection.

string
cfgFile
Required

The name of the configuration file for the virtual machine.

string
host
Optional

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.

integer As int32 As int32
port
Optional

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.

string
sslThumbprint
Optional

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.

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
url
Optional

Websocket URL.

Some tickets are "websocket" tickets and are best expressed as a URL.