1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Table 5-2. Summary of vApp Reconfiguration Requests (Continued)
Operation Request Request Body Response
Retrieve vApp
NetworkConfigSection
GET API-URL/vApp/vapp-
id/ networkConfigSection/
None
NetworkConfigSection
Update vApp
NetworkConfigSection
PUT API-URL/vApp/vapp-
id/ networkConfigSection/
NetworkConfigSection Task
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 section's href attribute. Then make a PUT request to the href attribute value of Link where
rel="edit" to update the section with your modifications.
Prerequisites
Verify that you are logged in as a system administrator or member of an organization in the cloud.
Procedure
1 Retrieve the XML representation of the vApp that contains the virtual machine to reconfigure.
Use a GET request as shown in “Example: Configuration Links in a vApp,” on page 88.
2 In the VApp element's Children element, find the Vm element that represents the virtual machine and retrieve
it.
3 Examine the response for edit links to modifiable sections.
The response portion of “Example: Configuration Links in a Vm Element,” on page 90 shows the links
for each of the modifiable section 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 “Example: Configuration Links in a vApp,” on page 88. 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 “Example: Configuration Links in a vApp,” on page 88.
Request:
GET https://vcloud.example.com/api/vApp/vm-4
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.vm+xml
<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">
<ovf:VirtualHardwareSection>
vCloud API Programming Guide
90 VMware, Inc.