VMware Cloud Director API - MksTicket

MksTicketType

Element:

MksTicket

Type:

MksTicketType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

A ticket and connection information for accessing the console of a VM.

Since:

5.5

Schema:

mksTicket.xsd

Media type(s):

application/vnd.vmware.vcloud.mksTicket+json
application/vnd.vmware.vcloud.mksTicket+xml

Extends:

VCloudExtensibleType

XML Representation:

<MksTicket xmlns="http://www.vmware.com/vcloud/v1.5">
    <Host> xs:string </Host>
    <Vmx> xs:string </Vmx>
    <Ticket> xs:string </Ticket>
    <Port> xs:int </Port>
</MksTicket>

Elements

Element	Type	Required	Modifiable	Since	Description
Host	string	Yes	none	5.5	host (or proxy) through which the console connection is made
Port	int	Yes	none	5.5	host port to be used for console access
Ticket	string	Yes	none	5.5	screen ticket to use to authenticate the client
VCloudExtension	VCloudExtensionType	No	always	5.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
Vmx	string	Yes	none	5.5	a reference to the VMX file of the VM for which this ticket was issued

Operations

CRUD	Operation	Description	Since	Deprecated
as output	POST /vApp/{id}/screen/action/acquireMksTicket	Retrieve a mks ticket that you can use to gain access to the console of a running VM.	5.5