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
Network Services
vApp and organization networks can include any of the following services, defined in the Features element
of the network's Configuration.
DhcpService
Provides DHCP services to virtual machines on the network.
FirewallService
Allows you to create firewall rules that, when matched, block or allow
incoming or outgoing network traffic. See “vCloud Director Firewall
Configurations,” on page 122.
IpsecVpnService
Allows you to define one or more virtual private networks that virtual
machines can use to connect to other networks in or outside of the cloud.
Requires a routed network. See “Add a Virtual Private Network to a Routed
Organization Network,” on page 131.
NatService
Provides network address translation services to computers on the network.
StaticRoutingService
Allows you to specify static routes to other networks. Requires a routed
network. See “Static Routing Configurations for vCloud Director Networks,”
on page 123.
For detailed information about the elements and attributes that define these services, see the schema reference.
External Networks and Network Pools
External networks and network pools are vSphere resources that support organization and vApp networks.
A system administrator must create them, as described in “Create an External Network,” on page 180 and
“Create a Network Pool,” on page 183.
When you create a network for an organization, the creation request must specify an external network, a
network pool, or both. The VMWExtension element contains references to the available external networks and
network pools, as shown in this excerpt.
<vmext:VMWExtension ... >
...
<vcloud:Link
rel="down"
type="application/vnd.vmware.admin.vmwExternalNetworkReferences+xml"
href="https://10.115.123.105/api/admin/extension/externalNetworkReferences" />
<vcloud:Link
rel="down"
type="application/vnd.vmware.admin.vmwNetworkPoolReferences+xml"
href="https://10.115.123.105/api/admin/extension/networkPoolReferences" />
...
</vmext:VMWExtension>
For more information about the VMWExtension element, see “Retrieve a List of vSphere Platform Operations
and Objects for a Cloud,” on page 49.
Each reference to an external network or network pool includes its type, name, and href attributes, as shown
in this excerpt from a VMWExternalNetworkReferences element.
<vmext:VMWExternalNetworkReferences ... >
...
<vmext:ExternalNetworkReference
type="application/vnd.vmware.admin.vmwexternalnet+xml"
name="pnet_vc1"
href="https://vcloud.example.com/api/admin/extension/externalnet/59" />
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 121