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
Add a vDC to an Organization
A system administrator can allocate resources from a provider vDC to a vDC in an organization by POSTing
a CreateVdcParams element to an organization’s add URL for vDCs.
Prerequisites
Verify that you are logged in to the vCloud API as a system administrator.
Retrieve the list of network pools. Several types of organization vDC networks require the vDC to include a
network pool, which you can specify when you create or update the vDC. See “Retrieve a List of External
Networks and Network Pools,” on page 204 for information about how to retrieve this list.
Procedure
1 Retrieve the XML representation of the organization to which you want to add the vDC.
Use a request like this one:
GET https://vcloud.example.com/api/admin/org/26
2 Examine the response to locate the Link element that contains the URL for adding vDCs to the organization.
This element has a rel attribute value of add and a type attribute value of
application/vnd.vmware.admin.createVdcParams+xml, as shown here:
<Link
href="https://vcloud.example.com/api/admin/org/26/vdcsparams"
rel="add"
type="application/vnd.vmware.admin.createVdcParams+xml"/>
3 Choose a provider vDC to supply resources for the new organization vDC.
a Retrieve the XML representation of the VCloud object and examine the ProviderVdcReferences element
it contains.
The following request retrieves the representation of the VCloud object:
GET https://vcloud.example.com/api/admin
The VCloud element contains a ProviderVdcReferences element. Each provider vDC in the system is
represented in that element by a ProviderVdcReference element, as shown here:
<ProviderVdcReference
type="application/vnd.vmware.admin.providervdc+xml"
name="Main Provider"
href="https://vcloud.example.com/api/admin/providervdc/2"/>
b (Optional) List the organization vDCs that each ProviderVdc supports.
The following request retrieves the list of organization vDCs that .../providervdc/2 supports:
GET https://vcloud.example.com/api/admin/providervdc/2/vdcReferences
Taking this optional step can help you allocate ProviderVdc resources equitably across the
organization vDCs in a cloud.
vCloud API Programming Guide
140 VMware, Inc.