1.5
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
- Provisioning an Organization with vApps, Templates, and Media
- 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
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for 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
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Download a vApp Template as OVF
You can download a vApp template as an OVF package. After you find the template by browsing a catalog,
you can request that the template be enabled for download.
When you enable a vApp template for download, the server performs several operations to create an OVF
package and make it available to the transfer service.
1 The server reconstructs the OVF descriptor using information in the vApp template. The server excludes
any deployment-specific information that the template contains, and populates the descriptor's
References element with links to files, such as .vmdk files, that are part of the package.
2 The server copies the reconstructed OVF descriptor to transfer service storage, along with all files that the
OVF descriptor references.
3 The server updates the vAppTemplate with a link that contains a URL from which you can retrieve the OVF
descriptor.
After the template is enabled for download, you can retrieve it to see the download:default URL for the
descriptor, then parse the descriptor to find the URLs from which you can retrieve the referenced files.
1 Enable the vApp Template for Download on page 64
Before you can download a vApp template, an administrator or privileged user must explicitly enable
it for download.
2 Download the OVF Descriptor on page 65
To download the OVF descriptor, you make a GET request to the download:default URL in the
download-enabled VappTemplate.
3 Download a Referenced File on page 66
After you download the OVF descriptor of a vApp template, you can examine the contents of the
descriptor to discover download URLs for files that the template references.
Enable the vApp Template for Download
Before you can download a vApp template, an administrator or privileged user must explicitly enable it for
download.
Prerequisites
Verify that you are logged in as an administrator or other user who has privileges to enable vApp template
for download.
Procedure
1 Retrieve the template to find its action/enableDownload link.
Every vApp template includes a link of the following form, where id is the id of the template:
<Link
rel="enable"
href="https://vcloud.example.com/api/vAppTemplate/vappTemplate-
id
/action/enableDownload"/>
2 Enable the template for download.
Make a POST request to the template's action/enableDownload URL.
Request:
POST https://vcloud.example.com/api/vAppTemplate/vappTemplate-268/action/enableDownload
vCloud API Programming Guide
64 VMware, Inc.