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
Using vCloud API Extensions to
Provision and Manage a Cloud 7
The VMware vCloud API includes extensions that support operations on the vSphere platform, which provides
resources to vCloud Director. A system administrator can use these extensions to retrieve or update the
configuration of a cloud, add or remove resources such as vCenter servers, network pools and external
networks, and import vApps and media from vCenter.
Only the system administrator can perform vSphere platform operations. Before you attempt these operations,
log in to the System organization with the user name and password of the system administrator account that
was created when vCloud Director was installed. See “Administrator Credentials and Privileges,” on
page 111.
This chapter includes the following topics:
n
“Summary of vSphere Platform Extension Requests,” on page 161
n
“Retrieve or Update System Settings,” on page 165
n
“Attach a vCenter Server,” on page 166
n
“Finding Available vCenter Resources,” on page 167
n
“Create a Provider vDC,” on page 173
n
“Create an External Network,” on page 180
n
“Create a Network Pool,” on page 183
n
“Import a Virtual Machine from vCenter,” on page 189
n
“Relocate a Virtual Machine to a Different Datastore,” on page 192
Summary of vSphere Platform Extension Requests
vSphere platform extension requests allow a system administrator to operate on vSphere platform objects
registered to vCloud Director.
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
id is a unique identifier in the form of a UUID, as defined by RFC 4122.
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only. For more information about the requests and responses for each
operation, see “About the Schema Reference Downloadable Archive,” on page 19.
VMware, Inc.
161