5.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
- 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 or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- 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
- Managing and Monitoring a Cloud
- Summary of System Administration 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
Table 10‑11. Blocking Task Operations for Resource Creation Tasks
Operation Name Description
rclCreateProviderVdc Create a provider VDC.
rclDeleteProviderVdc Delete a provider VDC.
rclDisableHost Disable a host.
rclEnableHost Enable a host.
rclEnableVxlanForProviderVdc Enable a VXLAN pool associated with a new Provider VDC.
rclMergePvdc Merge Provider VDCs.
rclPrepareHost Prepare a host
rclRedeployAllVms Redeploy all virtual machines on this host.
rclRepairHost Repair a host.
rclUnprepareHost Unprepare a host
rclUpdateHost Update host operating system.
rclUpdateProviderVdcStorageProfiles Update provider VDC storage profiles in this cluster.
rclUpdateResourcePoolSet Update resource pools in this cluster.
rclUpgradeHostAgent Upgrade the host agent on a host.
Table 10‑12. Blocking Task Operations for Miscellaneous Tasks
Operation Name Description
commonPurgeDeletedItem Purge a deleted item.
importIntoExistingVapp Import a virtual machine from vCenter to an existing vApp.
importLocalizationResource Import external localization resources.
importMedia Import a media object from vSphere.
importSingletonTemplate Import a virtual machine from vCenter as a vApp template.
importSingletonVapp Import a virtual machine from vCenter as a vApp.
catalogDelete Delete a catalog.
catalogDeleteBacking Delete the file(s) representing a catalog item.
catalogItemEnableDownload Enable a catalog item for download
catalogSync Update a subscribed catalog item from its external source.
catalogSyncAll Update an externally subscribed catalog from its source.
metadataDelete Delete a metadata item.
metadataUpdate Update a metadata item.
vdcUploadMedia Upload media.
vdcUploadOvfContents Upload other OVF package contents
vdcUploadOvfDescriptor Upload an OVF descriptor
Chapter 10 Configuring and Using Blocking Tasks and Notifications
VMware, Inc. 323