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
Procedure
1 Choose the external network to which this organization VDC network will connect.
This external network must be one of the ones listed in the AvailableNetworks element of the Provider
VDC that backs the organization VDC in which you are creating the new network. Follow these steps to
find a suitable external network.
a Retrieve the XML representation of the organization VDC in which you are creating the new
network.
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.
<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>
2 Create an OrgVdcNetwork element.
a Specify the href of the external network you chose in Step 1 in the ParentNetwork element.
The type and name attributes are optional here.
b Set the FenceMode to bridged.
This creates a direct connection to the parent network.
See the request portion of “Example: Create an Organization VDC Network With a Direct Connection,”
on page 190.
3 POST the OrgVdcNetwork element you created in Step 2 to the URL for adding networks to the
organization VDC.
See the request portion of “Example: Create an Organization VDC Network With a Direct Connection,”
on page 190.
Chapter 6 Creating and Managing Organizations
VMware, Inc. 189