5.1
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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- vDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
Provisioning an Organization 4
The vCloud API provides several ways for you to make vApp templates, vApps, media images, and idependent
disks available to users in an organization.
The vCloud API allows you to upload and download OVF packages, and upload media images. Operations
are characterized as uploads when they transfer 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 an upload,
and a GET request initiates a download. 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 to make them available to other users.
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 creates a copy of 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. You can add cloned templates and media images to catalogs.
Capturing
The vCloud API capture operation creates a vApp template from a vApp. You
can add the captured template to a catalog or download it as an OVF package.
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 or
download it as an OVF package.
You can also create independent disks that are contained by an organization vDC and can be connected to any
virtual machine in that vDC.
This chapter includes the following topics:
n
“Summary of vCloud API Provisioning Requests,” on page 56
n
“Upload an OVF Package to Create a vApp Template,” on page 57
n
“Download a vApp Template as OVF,” on page 66
n
“Upload a Media Image,” on page 69
n
“Copying and Moving with the vCloud API,” on page 71
n
“Capturing and Importing vApps,” on page 72
n
“Cataloging vApp Templates and Media Images,” on page 72
n
“Creating and Using Independent Disks,” on page 75
n
“View or Change the Owner of an Object,” on page 79
VMware, Inc.
55