1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
vCloud API Programming Guide
30 VMware, Inc.
Use the Ticket with vmware-vmrc
Thevmware-vmrcplug‐inisinstalledbyyourbrowserwheneveryouusetheCloudDirectorWebConsoleto
accesstheconsoleofarunningvirtualmachine.Afterthisplug‐inhasbeeninstalled,youcanfinditinthe
folderthatyourbrowserusesforplug‐ins.
Touseascreen
ticketwithvmware-vmrc,openacommandshellinthefolderwherevmware-vmrc.exeis
installedandrunacommandthathastheform:
vmware-vmrc -h
ip-address
-p
decoded-ticket
-M
VM-MoRef
FortheticketshowninExample 2‐9,thecommandlinewouldlooksimilartothisone.
vmware-vmrc -h 10.147.43.171 -p 9XVUXZ... -M vm-61
ThecommandcontactsthespecifiedIPaddress,presentsthedecodedticketforvalidation,anddisplaysa
VMwareRemoteConsolewindow.Iftheticketisvalid,youcanaccessthevirtualmachine’sconsoleinthe
window.Iftheticketisimproperlydecodedorhastimedout,anderrormessageisdisplayed.
Deleting the vApp
YoucanuseanHTTPDELETErequesttodeleteavApp,asshowninExample 2‐10.(Youmustpoweroffand
undeploythevAppbeforeyoudeleteit.)TheresponseisaTaskbody.Becausethetasktracksadeletion,it
doesnotincludeanOwnerelement.(Theowneris
theobjectbeingdeleted.)
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
Tologoutandendasession,avCloudAPIclientmakesaPOSTrequesttothelogoutURL,asshownin
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
NOTETheversionofvmware-vmrcincludedwithCloudDirectorcannotbeusedtoaccessvirtualmachines
invCenter.Inaddition,itisincompatiblewiththeversionofvmware-vmrcinstalledbyVMwarevSphereWeb
Access,whichisalsoinstalledasabrowserplug‐in,andcannotco‐existwiththeCloudDirector
versionof
vmware-vmrc.