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
Every VApp element includes a link like this one, which you can use to retrieve details of its vApp networks.
<Link
rel="down"
type="application/vnd.vmware.vcloud.vAppNetwork+xml"
name="isoNet1"
href="https://vcloud.example.com/api/network/94 />
A GET request to this link returns a read-only VAppNetwork element. To modify an existing vApp network, you
must find the NetworkConfigSection of the VApp element and use its edit link, as shown in “Update a vApp
Network Configuration,” on page 96
You specify the configuration of a vApp network in the NetworkConfig element of the
InstantiateVAppTemplateParams request body, which includes the following information:
n
A name for the network, specified in the networkName attribute of the NetworkConfig element. The
instantiation parameters must create a vApp network whose name matches the value of the network
attribute of the NetworkConnection of each Vm element in the template. If this attribute has the value none
or is missing, the Vm can connect to any network. If the template contains Vm elements that specify different
names for their network connections, you must create a vApp network for each.
NOTE When you create a vApp network where the FenceMode is bridged, the networkName of the vApp
network must match the name of the ParentNetwork. This requirement is enforced by the composeVapp
operation. The instantiateVappTemplate operation automatically corrects a name mismatch by changing
the value of the network attribute in the NetworkConnection element of the VApp.
n
A Configuration element that specifies network configuration details.
n
For routed and directly connected networks, the ParentNetwork element contains a reference to the
organization network that the vApp network connects to. The FenceMode element controls how the
two networks connect. Specify a FenceMode of bridged for a direct connection to the parent network,
or natRouted to specify a routed connection controlled by network Features such as a NatService or
FirewallService. If you want the organization network to be isolated, with no external connection,
omit the ParentNetwork element and specify the FenceMode as isolated.
n
The Features element defines features of the vApp network. See “Network Services,” on page 121.
n
Additional modifiable elements like IpScope and RetainNetInfoAcrossDeployments, and read-only
elements such as SyslogServerSettings and RouterInfo. See the schema reference for more
information about the type and scope of these elements.
n
Network pool resources required by an isolated or natRouted vApp network are allocated by the system
from an unnamed pool owned by the vDC in which the vApp is deployed.
Organization Networks
System administrators create organization networks from resources that external networks and network pools
provide. An organization network allows virtual machines in the organization to communicate with each other
and to access external networks like the Internet.
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 119