VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
42 VMware, Inc.
Upload OVF to Create a vApp Template
AvCloudAPIclientthathasaccesstoanOVFpackagecanuseasimpleworkflowtouploadthepackageand
createavApptemplate.
1TheclientPOSTsaninitialrequestthatspecifiesanameforthetemplate,atransferformatforthedata,
andanoptionaldescription.
2Theserverreturnsan
unresolved(status="0")vAppTemplatedocumentthatincludesanuploadURL
fortheOVFpackage.
3TheclientusesanHTTPPUTrequesttouploadtheOVFpackagedescriptor(the .ovffile)totheupload
URL.
4TheserverreadsthedescriptorandconstructsacompletevAppTemplatedocument(onethatincludesan
uploadURLfor
eachfilelistedintheReferencessectionofthedescriptor).Whiletheserverisconstructing
thisdocument,theclientmakesperiodicrequestsforitandexaminestheresponseforadditionalupload
URLs.WhentheresponsecontainsanyuploadURLsbeyondtheonereturnedinStep2,templateis
complete
5Theclient
usesHTTPPUTrequeststouploadeachofthefiles.
6IftheOVFpackageincludesamanifestfile,theentireuploadisvalidatedagainstthecontentsofthe
manifestfile.
EnableavAppTemplatefor
Download
POSTAPI‐URL/vAppTemplate/
vAppTemplate‐id/action/enableDownload
None Task
DisableavAppTemplate
forDownload
POSTAPI‐URL/vAppTemplate/
vAppTemplate‐id/action/disableDownload
None 204No
Content
Uploada MediaImage POSTAPI‐URL/vdc/id/media Media Media
CopyorMoveaMedia
Image
POSTAPI‐URL/vdc/id/action/cloneMedia CloneMediaParams Media
CopyorMoveavApp
Template
POSTAPI‐URL
/vdc/id/action/
cloneVAppTemplate
CloneVAppTemplateParams VAppTemplate
CopyorMoveavApp POSTAPI‐URL/vdc/id/action/cloneVApp CloneVAppParams VApp
ChangetheNameor
Descriptionofa
vAppTemplate
PUTAPI‐URL/vAppTemplate/vappTemplate‐id VAppTemplate Task
ChangetheNameor
DescriptionofavApp
PUTAPI‐URL/vApp/vapp‐id VApp Tas k
ChangetheNameor
DescriptionofaMedia
Image
PUTAPI‐URL/media/id Media Task
DeleteavAppTemplate,

vApp,orMediaImage
DELETEobject‐URL None Task
AddanItemtoaCatalog POSTAPI‐URL/catalog/id/catalogItems CatalogItem CatalogItem
RemoveanItemfroma
Catalog
DELETEAPI‐URL/
catalog/id/catalogItem/id
None 204Nocontent
ControlAccesstoCatalogs POST
API‐URL/catalog/id/action/
controlAccess
ControlAccessParams ControlAccess
Params
Table 4-1. Summary of Provisioning 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