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
n
A request made to a Vm power URL affects only that virtual machine.
n
See “Summary of vCloud API vApp and Virtual Machine Operations Requests,” on page 77 for details of
each request.
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 to find the action links it contains.
Use a request like this one:
GET https://vcloud.example.com/api/vApp/vapp-7
2 POST a request to the URL that implements the desired action.
Many of these requests do not require a body.
The server takes the requested action and returns a Task element that tracks the progress of the request.
Configuring vApps and Virtual Machines
You specify configuration details for vApps and the virtual machines they contain in ovf:SectionType elements
contained in a VApp or Vm element. You can include most of these sections in the InstantiationParams that you
supply when you instantiate a vApp template. You can also retrieve, modify, and update these sections to
reconfigure a deployed vApp.
You establish the initial configuration of a vApp in the OVF package on which its source template is based.
You cannot modify most sections of the template, but you can update the configuration during the following
operations:
n
When you create a vApp by making an instantiateVAppTemplate request, you can update its configuration
by including modified sections in the request's InstantiationParams element.
n
When you compose or recompose a vApp, you can update its configuration by including modified sections
in the request's InstantiationParams element.
n
When you update any of the modifiable sections in a deployed vApp or the virtual machines that it
contains.
You can capture the reconfigured vApp to create a vApp template that preserves your modifications. See
“Capturing and Importing vApps,” on page 70.
Updating a vApp Template
You can update the following sections of a vApp template.
CustomizationSection
You can use a PUT request to update this section, which contains a Boolean
value, CustomizeOnInstantiate, that specifies whether guest customization
should be run during instantiation. You cannot modify this element if the vApp
has been added to a catalog.
Name and description
You can use a PUT request to update the value of the template's name attribute
or the contents of its Description element.
vCloud API Programming Guide
86 VMware, Inc.