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
38 VMware, Inc.
<ResourceEntity href="http://vcloud.example.com/vApp/vapp-413"
type="application/vnd.vmware.vcloud.vApp+xml" name="Example Corp. CRM"/>
...
</ResourceEntities>
<AvailableNetworks>
<Network href="http://vcloud.example.com/api/v1.0/network/14"
type="application/vnd.vmware.vcloud.network+xml" name="IsolatedOrgNet"/>
<Network href="http://vcloud.example.com/api/v1.0/network/54"
type="application/vnd.vmware.vcloud.network+xml" name="Internet"/>
</AvailableNetworks>
<NicQuota>0</NicQuota>
<NetworkQuota>0</NetworkQuota>
<VmQuota>0</VmQuota>
<IsEnabled>true</IsEnabled>
</Vdc>
TheresponseisadetaileddescriptionofthevDCanditscontents.Itincludes:
Linkelementswhoserelattributehasavalueofadd.Eachoftheselinkshasanhrefattributewhose
valueisaURLthataclientcanusetoaddvApps,vApptemplates,andmediaimagestovDCinventory.
Severalmethodsofaddinginventoryaresupported,includingupload,clone,and
compose.
ResourceEntityelementsthatreferencevAppsthathavebeeninstatiatedinorimportedtothisvDC,
andvApptemplatesandvirtualmediaimagesthathavebeenuploadedtothevDC.
AlistoforganizationnetworksthatareavailableinthevDC.
Othermetadata,includingquotaandvDCstateinformation.
Formoreinformation,see“Vdc”onpage 152.
Getting More Information About an Object
AnobjectinavCloudcanberepresentedbylinksinvarioustypesofXMLcontainers.Regardlessofwherethe
linkappears,theobjectreferenceitcontains(itshrefattributevalue)isalwaysthesame.Anorganization
networkcanberepresentedbyalinkwithrel="down"inanorganization,oras
amemberofthe
AvailableNetworkselementofavDC.
CatalogsprovidealevelofindirectionforreferencestomediaimagesandvApptemplates.AvApptemplate
ormediaimagecanbereferencedbyaCatalogIteminacatalogoraResourceEntityinavDC.The
CatalogItemshowninExample 3‐2,
aVAppTemplatewhoseURLis
http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate‐111,isalsocontainedbythevDC
referencedinExample 3‐4.IntheVdcbody,theVAppTemplateisrepresentedasResourceEntityelement,
whichincludesalink(thevalueofthehrefattribute)tothetemplate.TheCatalog,ontheotherhand,
containsonly
CatalogItemelements,eachofwhichincludesalinkthataclientcanusetogetmore
informationabouttheobjectthattheCatalogItemrepresents.BoththeResourceEntityintheVdcandthe
CatalogItemintheCatalogrefertothesamevApptemplate.TheResourceEntityelementincludesalink
thata
clientcanusetoGETarepresentationofthevApp,butaclientmustfirstGETaCatalogItemtoobtain
thatkindoflink,whichisnotcontainedintheCatalogitself.
AResourceEntityelementappearsinaVdcelementassoonastheunderlyingvApptemplateormedia
imagehas
beencreated.Referencestothoseobjectsdonotappearinacataloguntilthecatalogowneradds
themtoit.Inmostcases,theobjectscannotbeuseduntiltheyhavebeenaddedtoacatalog.
Get Information About a Media Image
AclientcandiscovertheURLofamediaimagebybrowsinginacatalogandexaminingaCatalogItemto
findtheEntityelementthatreferencestheimage,orbybrowsinginavDCforaResourceEntityelement
thatreferencestheimage.Afterclienthasthe image’sURL,itcanuse
itasthetargetofaGETrequest,asshown
inExample 3‐5.
Ifthemediaimagehasbeenincludedinacatalog,theMediaelementintheresponseincludesalinktothe
CatalogItemthatreferencesit.