Acquire Mks Ticket operation

The Acquire Mks Ticket operation creates and returns a one-time usable credential for establishing a remote mouse-keyboard-screen connection to the specified virtual machine.

Note

This operation works correctly depending on the retrieval of the TCP binding information pertaining to the server end of the client connection requesting the ticket. If the required TCP binding information is not available, a Not Supported fault is generated. This method is appropriate for SOAP and authenticated connections, which are TCP-based connections.

The following table describes the elements for this request.

Adapter request elements for the Acquire Mks Ticket operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Advanced_Vm	Yes
<operation-name>	Defines the name of operation: Acquire_Mks_Ticket	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the transport element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc. Note If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the elements required to execute the operation	Yes
<virtual-machine>	Specifies the name of the virtual machine used to make the method call Valid value: String	Yes

The following code sample shows a sample adapter request for the Acquire Mks Ticket operation.

Sample adapter request for the Acquire Mks Ticket operation

<vmware-infrastructure-request>
  <operation-type>Advanced_Vm</operation-type>
  <operation-name>Acquire_Mks_Ticket</operation-name>
  <soap-url></soap-url>
  <transport></transport>
  <user-name></user-name>
  <password></password>
  <parameters>
       <virtual-machine>TestDev156</virtual-machine>
  </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Acquire Mks Ticket operation.

Sample adapter response for the Acquire Mks Ticket operation

<vmware-infrastructure-response>
  <metadata>
    <status>success</status>
  </metadata>
  <AcquireMksTicketResponse>
     <returnval>
      <ticket>52ee9b9c-d347-b956-d93d-57c87d921c07</ticket>
      <cfgFile>/vmfs/volumes/48287d4e-aec12ab6-1d35- 0019b9e1c5fe/TestDev156_1/TestDev156.vmx</cfgFile>
      <host>dev151.bmc.com</host>
      <port>902</port>
     </returnval>
   </AcquireMksTicketResponse>
</vmware-infrastructure-response>

The following table describes the response elements.

Adapter response elements for the Acquire Mks Ticket operation

Element	Definition
<cfgFile>	The name of the configuration file for the virtual machine
<host>	The host to which the connection is to be established If the host is not specified, it is assumed that the requesting entity knows the appropriate host to connect.
<port>	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.
<ticket>	The ticket name This element is used as the username and password for the MKS connection.

Acquire Mks Ticket operation

On this page