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
type="application/vnd.vmware.vcloud.allocatedNetworkAddress+xml"
href="https://vcloud.example.com/api/admin/network/54/allocatedAddresses/" />
<Description>Bridged to the public Internet</Description>
<Tasks>
<Task
name="task"
status="running"
operation="Creating Network Internet(54)"
...
</Task>
</Tasks>
<Configuration>
...
</Configuration>
</OrgVdcNetwork>
Create an Organization vDC Network With a Routed Connection
An organization vDC network with a routed connection provides controlled access to machines and networks
outside of the organization vDC. System administrators and organization administrators can configure
network address translation (NAT) and firewall settings on the network's Edge Gateway to make specific
virtual machines in the vDC accessible from an external network.
Prerequisites
n
Verify that you are logged in to the vCloud API as an organization administrator or system administrator.
Procedure
1 Retrieve the list of Edge Gateways in the organization vDC in which you plan to create the routed network.
You can use a query like this one, where href is the value of the href attribute of your organization vDC:
https://vcloud.example.com/api/query?type=edgeGateway&format=records&filter=vdc==
href
If this organization vDC does not contain any Edge Gateways, or does not contain an Edge Gateway that
has the configuration you want, a system administrator can create a new Edge Gateway. See “Create an
Edge Gateway,” on page 151.
2 Choose an Edge Gateway that has interface capacity available.
An Edge Gateway can support a maximum of nine internal and external interfaces. At least one of those
interfaces is typically consumed by a connection to an external network. Creation of a routed organization
vDC network requires the Edge Gateway to have an unused interface available for the new network. To
see how many interfaces each Edge Gateway in your organization vDC is using, you can run the query
shown in Step 1, then add the values of the numberOfExtNetworks and numberOfOrgNetworks attributes. If
the total is less than 9, the Edge Gateway can accommodate a new routed organization vDC network.
3 Create an OrgVdcNetwork element.
a Specify a value of natRouted in the FenceMode element of the network Configuration.
You can specify additional Configuration parameters, as noted in the schema reference.
b Specify the href of the Edge Gateway you chose in Step 1 in the EdgeGateway element.
See the request portion of “Example: Create an Organization vDC Network With a Routed
Connection,” on page 171.
vCloud API Programming Guide
170 VMware, Inc.