VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
80 VMware, Inc.
<Link rel="edit" type="application/vnd.vmware.vcloud.guestCustomizationSection+xml"
href="http://vcloud.example.com/api/v1.0/vApp/vm-12/
guestCustomizationSection/"/>
</GuestCustomizationSection>
Response:
202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task ... operation="Updating Virtual Application Win2K3 (12)" ...>
...
</Task>
View or Modify Groups of Related Sections in a Vm
AsshowninExample 5‐12onpage 75,Linkelementsfordisks,mediadevices,andnetworkcardsaregrouped
attheendoftheVirtualHardwareSection.Theselinkshavecontenttype
application/vnd.vmware.vcloud.rasdItemsList+xml,andreferenceaRasdItemsListelementinthe
VirtualHardwareSectionofaVm.ThevCloudAPIusestheRasdItemsListelementto
aggregaterelated
elementsinaVirtualHardwareSection.ThissimplifiesretrievalandmodificationofItemelementsthatare
typicallyviewedormodifiedasagroup.Toretrieveoneoftheseelements,usethelinkwhererel="down".To
modifyit,usethelinkwhererel="edit".
Deploying and Controlling vApps and Virtual Machines
AvApporVmbodyreturnedinresponsetoaGET,PUT,orPOSTrequestincludesanumberofactionlinks,
whichhavetheformvApp‐or‐Vm‐URL/action/action‐name.Aclientcanuseactionlinkstorequestvarious
actionsonthevApp.Onlythoseactionlinksthatare
validforthevApporvirtualmachineinitscurrentstate
arereturned.Forexample,ifavAppisinstantiatedbutnotdeployed,onlythelinksfordeployandremove
arereturned.ForavAppthatispoweredon,linksforallactionsexceptpowerOnarereturned(seeExample 2‐8
on
page 27).
SomeoftherequestsdocumentedinthissectionapplyonlytovApps,othersapplyonlytovirtualmachines
(Vmobjects),andothersapplytoboth.
 ArequestmadetoavAppURLinvokestherequestedoperationoneachofthevirtualmachinesinthe
ChildrenelementofthevApp,intheorderspecifiedinitsovf:StartupSectionelement.Thiselement,
ifpresent,specifiesastartorderandrelatedpropertiesforeachmemberofaVirtualSystemCollection
(each
VmintheChildrencollection).Iftheelementisnotpresent,allmembersarestartedupatthesame
time.Thesamelogicappliestoshutdown,reboot,andsimilaroperations.Formoreinformation,seethe
OVFspecification,availableat
http://www.dmtf.org/standards/published_documents/DSP0243_1.0.0.pdf.
 ArequestmadetoaVmURLaffectsonlythatvirtualmachine.
Deploy a vApp or Virtual Machine
TodeployavApp,theclientmakesarequesttoitsaction/deployURL.DeployingavAppautomatically
deploysallofthevirtualmachinesitcontains.
Todeployavirtualmachine,theclientmakesarequesttoitsaction/deployURL.DeployingaVmimplicitly
deploystheparentvAppifthatvAppis
notalreadydeployed.
TherequestbodyineachcaseisaDeployVAppParamselement.
N
OTEMediadevicesareread‐only,sotheyhavenorel="edit"link.Formoreinformation,see“ListMedia
DevicesofaVirtualMachine”onpage 85.

VMware VCLOUD API 1.0 - API Specifications

General

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