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
rel Attribute Value Action or Relationship Description Implied HTTP Verb
add Add an item to this container. POST
alternate References an alternate representation
of this object.
GET
catalogItem References the CatalogItem object
that refers to this object.
GET
collaboration:abort Abort this blocking task. POST
collaboration:fail Fail this blocking task. POST
collaboration:resume Resume this blocking task. POST
consolidate Consolidate this virtual machine. POST
controlAccess Apply access controls. POST
copy Reserved, unimplemented. N/A
deploy Deploy this vApp. POST
disable Disable this object. POST
discardState Discard the suspended state of this
virtual machine.
POST
down References an object contained by this
object.
GET
download:alternate Reserved, unimplemented. N/A
download:default References the default location from
which this file can be downloaded.
GET
edit Modify this object. PUT
enable Enable this object. POST
firstPage Reference to the first page of a
paginated response.
GET
installVmwareTools Install VMware Tools on this virtual
machine.
POST
lastPage Reference to the last page of a
paginated response.
GET
media:ejectMedia Eject virtual media from a virtual
device.
POST
media:insertMedia Insert virtual media into a virtual
device.
POST
move Reserved, unimplemented. N/A
nextPage Reference to the next page of a
paginated response.
GET
ova Reserved, unimplemented N/A
ovf References the OVF descriptor of this
vApp template.
GET
power:powerOff Power off this vApp or virtual
machine.
POST
power:powerOn Power on this vApp or virtual
machine.
POST
power:reboot Reboot this vApp or virtual machine. POST
power:reset Reset this vApp or virtual machine. POST
Chapter 1 About the VMware vCloud API
VMware, Inc. 13