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
2 Choose an external network to use for the Edge Gateway's initial uplink interface.
This external network must be one of the networks listed in the AvailableNetworks element of the Provider
vDC that backs the organization vDC in which you are creating the Edge Gateway. Follow these steps to
find a suitable external network.
a Retrieve the XML representation of the organization vDC in which you are creating the Edge Gateway.
Use a request like this one:
GET https://vcloud.example.com/api/admin/vdc/44
The ProviderVdcReference element in the response contains a reference to the Provider vDC that
backs this organization vDC.
<AdminVdc ...>
...
<ProviderVdcReference
type="application/vnd.vmware.admin.providervdc+xml"
name="PvDC-Example"
href="https://vcloud.example.com/api/admin/extension/providervdc/35"
...
</AdminVdc>
b Retrieve the the XML representation of the Provider vDC.
Use a request like this one:
GET https://vcloud.example.com/api/admin/extension/providervdc/35
The AvailableNetworks element in the response lists the external networks that are available to that
Provider vDC, and to all the organization vDCs that it supports.
<vmext:VMWProviderVdc ... >
...
<vcloud:AvailableNetworks>
<vcloud:Network
type="application/vnd.vmware.admin.network+xml"
name="VC1-VLAN48"
href="https://vcloud.example.com/api/admin/network/297" />
<vcloud:Network ... />
<vcloud:Network ... />
</vcloud:AvailableNetworks>
...
</vmext:VMWProviderVdc>
Choose an available external network to provide the initial interface for the new Edge Gateway. See
“Example: Create an Edge Gateway,” on page 153 for more information about criteria for choosing
an external network.
3 Create an EdgeGateway element.
In the GatewayInterfaces element, create a GatewayInterface element that defines an uplink interface.
n
Specify uplink for the InterfaceType.
n
Include the external network reference you retrieved in Step 2 in the Network element.
n
If you plan to create a NAT service or load balancer service in the Edge Gateway, you must create an
IP sub-allocation for the uplink by including a SubnetParticipation element in the
GatewayInterface element. IP addresses in the range you specify in this element are reserved for use
by this Edge Gateway.
vCloud API Programming Guide
152 VMware, Inc.