1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
VMware, Inc. 43
Chapter 4 Provisioning
Bothmonolithicandranged(chunked)PUTsaresupported.Afterstartinganupload,aclientcanmake
periodicrequeststodetermineitsprogress.Afterallthefilesareuploaded(andvalidatedifamanifestis
present),theserverprocessestheuploads.Whenprocessingiscomplete,theserversetsthevalueofthe
template’sstatusattributeto8,indicatingthatthetemplateisreadyforuse.(Thisstatusvalueindicatesthat
allofthevirtualmachinesinthetemplatearepoweredoff.Formoreinformation,includingacompletelistof
possiblestatusvaluesandtheirmeanings,see“status”onpage 144.)
Restrictions on Uploaded Content
ThisreleaseofthevCloudAPIimposesthefollowingrestrictionsonuploadedOVFcontent:
YoucanuploadeitherOVF1.0orOVF1.1content.OVF1.1packagesareconvertedtoOVF1.0for
download,andanyOVF1.1contentislost.
YoucannotuploadacompressedOVFpackage.
IfyouuploadanOVFpackageinwhichanyVirtualSystemelementhasanovf:idattributevaluethat
islongerthan13characters,thenameoftheVmthatrepresentstheVirtualSysteminthevAppTemplate
createdbytheuploadisrewrittenasthefirst13charactersoftheovf:id attributefollowedby
three
digits.Forexample,NewVirtualMachine1andNewVirtualMachine2becomeNewVirtualMa001and
NewVirtualMa002.
Initiate the Upload
Toinitiatetheupload,aclientmakesanHTTPPOSTrequestspecifyingatargetvDCandan
uploadVAppTemplateaction.Therequestbody,showninExample 4‐1,isanUploadVAppTemplateParams
element.
Example 4-1. uploadVappTemplate Request
POST http://vcloud.example.com/api/v1.0/vdc/5/action/uploadVAppTemplate
Content-Type: application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml
<UploadVAppTemplateParams name="Ubuntu Template" xmlns="http://www.vmware.com/vcloud/v1" >
<Description>Ubuntu vApp Template</Description>
</UploadVAppTemplateParams>
ThisrequestcreatesanewVAppTemplateobjectinthetargetvDCandreturnstheobjectʹsXMLrepresentation
inaresponse,asshowninExample 4‐2.
Example 4-2. Unresolved vAppTemplate Body with Upload URL for OVF Descriptor
201 Created
Content-Type: application/vnd.vmware.vcloud.vAppTemplate+xml
<VAppTemplate name="Ubuntu Template"
href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-268" status="0"
ovfDescriptorUploaded="false"
type="application/vnd.vmware.vcloud.vAppTemplate+xml" ... >
<Link rel="up" type="application/vnd.vmware.vcloud.vdc+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5"/>
...
<Description>Ubuntu vApp Template</Description>
<Files>
<File name="descriptor.ovf" bytesTransferred="0">
<Link rel="upload:default"
href="http://vcloud.example.com/transfer/.../descriptor.ovf"/>
</File>
</Files>
</VAppTemplate>