1.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
- Provisioning an Organization with vApps, Templates, and Media
- 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
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for 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
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
name="VSM-VC-22">
<vmext:Username>Administrator</vmext:Username>
<vmext:Password>Pa55w0rd</vmext:Password>
<vmext:Url>https://10.100.121.66</vmext:Url>
</vmext:ShieldManager>
</vmext:RegisterVimServerParams>
Response:
200 OK
Content-Type: application/vnd.vmware.admin.registerVimServerParams+xml
...
<vmext:RegisterVimServerParams
xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
xmlns:vcloud="http://www.vmware.com/vcloud/v1.5">
<vmext:VimServer
type="application/vnd.vmware.admin.vmwvirtualcenter+xml"
name="VC-22"
href="https://vcloud.example.com/api/admin/extension/vimServer/100">
...
</vmext:VimServer>
<vmext:ShieldManager
...
</vmext:ShieldManager>
</vmext:RegisterVimServerParams>
Finding Available vCenter Resources
Many of the operations required to import virtual machines or create Provider vDCs, external networks, and
network pools require you to identify vCenter resources and obtain references to them. You use these references
to make the vCenter resources available in the cloud.
Every vCenter server registered to your cloud is represented as a VimServerReference element in the cloud's
vimServerReferences list. You can retrieve one of these references to get a detailed representation of the server
object, including links to the server's resource pools, networks, ESX/ESXi hosts, and virtual machines.
Prerequisites
Verify that you are logged in as a system administrator.
Procedure
1 Retrieve the list of vCenter servers registered to this cloud.
Use a request like this one.
GET https://vcloud.example.com/api/admin/extension/vimServerReferences
2 Retrieve the representation of a vCenter server.
The response to the request you made in Step 1 contains a list of VimServerReference elements. You can
make a GET request to any of these references to retrieve the XML representation of a vCenter server
registered to this cloud.
The VimServer element returned in response to the request you made in Step 2 includes several Link elements
where rel="down". These links contain URLs that you can use to retrieve lists of references to vCenter resources
on this server.
n
To see a list of references to the available resource pools, retrieve the resourcePoolList link.
n
To see a list of references to the available networks, retrieve the networks link.
Chapter 7 Using vCloud API Extensions to Provision and Manage a Cloud
VMware, Inc. 167