VMware VCLOUD API 1.0 - API - Enable a Vapp Template for Download

vCloud API Programming Guide
48 VMware, Inc.
Enable a vApp Template for Download
AvApptemplatemustbeexplicitlyenabledfordownloadbyanadministratororprivilegeduser.
Example 4‐10showssucharequest.TheresponseisaTaskelement.Thetimerequiredforthetasktocomplete
isdeterminedbythenumberandsizeofthefilescomprisingthetemplate.
Example 4-10. Enable a vApp Template for Download
Request:
POST http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-268/action/enableDownload
Response:
202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task ... operation="Enabling download of Virtual Application Template Ubuntu Template (268)" ...
>
...
</Task>
WhentheenableDownloadtaskcompletes,thetemplate’sfilesareavailablefromthevCloudtransferservice,
andthevAppTemplateincludesaLinkelementthatcontainsaURLfromwhichthetemplate’sOVFdescriptor
canbedownloaded,asshowninExample 4‐11.
Example 4-11. vApp Template with DownloadURL for OVF Descriptor
Request:
GET http://vcloud.example.com/api/vAppTemplate/vappTemplate-268
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.vAppTemplate+xml
...
<VAppTemplate ovfDescriptorUploaded="true" status="8" name="Ubuntu Template"
type="application/vnd.vmware.vcloud.vAppTemplate+xml"
href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-268" ...>
...
<Link type="text/xml" rel="download:default"
href="http://vcloud.example.com/transfer/.../descriptor.ovf"/>
...
</VAppTemplate>
Theclientusesthisdownload:defaultURLinaGETrequestthatdownloadstheOVFdescriptor(asshown
inExample 4‐12),thenexaminesthecontentsofthedescriptortodiscoverthehrefvaluesfortheremaining
filesinthetemplate’sReferencescontainer.
Example 4-12. Downloading the OVF Descriptor
Request:
GET http://vcloud.example.com/transfer/..../descriptor.ovf
Response:
200 OK
...
<Envelope ...>
<References>
<File ovf:href="disk0.vmdk" ovf:id="file1" ovf:size="1950489088"/>
</References>
<DiskSection>
<Info>Virtual disk information</Info>