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
type="application/vnd.vmware.admin.role+xml"
name="Catalog Creator"
href="https://vcloud.example.com/api/admin/role/103" />
<RoleReference />
</RoleReferences>
<Networks>
<Network
type="application/vnd.vmware.admin.network+xml"
name="ExternalNetwork-VC1"
href="https://vcloud.example.com/api/admin/network/7" />
<Network
type="application/vnd.vmware.admin.network+xml"
name="ExternalNetwork-VC2"
href="https://vcloud.example.com/api/admin/network/33" />
</Networks>
</VCloud>
Retrieve a List of vSphere Platform Operations and Objects for a Cloud
A successful login by a system administrator returns a Session element that contains a link that you can use
to retrieve a VMWExtension element.
Every vCloud Director installation depends on vSphere platform resources such as vCenter, ESX/ESXi, and
vShield Manager. The VMWExtension element provides access to a cloud-wide namespace of vSphere platform
objects that are registered for use by the cloud, and links that allow you to add vSphere servers and related
resources such as networks and resource pools to your cloud. The administrative extensions to the vCloud API
provide a system administrator with programmatic access to these resources.
Prerequisites
Use the credentials of a system administrator to create a login session. See “Create a Login Session,” on
page 44.
Procedure
1 Retrieve the XML representation of your Session object.
Use a request like this one:
GET https://vcloud.example.com/api/session
2 Examine the contents of the Session element to locate the link to the VMWExtension object.
This link has the following form:
<Link
rel="down"
type="application/vnd.vmware.admin.vmwExtension+xml"
href="https://vcloud.example.com/api/admin/extension"/>
3 Retrieve the list of organizations by making a GET request to the href value of the Link described in
Step 2.
The request returns a VMWExtension element, as shown in “Example: Retrieve a List of vSphere Platform
Operations and Objects for a Cloud,” on page 49.
Example: Retrieve a List of vSphere Platform Operations and Objects for a Cloud
Request:
GET https://vcloud.example.com/api/admin/extension
Chapter 3 Exploring a Cloud
VMware, Inc. 49