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
Gateway DHCP Service Configurations
An Edge Gateway configuration can define a DHCP service that assigns IP addresses to clients on organization
vDC networks. You can configure multiple address pools, each of which defines a range of IP addresses that
are reserved for a specific network.
DHCP services for organization vDC networks are provided by the Edge Gateway to which those network
connect. An EdgeGateway can contain an more GatewayDhcpService element. The service can define a pool of
IP addresses for each organization vDC connected to the Edge Gateway.
NOTE To provide DHCP services on a vApp network, use the DhcpService element.
Example: Gateway DHCP Service
The following fragment of an EdgeGatewayServiceConfiguration defines and enables a GatewayDhcpService
that defines two Pool objects, each of which allocates a range of IP addresses for a single organization vDC
network.
<GatewayDhcpService>
<IsEnabled>true</IsEnabled>
<Pool>
<IsEnabled>true</IsEnabled>
<Network
type="application/vnd.vmware.admin.orgVdcNetwork+xml"
href="https://vcloud.example.com/api/admin/network/46" />
<DefaultLeaseTime>3600</DefaultLeaseTime>
<MaxLeaseTime>7200</MaxLeaseTime>
<LowIpAddress>10.100.1.100</LowIpAddress>
<HighIpAddress>10.100.1.150</HighIpAddress>
</Pool>
<Pool>
<IsEnabled>true</IsEnabled>
<Network
type="application/vnd.vmware.admin.orgVdcNetwork+xml"
href="https://vcloud.example.com/api/admin/network/47" />
<DefaultLeaseTime>3600</DefaultLeaseTime>
<MaxLeaseTime>7200</MaxLeaseTime>
<LowIpAddress>10.100.1.200</LowIpAddress>
<HighIpAddress>10.100.1.250</HighIpAddress>
</Pool>
</GatewayDhcpService>
To add this service to an Edge Gateway, include it in an EdgeGatewayServiceConfiguration. See
“Example: Configure Services on an Edge Gateway,” on page 157.
Create an Organization vDC Network
To add a network to an organization vDC, an administrator POSTs an OrgVdcNetwork element to the vDC's
add URL for networks. An organization vDC network with a direct connection to an external network must be
created by a system administrator. All other organization vDC network types can be created by either a system
administrator or an organization administrator.
The contents of the Configuration element of the OrgVdcNetwork define the properties of the network, including
its connections to other networks. See “Create an Organization vDC Network With a Direct Connection,” on
page 167, “Create an Organization vDC Network With a Routed Connection,” on page 170, and “Create an
Isolated Organization vDC Network,” on page 173.
vCloud API Programming Guide
166 VMware, Inc.