Acquire vApp Screen Ticket operation
The Acquire vApp Screen Ticket operation enables you to retrieve a ticket that the client can use for opening a screen connection to a child VM.
The following figure shows a sample <items> XML element for the Acquire vApp Screen Ticket operation:
Sample <items> XML element for the Acquire vApp Screen Ticket operation
<item>
<parameters>
<child-vm-id></child-vm-id>
</parameters>
</item>
</items>
The following table describes the elements for this adapter request:
Adapter request elements for the Acquire vApp Screen Ticket operation
Element | Definition | Required |
|---|---|---|
<operation-name> | Defines the type of operation: Acquire_vApp_Screen_Ticket | Yes |
<vcloud-organization> | Specifies the name of the vCloud organization | Conditional:
|
<user-name> | Specifies the user name required for basic HTTP authentication on vCloud | Conditional:
|
<password> | Contains the password corresponding to the specified user name | Conditional:
|
<parameters> | Contains the elements for the operation | Yes |
<child-vm-id> | Specifies the ID of the child virtual machine on the virtual appliance whose screen ticket you want to retrieve | Yes |
The following figure shows the sample adapter request for the Acquire vApp Screen Ticket operation:
Sample adapter request for the Acquire vApp Screen Ticket operation
<operation-name>Acquire_vApp_Screen_Ticket</operation-name>
<vcloud-organization>TestOrg</vcloud-organization>
<user-name>TestUser</user-name>
<password>Password</password>
<parameters>
<child-vm-id>vm-244324925</child-vm-id>
</parameters>
</vmware-vcloud-request>
The following figure shows the response for the sample adapter request:
Sample adapter response for the Acquire vApp Screen Ticket operation
<metadata>
<status>success</status>
</metadata>
<status-line>
<code>200</code>
<reason>OK</reason>
</status-line>
<message-body>
<ScreenTicket>mks://10.128.249.104/vm-514?ticket=TE-yKyMk%2FIroLB1dB
5YyxppUbxEZLqDPRStIcxe2SPDLXMQqrpGt9feVYXFePNPnqIb%2FO%2FVAADXhPWDDwa
%2FTgc%2Fn6FCN2QJYcsk-pWfSygJqbVnanrJzKG27GP02dlQY%2Byg0xey4xlFjLG5mo
QlwVb4qwlXusQqdrQ5xMTJKzko1rkXK%2BT%2FX1AwpUPr0vgagG9VEdY4Ig%2BrruS0a
aLhQto7DBzv5ihPmjwZ8VnojV6wRgvUB6mJsKCHebt4uM%2F29kHNRzzQTdAo7oBlkFwx
y2Y3wJ8nMeYNaPH1X</ScreenTicket>
</message-body>
</vmware-vcloud-response>