Retrieve the Configuration Links for a Virtual Machine

A virtual machine is represented by a Vm element. Each modifiable section of a Vm element 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

Retrieve the XML representation of the vApp that contains the virtual machine to reconfigure.
Use a GET request as shown in Configuration Links in a vApp.
In the VApp element's Children element, find the Vm element that represents the virtual machine and retrieve it.
Examine the response to find the reconfigureVm link and edit links to modifiable sections.
The response portion of Configuration Links in a Vm Element shows the reconfigureVm link and links for each of the modifiable sections of the Vm. You cannot modify sections that do not contain a link where rel="edit".

Example: Configuration Links in a Vm Element

This example retrieves a Vm element shown in Configuration Links in a vApp. It expands that element to show its configuration links. It also shows the entire NetworkConnectionSection of that Vm, and additional information that is referenced in other examples. You cannot modify sections that do not have a Link where rel="edit", so they do not appear in this example. Modifiable sections of the parent vApp are shown in Configuration Links in a vApp.

Request:

GET https://vcloud.example.com/api/vApp/vm-4

Response:

200 OK
Content-Type: application/vnd.vmware.vcloud.vm+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<Vm
   xmlns="http://www.vmware.com/vcloud/v1.5"
   xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
   status="8"
   name="ubuntu10-x86"
   href="https://vcloud.example.com/api/vApp/vm-4">
   ...
   <Link
      rel="reconfigureVm"
      type="application/vnd.vmware.vcloud.vm+xml"
      name="vm-4"
      href="https://vcloud.example.com/api/vApp/vm-4/action/reconfigureVm" />
   ...
   <ovf:VirtualHardwareSection>
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.virtualHardwareSection+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/" />
      <Link
         rel="down"
         type="application/vnd.vmware.vcloud.rasdItem+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/cpu" />
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.rasdItem+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/cpu" />
      <Link
         rel="down"
         type="application/vnd.vmware.vcloud.rasdItem+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/memory" />
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.rasdItem+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/memory" />
      <Link
         rel="down"
         type="application/vnd.vmware.vcloud.rasdItemsList+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/disks" />
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.rasdItemsList+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/disks" />
      <Link
         rel="down"
         type="application/vnd.vmware.vcloud.rasdItemsList+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/media" />
      <Link
         rel="down"
         type="application/vnd.vmware.vcloud.rasdItemsList+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/networkCards" />
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.rasdItemsList+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/virtualHardwareSection/networkCards" />
   </ovf:VirtualHardwareSection>
   <ovf:OperatingSystemSection
      href="https://vcloud.example.com/api/vApp/vm-4/operatingSystemSection"
      ovf:id="1">
      <ovf:Info>Specifies the operating system installed
      </ovf:Info>
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.operatingSystemSection+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/operatingSystemSection" />
   </ovf:OperatingSystemSection>
   <NetworkConnectionSection>
      <ovf:Info>Specifies the available VM network connections</ovf:Info>
      <Link
         rel="edit"
         type="application/vnd.vmware.vcloud.networkConnectionSection+xml"
         href="https://vcloud.example.com/api/vApp/vm-4/networkConnectionSection" />
      ...
   </NetworkConnectionSection>
   <GuestCustomizationSection>
      <Link
         rel="edit"
         href="https://vcloud.example.com/api/vApp/vm-4/guestCustomizationSection+xml"
         type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
      </Link>
      ...
   </GuestCustomizationSection>
   <VmCapabilities>
      <Link
         rel="edit"
         href="https://vcloud.example.com/api/vApp/vm-4/vmCapabilities/"
         type="application/vnd.vmware.vcloud.vmCapabilitiesSection+xml" />
      <MemoryHotAddEnabled>false</MemoryHotAddEnabled>
      <CpuHotAddEnabled>false</CpuHotAddEnabled>
   </VmCapabilities>
   <BootOptions>
      <Link
         rel="edit"
         href="https://vcloud.example.com/api/vApp/vm-4/action/bootOptions"
         type="application/vnd.vmware.vcloud.bootOptionsSection+xml" />
      <BootDelay>0</BootDelay>
      <EnterBIOSSetup>false</EnterBIOSSetup>
   </BootOptions>
   ...
</Vm>