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 1-1. Link Relationships and HTTP Request Types (Continued)
rel Attribute Value Action or Relationship Description Implied HTTP Verb
power:shutdown Shut down this vApp or virtual
machine.
POST
power:suspend Suspend this vApp or virtual machine. POST
previousPage Reference to the previous page of a
paginated response.
GET
publish Publish this catalog. POST
recompose Recompose this vApp. POST
reconnect Reconnect this vCenter Server to this
cloud.
POST
register Register a VCenter Server to this
cloud.
POST
reject Reject this request. POST
relocate Relocate this virtual machine. POST
remove Remove this object. DELETE
repair Repair this ESX/ESXi host. POST
screen:acquireTicket Retrieve a screen ticket for this virtual
machine.
GET
screen:thumbnail Retrieve a thumbnail view of the
screen of this virtual machine.
GET
task:cancel Cancel this task. POST
blockingTask A list of pending blocking task
requests in this cloud.
GET
taskOwner Reference to the owner of a task GET
taskParams Reference to the request parameters of
a task
GET
taskRequest Reference to the request associated
with a task
GET
undeploy Undeploy this vApp. POST
unlock Unlock a user account POST
unregister Unregister this vCenter Server. POST
up References an object that contains this
object.
GET
updateProgress Request an update of this task's
progress.
POST
upgrade Upgrade this ESX/ESXi host. POST
upload:alternate Reserved, unimplemented. N/A
upload:default References the default location to
which this object can be uploaded.
PUT
vCloud API Programming Guide
14 VMware, Inc.