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
Table 7-1. Summary of vSphere Platform Extension Requests
Operation Request Request Body Response
Retrieve a list of provider
vDCs in a cloud.
GET API-
URL/admin/extension/
providerVdcReferences
None
VMWProviderVdcReference
s
Retrieve a list of external
networks in a cloud.
GET API-
URL/admin/extension/
externalNetworkReference
s
None
VMWExternalNetworkRefer
ences
Retrieve a list of network
pools in a cloud.
GET API-
URL/admin/extension/
networkPoolReferences
None
VMWNetworkPoolReference
s
Retrieve a list of vCenter
servers registered to a cloud.
GET API-
URL/admin/extension/vim
ServerReferences
None
VMWVimServerReferences
Retrieve information about a
vCenter server.
GET API-
URL/admin/extension/vim
Server/id
None
VimServer
Retrieve a list of available
resource pools on a vCenter
server.
GET API-
URL/admin/extension/vim
Server/id/resourcePoolList
None
ResourcePoolList
Update vCenter server
settings.
PUT API-
URL/admin/extension/vim
Server/id
VimServer Task
Register a vCenter server and
vShield manager.
POST API-
URL/admin/extension/
action/registervimserver
RegisterVimServerParam
s
RegisterVimServerParams
Unregister a vCenter server
and vShield manager.
POST API-
URL/admin/extension/
action/unregister
None
Task
Force reconnection to a
vCenter server.
POST API-
URL/admin/extension/
vimServer/id/
action/forcevimserverreco
nnect
None
Task
Retrieve a list of ESX/ESXi
hosts in a cloud.
GET API-
URL/admin/extension/host
References
None
VMWHostReferences
Retrieve information about a
host.
GET API-
URL/admin/extension/hos
t/id
None
Host
Prepare a host. POST API-
URL/admin/extension/hos
t/id/action/prepare
PrepareHostParams Task
Unprepare a host. POST API-
URL/admin/extension/hos
t/id/action/unprepare
None
Task
Enable a host. POST API-
URL/admin/extension/hos
t/id/action/enable
None
Task
Disable a host. POST API-
URL/admin/extension/hos
t/id/action/disable
None
Task
vCloud API Programming Guide
162 VMware, Inc.