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
Table 4-1. Summary of Provisioning Requests (Continued)
Operation Request Request Body Response
Control access to catalogs. POST API-
URL/catalog/
id/action/controlAccess
ControlAccessParams ControlAccessParams
Retrieve the owner of a media
object. [NEW]
GET API-
URL/media/id/owner
None
Owner
Retrieve the owner of a vApp
template [NEW]
GET API-
URL/vAppTemplate/vappT
emplate-id/owner
None
Owner
Retrieve the owner of a vApp
[NEW]
GET API-
URL/vApp/id/owner
None
Owner
Update the owner of a vApp
[NEW]
PUT API-
URL/vApp/id/owner
Owner
204 No Content
Upload an OVF Package to Create a vApp Template
A vCloud API client that has access to an OVF package can use a standard workflow to upload the package
and create a vApp template.
The initial configuration of a vApp is established in the OVF package on which its source template is based.
In the vCloud API, vApp templates are based OVF 1.0, an open standard format. For more information about
OVF and how the vCloud API uses it, see “About OVF,” on page 75.
An OVF package includes several kinds of files.
An OVF descriptor
An XML file that contains metadata that describe a virtual machine or collection
of related virtual machines and the deployment environment they require. By
convention, this file has the suffix .ovf.
Virtual disk files
The descriptor lists these files and includes information about their format.
An optional certificate
You can use this file to certify the authenticity of the package.
An optional manifest
Contains a SHA-1 digest of each of the files in the package.
Upload Workflow
The upload workflow for OVF packages uses a combination of vCloud API requests and standard HTTP file
transfer requests.
1 The client uses a POST request that specifies a name and description for the template, and a transfer format
for the data.
2 The server returns an unresolved VAppTemplate element with (status="0") that includes an upload URL
for the OVF descriptor.
3 The client uses an HTTP PUT request to upload the descriptor to the upload URL.
4 The server reads the descriptor and modifies the vAppTemplate to include an upload URL for each file
listed in the References section of the descriptor. While the server is modifying the vAppTemplate, the client
makes periodic requests for it and examines the response for additional upload URLs. When the response
contains additional upload URLs that were not present in the initial response, template construction is
complete.
5 The client uses HTTP PUT requests to upload each of the files.
6 If the OVF package includes a manifest file, the entire upload is validated against the contents of the
manifest file.
Chapter 4 Provisioning an Organization with vApps, Templates, and Media
VMware, Inc. 55