VMware VCLOUD API 1.0 - API - Reconfigure a vApp

VMware, Inc. 69
Chapter 5 Datacenter Operations
Reconfiguring vApps and Virtual Machines
ConfigurationdetailsforvAppsandthevirtualmachinestheycontainarespecifiedinovf:SectionType
elementssuchasLeaseSettingsSection,NetworkConfigSection,andOperatingSystemSection.These
sectionscanbespecifiedintheInstantiationParamsforthevApporVm,andcanalsobeeditedinplaceusing
reconfigurationlinks(Linkelementswhererel="edit")
thattheserveraddstothesesectionsduring
instantiation.FormoreinformationaboutthesectionsthatcanbeincludedinInstantiationParams,see
“InstantiationParams”onpage 172.
ThereconfigurationprocessforvAppsandvirtualmachinesissimilar,butthesetofsectionsthatcanbeedited
duringreconfigurationdependsontheobject
beingreconfigured.
Reconfigure a vApp
Table 5‐2summarizesvAppreconfigurationrequestssupportedinthisrelease.Thetableusesthefollowing
conventions:
 API‐URLisaURLoftheformhttp://vcloud.example.com/api/v1.0
 idisaninteger
YoucanreconfigureavAppbymakingchangestoanyofthefollowingsections:
 LeaseSettingsSection
 StartupSection
 NetworkConfigSection
Modifiedsectionsmustcontainallrequiredelements,evenifyouarenotchangingtheirvalues.Some
elementsinsomesectionsareread‐only.Seetheschemareferencesfordetails.
Table 5-2. Summary of vApp Reconfiguration Requests
Operation Request Request Body Response
RetrievevAppLeaseSettings GETAPI‐URL/vApp/vapp‐id/
leaseSettingsSection/
None LeaseSettingsSection
ModifyvAppLeaseSettings PUTAPI‐URL/vApp/vapp‐id/
leaseSettingsSection/
LeaseSettingsSection Task
RetrievevAppStartupSection GETAPI‐URL/vApp/vapp‐id/
startupSection/
None StartupSection
ModifyvAppStartupSection PUTAPI‐URL/vApp/vapp‐id/
startupSection/
StartupSection Task
RetrievevAppNetworkSection GETAPI‐URL/vApp/vapp‐id/
networkSection/
None ovf:NetworkSection
RetrievevAppNetworkConfiguration GETAPI‐URL/vApp/vapp
‐id/
networkConfigSection/
None NetworkConfigSection
ModifyvAppNetworkConfiguration PUTAPI‐URL/vApp/vapp‐id/
networkConfigSection/
NetworkConfigSection Task
NOTEEachVminthevApp’sChildrencollectionincludesadditionallinksforconfiguringitsguestoperating
system,virtualhardware,andotherproperties.Forclarity,theChildrenarenotshowninExample 5‐9.Tosee
them,refertoExample 5‐12onpage 75.