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
Response:
202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task
...
operation="Enabling download of Virtual Application Template Ubuntu Template (268)" ... >
...
</Task>
The Task in the response tracks the creation of the download package.
3 When the task completes, retrieve the template, which now contains a download URL for the OVF
descriptor.
This URL remains valid while a transfer session is in progress, and for a maximum of 60 minutes of transfer
session idle time. A system administrator can change this default value. See “Retrieve or Update System
Settings,” on page 165.
Example: vApp Template with Download URL for OVF Descriptor
Request:
GET https://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"
... >
...
<Link type="text/xml"
rel="download:default"
href="https://vcloud.example.com/transfer/.../descriptor.ovf"/>
...
</VAppTemplate>
Download the OVF Descriptor
To download the OVF descriptor, you make a GET request to the download:default URL in the download-
enabled VappTemplate.
Prerequisites
n
Verify that you are logged in as a system administrator or member of an organization in the cloud.
n
Verify that you have a vApp template that is enabled for download. See “Enable the vApp Template for
Download,” on page 64.
Procedure
1 Examine the VAppTemplate to find the the download:default URL for the descriptor.
2 Make a GET request to the download:default URL to retrieve the descriptor
See “Example: Downloading the OVF Descriptor,” on page 66.
Chapter 4 Provisioning an Organization with vApps, Templates, and Media
VMware, Inc. 65