VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
60 VMware, Inc.
vApp Lifecycle
AvAppcontainsoneormoreVmelements,whichrepresentindividualvirtualmachines.Italsocontains
informationthatdefinesoperationaldetailsforthevAppandthevirtualmachinesitcontains.ThevApp
lifecycleincludesseveraldistinctstates:
 AnOVFpackage,theforminwhichvAppsaretypicallymadeavailablefordownloadanddistribution
 AvApptemplate,createdwhenaclientuploadsanOVFpackagetoavDC
RecomposeavApptoAddor
RemoveVirtualMachines
POST
API‐URL/vApp/vapp‐id/action/
recomposeVApp
RecomposeVAppParams Task
CaptureavApptoCreatea
vAppTemplate
POSTAPI‐URL/vdc/id/action/
captureVApp
CaptureVAppParams VAppTemplate
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/
power/action/powerOn
None Task
PowerOffavApporVirtual
Machine
POSTvApp‐or‐Vm‐URL/
power/action/powerOff
None Task
ResetavApporVirtual
Machine
POSTvApp‐or‐Vm‐URL/
power/action/reset
None Task
SuspendavApporVirtual
Machine
POSTvApp‐or‐Vm‐URL/
power/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/
power/action/shutdown
None 204NoContent
RebootavApporVirtual
Machine
POSTvApp‐or‐Vm‐URL/
power/action/reboot
None 204NoContent
InsertMediaIntoaVirtual
Machine
POST
API‐URL/vApp/vm‐id/
media/action/insertMedia
MediaInsertOrEjectParams Task
EjectMediafromaVirtual
Machine
POSTAPI‐URL/vApp/vm‐id/
media/action/ejectMedia
MediaInsertOrEjectParams Task
ListMediaDevicesofa
VirtualMachine
GETAPI‐URL/vApp/vm‐id/
virtualHardwareSection/media
None RasdItemsList
GetaRequestforUserInput GETAPI‐URL/vApp/vm‐id/
question
None VmPendingQuestion
ProvideRequestedUser
Input
POSTAPI‐URL/vApp/vm‐id/
question/action/answer
VmQuestionAnswer 204NoContent
GetaScreenThumbnailfora
VirtualMachine
GETAPI‐URL/vApp/vm‐id/
screen
None screenthumbnail
(Content‐type :image/png)
GetaScreenTicketfora
VirtualMachine
POSTAPI‐URL/vApp/vm‐id/
screen/action/acquireTicket
None ScreenTicket
ControlAccesstovApps POST
API‐URL/vApp/vapp‐id/action/
controlAccess
ControlAccessParams ControlAccessParams
RetrieveaTask GETAPI‐URL/task/id None Task
Table 5-1. Summary of Datacenter Operations Requests (Continued)
Operation Request Request Body Response

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English