5.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
- 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 or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- 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
- Managing and Monitoring a Cloud
- Summary of System Administration 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
<IpRanges />
<UseForDefaultRoute>false</UseForDefaultRoute>
</GatewayInterface>
<GatewayInterface>
<Name>vnic3</Name>
<DisplayName>routed2</DisplayName>
<Network
type="application/vnd.vmware.admin.network+xml"
name="routed2"
href="https://vcloud.example.com/api/admin/network/67" />
<InterfaceType>internal</InterfaceType>
<SubnetParticipation>
<Gateway>172.168.0.1</Gateway>
<Netmask>255.255.255.0</Netmask>
<IpAddress>172.168.0.1</IpAddress>
</SubnetParticipation>
<IpRanges />
<UseForDefaultRoute>false</UseForDefaultRoute>
</GatewayInterface>
n
The organization VDC network named routed1 has Gateway address 192.168.3.1.
n
The organization VDC network named routed2 has Gateway address 172.168.0.1.
n
The Configuration of the vApp network in vApp1 has a RouterInfo element whose ExternalIp value is
192.168.2.100.
n
The Configuration of the vApp network in vApp2 has a RouterInfo element whose ExternalIp value is
192.168.1.100.
A StaticRoutingService defined by the following fragment creates a static route to vApp1 from network
routed1, and a static route to vApp2 from network routed2.
<StaticRoutingService>
<IsEnabled>true</IsEnabled>
<StaticRoute>
<Name>TovApp1</Name>
<Network>192.168.2.0/24</Network>
<NextHopIp>192.168.3.10</NextHopIp>
<Interface>Internal</Interface>
<GatewayInterface
type="application/vnd.vmware.vcloud.orgVdcNetwork+xml"
name="routed1"
href="https://vcloud.example.com/api/admin/network/29" />
</StaticRoute>
<StaticRoute>
<Name>TovApp2</Name>
<Network>192.168.1.0/24</Network>
<NextHopIp>172.168.0.10</NextHopIp>
<Interface>Internal</Interface>
<GatewayInterface
type="application/vnd.vmware.vcloud.orgVdcNetwork+xml"
name="routed2"
href="https://vcloud.example.com/api/admin/network/67" />
</StaticRoute>
</StaticRoutingService>
To add this service to an Edge Gateway, include it in an EdgeGatewayServiceConfiguration. See
“Example: Configure Services on an Edge Gateway,” on page 178.
Chapter 6 Creating and Managing Organizations
VMware, Inc. 183