5.1
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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- vDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
n
The Features element defines features of the vApp network, and can include the following services:
DhcpService
Provides DHCP services to virtual machines on the network.
FirewallService
Specifies firewall rules that, when matched, block or allow incoming or
outgoing network traffic.
NatService
Provides network address translation services to virtual machines on
the network.
StaticRoutingService
Specifies static routes to other networks. Requires a routed organization
vDC network.
For more information, see “Network Services in vApp Networks,” on page 112
n
Additional modifiable elements like IpScopes and RetainNetInfoAcrossDeployments, and read-only
elements such as SyslogServerSettings and RouterInfo. For more information about the type and
scope of these elements, see the schema reference.
n
Network pool resources required by an isolated or natRouted vApp network are allocated by the system
from the pool associated with the vDC in which the vApp is deployed.
Organization vDC Networks
An organization vDC network allows virtual machines in the organization vDC to communicate with each
other and to access other networks, including organization vDC networks and external networks, either
directly or through an Edge Gateway that can provide firewall and NAT services.
n
A direct organization vDC network connects directly to an eternal network. Only a system administrator
can create a direct organization vDC network.
n
A routed organization vDC network connects to an external network through an Edge Gateway, which
is backed by a vShield Edge device. A routed organization vDC network also requires the containing vDC
to include a network pool. After a system administrator has provisioned an organization vDC with an
Edge Gateway and associated it with a network pool, organization administrator or system administrators
can create routed organization vDC networks in that vDC.
n
An isolated organization vDC network does not require an Edge Gateway or external network, but does
require the containing vDC to be associated with a network pool. After a system administrator has created
an organization vDC with a network pool, organization administrators or system administrators can create
isolated organization vDC networks in that vDC.
n
Most types of organization vDC networks do not provide any network services. Isolated organization
vDC networks can specify a DhcpPoolService, which provides DHCP addresses from several pools of IP
address ranges. All other services, such as NAT, firewall, and load balancing, are configured by a system
administrator on the Edge Gateway to which the network connects.
Chapter 6 Creating and Managing Organizations
VMware, Inc. 149