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
Owner
You can use a PUT request to update the value of the template's Owner element.
See “View or Change the Owner of an Object,” on page 73.
ProductSection
elements
You can retrieve or update the template's ProductSection elements, which
provide a way to pass runtime information to the virtual machines defined in
the template. See “Retrieve or Modify ProductSection Elements,” on
page 102.
Except for the Owner element, all updates to a vApp template propagate to the vApp during instantiation. The
owner of the vApp is reset to the identity of the user who instantiates the template.
Configuring a vApp
You can include the following sections in InstantiationParams for a vApp. You can also modify them after
you deploy the vApp.
LeaseSettingsSection
Defines the terms of storage and deployment leases for the vApp. If this section
is omitted, the vApp inherits the default lease settings of the containing
organization.
NetworkConfigSection
Defines the properties of the vApp network and specifies how it is connected
to a network in the vDC. Unless you intend to create a vApp that has no
connection to any network, you must include this section in the
InstantiationParams element of an instantiateVappTemplate request.
StartupSection
Defines the order in which the virtual machines in the vApp start up and shut
down. If this section is omitted, the startup and shutdown order of virtual
machines in the vApp is indeterminate.
Configuring a Virtual Machine
You can include the following sections in the InstantiationParams for a Vm. You can also modify them after
you deploy the Vm. You can reconfigure a virtual machine by making changes to any of the following sections
of a Vm:
VirtualHardwareSection
Contains a description of the virtual hardware supported by a virtual machine.
You can reconfigure individual items in this section, or reconfigure groups of
related items such as hard disks or network interface cards.
OperatingSystemSectio
n
Specifies the guest operating system installed on the virtual machine.
NetworkConnectionSect
ion
Specifies how the virtual NIC devices on the virtual machine are connected to
the vApp network.
GuestCustomizationSec
tion
Contains guest customization parameters for the virtual machine.
Reconfiguration Workflow
The workflow for reconfiguring a vApp or virtual machine is the same regardless of the section you are
modifying.
1 Retrieve the vApp or Vm and examine the response to find the section that you want to modify.
2 Retrieve the section by making a GET request to the URL in the section’s href attribute value.
3 Modify the section as needed.
Chapter 5 Deploying and Operating vApps
VMware, Inc. 87