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
Provisioning an Organization with
vApps, Templates, and Media 4
The vCloud API provides several ways for you to make vApp templates, vApps, and media images available
to users in an organization.
With the vCloud API, you can upload and download OVF packages, and upload media images. Transfer
operations are characterized as uploads when the operation transfers content from the local host to a remote
host, and as downloads when the local host requests the transfer of content from a remote host. A POST request
initiates uploads, and a GET request initiates downloads. The vCloud Director transfer service facilitates
uploads and downloads and provides temporary storage for files. After they are uploaded, you can add
templates and media images to catalogs as needed.
In addition to uploading, you can use the following operations to provision an organization with vApp
templates, vApps, and media images:
Cloning
The vCloud API clone operation copies a vApp, vApp template, or media
image. You can specify whether to delete the source object after the operation
completes. Deleting the source object after cloning it moves or renames it. After
they are cloned, you can add templates and media images to catalogs as needed.
Capturing
The vCloud API capture operation captures a vApp to create a vApp template.
You can add the captured template to a catalog, download it, or both.
Importing
A system administrator can import a virtual machine from a vCenter server
that is registered to the cloud. You can import the virtual machine as a vApp
or as a vApp template. You can add an imported template to a catalog,
download it, or both.
This chapter includes the following topics:
n
“Summary of vCloud API Provisioning Requests,” on page 54
n
“Upload an OVF Package to Create a vApp Template,” on page 55
n
“Download a vApp Template as OVF,” on page 64
n
“Upload a Media Image,” on page 67
n
“Copying and Moving with the vCloud API,” on page 69
n
“Capturing and Importing vApps,” on page 70
n
“Cataloging vApp Templates and Media Images,” on page 70
n
“View or Change the Owner of an Object,” on page 73
VMware, Inc.
53