5.1
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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- vDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
Table 5-1. Summary of vApp and Virtual Machine Operations Requests (Continued)
Operation Request Request Body Response
Reboot a vApp or Virtual
Machine
POST VApp-or-Vm-
URL/action/reboot
None
Task
Retrieve product sections of a
vApp or virtual machine
GET VApp-or-Vm-
URL/productSections
None
ProductSectionList
Update product sections of a
vApp or virtual machine
PUT VApp-or-Vm-
URL/productSections
ProductSectionList Task
Retrieve product sections of a
vApp template
GET API-
URL/vAppTemplate/vappT
emplate-id/productSections
None
ProductSectionList
Retrieve version of VMware
Tools installed on a virtual
machine
GET Vm-
URL/runtimeInfoSection
None
RuntimeInfoSection
Install VMware Tools on a
virtual machine
POST Vm-
URL/action/installVMware
Tools
None
Task
Consolidate a virtual
machine
POST Vm-
URL/action/consolidate
None
Task
Upgrade the hardware
version of a virtual machine
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/ejectMedia
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/acquire
Ticket
None
ScreenTicket
Attach an independent disk
to a virtual machine. [NEW]
POST Vm-
URL/disk/action/attach
DiskAttachOrDetachPara
ms
Task
Detach an independent disk
from a virtual machine.
[NEW]
POST Vm-
URL/disk/action/detach
DiskAttachOrDetachPara
ms
Task
Create snapshots of all virtual
machines in a vApp. [NEW]
POST API-
URL/vApp/vapp-id/
action/createSnapshot
CreateSnapshotParams Task
Remove snapshots of all
virtual machines in a vApp.
[NEW]
POST API-
URL/vApp/vapp-id/
action/removeAllSnapshots
None
Task
vCloud API Programming Guide
84 VMware, Inc.