Datacenter Operations; Summary Of Datacenter Operations Requests - VMware VCLOUD API 1.0 - API Programming Manual

5

Datacenter Operations

The vCloud API supports programmatic access to a range of self‐service datacenter operations that allow users
to create, configure, operate, and connect to vApps.
This chapter includes the following topics:

"Summary of Datacenter Operations Requests" on page 59

"vApp Lifecycle" on page 60

"Instantiate a vApp Template" on page 61

"Compose a vApp" on page 65

"Recompose a vApp to Add or Remove Virtual Machines" on page 67

"Capture a vApp to Create a vApp Template" on page 68

"Reconfiguring vApps and Virtual Machines" on page 69

"Deploying and Controlling vApps and Virtual Machines" on page 80

"Control Access to vApps" on page 89

"Retrieve a Task" on page 89

Summary of Datacenter Operations Requests

Table 5‐1 summarizes datacenter operations requests supported in this release. The table uses the following
conventions:

API‐URL is a URL of the form http://vcloud.example.com/api/v1.0

id is an integer

vApp‐or‐Vm‐URL is a URL of the form API‐URL/vApp/vapp‐id (for a vApp object) or
API‐URL/vApp/vm‐id (for a Vm object)
Table 5-1. Summary of Datacenter Operations Requests
Operation
Instantiate a vApp Template
Retrieve vApp Template
CustomizationSection
Modify vApp Template
CustomizationSection
Compose a vApp
VMware, Inc.
Request
POST API‐URL/vdc/id/action/
instantiateVAppTemplate
GET API‐URL/vAppTemplate/
vappTemplate‐id/
customizationSection
PUT API‐URL/vAppTemplate/
vappTemplate‐id/
customizationSection
POST API‐URL/vdc/id/action/
composeVApp
Request Body
InstantiateVAppTemplateParams
None
CustomizationSection
ComposeVAppParams
5
Response
VApp
CustomizationSection
Task
VApp
59