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
VMware, Inc. 27
Chapter 2 Hello vCloud: A Structured REST Workflow Example
BecausethedeploymentrequestspecifiedpowerOn="true",thevAppispoweredonandreadyforusewhen
thetaskcompletes.Theclientcanwaitforasuitableintervalandcheckthetaskstatus(see“RetrieveaTask”
onpage 89),orsimplybeginrequestingoperationsonthepowered‐onvAppandchecking
thetaskstatusif
thoserequestsfail.See“DeployingandControllingvAppsandVirtualMachines”onpage 80.
Getting Information About the vApp
Asotherexampleshaveshown,aclientcanalwaysuseanHTTPGETrequesttodiscoverthecurrentstateof
anyvCloudobject,includingavApp.TheresponseinExample 2‐8revealsseveralthings:
ThevAppisdeployed(itsdeployedattributeissettotrue)andpoweredon(status="4").
TheVminitsChildrencollectionisalsopoweredonanddeployed.TheVmisconnectedtothevApp
networkcreatedduringinstantiation(seeExample 2‐6).Propertiesofthisnetworkareincludedinthe
NetworkConfigSectionofthevApp,thoughmostarenotshownhere.
ActionlinksforalloperationsexceptpowerOnarepresentinboththevAppitselfanditschildVm.Because
thevAppisalreadypoweredon,thatoperationisinvalidforthevAppinitscurrentstate,sothelinkis
notpartoftheresponse.(Thelinkfordeployis
alwayspresent,eveninadeployedvApp,becausethe
deployactionisalwaysvalid.)TheVmelementalsoincludesseverallinksforactionsthatnotapplicable
toavApp:actionslikeacquiringascreenticketorthumbnail,andinsertingorremovingmedia,are
specifictoavirtualmachine.Otheractionslike
shutdownandreboot,canbeappliedtoeitherobject.See
“DeployingandControllingvAppsandVirtualMachines”onpage 80.
Muchadditionalinformationisavailable,thoughmostofitisnotshownhere.Theexampledoesshow
wheretofindtheIPaddressofthevApp,intheIpAddresselementoftheNetworkConnection.
Example 2-8. Get Information About the vApp
Request:
GET http://vcloud.example.com/api/v1.0/vApp/vapp-7
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.vApp+xml
...
<VApp status="4" name="Linux FTP server" type="application/vnd.vmware.vcloud.vApp+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7" ... >
<Link rel="power:reboot"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/power/action/reboot"/>
<Link rel="power:powerOff"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/power/action/powerOff"/>
<Link rel="undeploy" href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/action/undeploy"/>
<Link rel="deploy" href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/action/deploy"/>
<Link rel="power:shutdown"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/power/action/shutdown"/>
<Link rel="power:reset"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/power/action/reset"/>
<Link rel="power:suspend"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/power/action/suspend"/>
<Link rel="down" type="application/vnd.vmware.vcloud.controlAccess+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/controlAccess/"/>
<Link rel="controlAccess" type="application/vnd.vmware.vcloud.controlAccess+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7/action/controlAccess/"/>
<Link rel="up" type="application/vnd.vmware.vcloud.vdc+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5"/>
<Link rel="edit" type="application/vnd.vmware.vcloud.vApp+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vapp-7"/>
<Description>Example FTP Server vApp</Description>
<LeaseSettingsSection ...>
...
</LeaseSettingsSection>
<ovf:StartupSection ... >
...