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
Summary of vCloud API vApp and Virtual Machine Operations Requests
These vCloud API operations requests create, manage, operate, and delete vApps and the virtual machines
that they contain.
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.
n
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)
n
Vm-URL is a URL of the form API-URL/vApp/vm-id
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms shown in the table 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.
Table 5-1. Summary of vCloud API Operations Requests
Operation Request Request Body Response
Instantiate a vApp template POST API-URL/vdc/id/
action/instantiateVAppTe
mplate
InstantiateVAppTemplat
eParams
VApp
Compose a vApp POST API-URL/vdc/id/
action/composeVApp
ComposeVAppParams VApp
Recompose a vApp to add or
remove virtual machines
POST API-
URL/vApp/vapp-id/
action/recomposeVApp
RecomposeVAppParams Task
Deploy a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/deploy
DeployVAppParams Task
Undeploy a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/undeploy
UndeployVAppParams Task
Power On a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/powerOn
None
Task
Power Off a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/powerOff
None
Task
Reset a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/reset
None
Task
Suspend a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/suspend
None
Task
Discard the Suspended State
of a vApp or Virtual Machine
POST VApp-or-Vm-
URL/action/
discardSuspendedState
None
Task
Shut Down a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/shutdown
None
Task
Reboot a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/reboot
None
Task
Retrieve product sections of a
vApp or virtual machine
[NEW]
GET VApp-or-Vm-
URL/productSections
None
ProductSectionList
Update product sections of a
vApp or virtual machine
[NEW]
PUT VApp-or-Vm-
URL/productSections
ProductSectionList Task
Chapter 5 Deploying and Operating vApps
VMware, Inc. 77