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 5-1. Summary of vCloud API Operations Requests (Continued)
Operation Request Request Body Response
Retrieve product sections of a
vApp template [NEW]
GET API-
URL/vAppTemplate/vappT
emplate-id/productSections
None
ProductSectionList
Update product sections of a
vApp template [NEW]
PUT API-
URL/vAppTemplate/vappT
emplate-id/productSections
ProductSectionList Task
Retrieve version of VMware
Tools installed on a virtual
machine [NEW]
GET Vm-
URL/runtimeInfoSection
None
RuntimeInfoSection
Install VMware Tools on a
virtual machine [NEW]
POST Vm-
URL/action/installVMware
Tools
None
Task
Consolidate a virtual
machine [NEW]
POST Vm-
URL/action/consolidate
None
Task
Upgrade the hardware
version of a virtual machine
[NEW]
POST Vm-
URL/action/upgradeHardw
areVersion
None
Task
Insert Media Into a Virtual
Machine
POST Vm-
URL/action/insertMedia
MediaInsertOrEjectPara
ms
Task
Eject Media from a Virtual
Machine
POST Vm-
URL/action/ejecttMedia
MediaInsertOrEjectPara
ms
Task
List Media Devices of a
Virtual Machine
GET Vm-URL/
virtualHardwareSection/m
edia
None
RasdItemsList
Get a Request for User Input GET Vm-URL/question None
VmPendingQuestion
Provide Requested User
Input
POST Vm-
URL/question/action/answ
er
VmQuestionAnswer
204 No Content
Get a Screen Thumbnail for a
Virtual Machine
GET Vm-URL/screen None Returns a screen thumbnail
(Content-type: image/png) if
one is available. Otherwise
returns null (Content-Length:
0).
Get a Screen Ticket for a
Virtual Machine
POST Vm-URL/
screen/action/acquireTicket
None
ScreenTicket
Create a vApp From a Template
An instantiateVAppTemplate request creates a vApp from a vApp template. By default, this operation also
deploys the vApp and powers it on.
To create a vApp from a vApp template, you must bind the template's abstract resource requirements, such
as network connections, storage resources, memory, and CPU capacity, to appropriate resources in the target
vDC. This binding operation is called instantiation.
For an example of a simple instantiation request, see “Deploy the vApp,” on page 31. You can also specify
additional parameters as part of instantiation.
vCloud API Programming Guide
78 VMware, Inc.