VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
30 VMware, Inc.
Use the Ticket with vmware-vmrc
Thevmware-vmrcplug‐inisinstalledbyyourbrowserwheneveryouusetheCloudDirectorWebConsoleto
accesstheconsoleofarunningvirtualmachine.Afterthisplug‐inhasbeeninstalled,youcanfinditinthe
folderthatyourbrowserusesforplug‐ins.
Touseascreen
ticketwithvmware-vmrc,openacommandshellinthefolderwherevmware-vmrc.exeis
installedandrunacommandthathastheform:
vmware-vmrc -h ip-address -p decoded-ticket -M VM-MoRef
FortheticketshowninExample 2‐9,thecommandlinewouldlooksimilartothisone.
vmware-vmrc -h 10.147.43.171 -p 9XVUXZ... -M vm-61
ThecommandcontactsthespecifiedIPaddress,presentsthedecodedticketforvalidation,anddisplaysa
VMwareRemoteConsolewindow.Iftheticketisvalid,youcanaccessthevirtualmachine’sconsoleinthe
window.Iftheticketisimproperlydecodedorhastimedout,anderrormessageisdisplayed.
Deleting the vApp
YoucanuseanHTTPDELETErequesttodeleteavApp,asshowninExample 2‐10.(Youmustpoweroffand
undeploythevAppbeforeyoudeleteit.)TheresponseisaTaskbody.Becausethetasktracksadeletion,it
doesnotincludeanOwnerelement.(Theowneris
theobjectbeingdeleted.)
Example 2-10. Delete a vApp
Request:
DELETE http://vcloud.example.com/api/v1.0/vApp/vapp-7
Response:
202 Accepted
<Task xmlns="http://www.vmware.com/vcloud/v1" status="running"
startTime="2010-06-25T08:10:23.650-07:00" operation="Deleting Virtual Application
Linux FTP server (7)" expiryTime="2010-09-23T08:00:55.402-07:00"
type="application/vnd.vmware.vcloud.task+xml"
href="http://vcloud.example.com/api/v1.0/task/jul1tndoojgaesymci" ... >
<Owner type="application/vnd.vmware.vcloud.vApp+xml" name="Linux FTP server"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7"/>
</Task>
Logging Out
Tologoutandendasession,avCloudAPIclientmakesaPOSTrequesttothelogoutURL,asshownin
Example 2‐11.
Example 2-11. Log Out
Request:
POST http://vcloud.example.com/api/v1.0/logout
x-vcloud-authorization: cn9uYmdugN8E2j96+5Lqrc3YBvFsEgDHXzyfJrJ/6bM=
Response:
200 OK
NOTETheversionofvmware-vmrcincludedwithCloudDirectorcannotbeusedtoaccessvirtualmachines
invCenter.Inaddition,itisincompatiblewiththeversionofvmware-vmrcinstalledbyVMwarevSphereWeb
Access,whichisalsoinstalledasabrowserplug‐in,andcannotco‐existwiththeCloudDirector
versionof
vmware-vmrc.

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English