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
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>
Summary of vApp Reconfiguration Requests
vApp reconfiguration requests retrieve or update modifiable sections of a vApp.
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
id is a unique identifier in the form of a UUID, as defined by RFC 4122.
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only. For more information about the requests and responses for each
operation, see “About the Schema Reference Downloadable Archive,” on page 19.
Table 5-2. Summary of vApp Reconfiguration Requests
Operation Request Request Body Response
Retrieve vApp
LeaseSettingsSection
GET API-URL/vApp/vapp-
id/ leaseSettingsSection/
None
LeaseSettingsSection
Update vApp
LeaseSettingsSection
PUT API-URL/vApp/vapp-
id/ leaseSettingsSection/
LeaseSettingsSection Task
Retrieve vApp
StartupSection
GET API-URL/vApp/vapp-
id/ startupSection/
None
StartupSection
Update vApp
StartupSection
PUT API-URL/vApp/vapp-
id/ startupSection/
StartupSection Task
Chapter 5 Deploying and Operating vApps
VMware, Inc. 89