Retrieve the Configuration Links for a vApp

Each modifiable section of a vApp includes a Link element whose rel attribute has the value edit. You cannot modify sections that do not contain this Link element.

Any ovf:SectionType element can include an arbitrary number of Link elements. Sections that you can modify include a Link element where rel="edit". To modify one of these sections, retrieve it by making a GET request to the URL in the section's href attribute. Then make a PUT request to the href attribute value of the Link where rel="edit" to update the section with your modifications.

Prerequisites

This operation requires the rights included in the predefined vApp Author role or an equivalent set of rights.

Procedure

  1. Retrieve the XML representation of the vApp.
    Use a GET request as shown in Configuration Links in a vApp.
  2. Examine the response for edit links to modifiable sections.
    The response portion of Configuration Links in a vApp includes one of these links for each of the modifiable sections of the vApp. You cannot modify sections that do not contain a Link element where rel="edit".

Example: Configuration Links in a vApp

In this example, the response was edited to show only the modifiable sections of the VApp element. Each Vm in the Children element of the VApp includes additional configuration links, shown in Configuration Links in a Vm Element.

Request: 
GET https://vcloud.example.com/api/vApp/vapp-7
Response: 
200 OK
Content-Type: application/vnd.vmware.vcloud.vApp+xml
...
<VApp ... href="https://vcloud.example.com/api/vApp/vapp-7">
   ...
   <LeaseSettingsSection ... 
      href="https://vcloud.example.com/api/vApp/vapp-7/leaseSettingsSection/" ...>
      ...
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.leaseSettingsSection+xml"
         href="https://vcloud.example.com/api/vApp/vapp-7/leaseSettingsSection/" />
      ...
   </LeaseSettingsSection>
   <ovf:StartupSection ... 
      href="https://vcloud.example.com/api/vApp/vapp-7/startupSection/" ... >
      ...
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.startupSection+xml"
         href="https://vcloud.example.com/api/vApp/vapp-7/startupSection/" />
   ...
   </ovf:StartupSection>
   <NetworkConfigSection ... 
      href="https://vcloud.example.com/api/vApp/vapp-7/networkConfigSection/" ... />
      ...
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.networkConfigSection+xml"
         href="https://vcloud.example.com/api/vApp/vapp-7/networkConfigSection/" />
      ...
   </NetworkConfigSection>
   <Children>
      <Vm ...
         status="8"
         name="ubuntu10-x86"
         href="https://vcloud.example.com/api/vApp/vm-4">
         ...
      </Vm>
   </Children>
</VApp>