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
Task Operations
Requests that you can configure as blocking tasks are represented by task operation names.
To configure a request type as a blocking task, place the operation name in an Operation element and add
that element to the cloud's BlockingTaskOperations element. See “Retrieve or Update Blocking Task
Settings,” on page 318.
NOTE These operation names also appear in the operationName attribute of the Task element that tracks the
operation.
Table 10‑6. Blocking Task Operations for vApp Tasks
Operation Name Description
vappAttachDisk Attach an independent disk to any virtual machine in a vApp.
vappCheckVmCompliance Check the storage profile compliance of a virtual machine.
vappConsolidateVm Consolidate the disks of any virtual machine in a vApp.
vappCreateSnapshot Create a snapshot for the vApp
vappDeleteShadowVm Delete a shadow VM for any virtual machine in a vApp.
vappDeploy Deploy a vApp.
vappDetachDisk Detach an independent disk from any virtual machine in a vApp.
vappDiscardSuspendedState Discard the suspended state of any virtual machine in a vApp.
vappEjectCdFloppy Eject media from any virtual machine in a vApp.
vappInsertCdFloppy Insert media in any virtual machine in a vApp.
vappInstallTools Install VMware Tools on any virtual machine in a vApp.
vappMigrateVms Migrate the virtual machines in a vApp to a new host.
vappPowerOff Power-off a vApp.
vappRebootGuest Reboot any virtual machine in a vApp.
vappRelocateVm Relocate any virtual machine in a vApp.
vappRemoveAllSnapshots Remove all snapshots for this vApp
vappReset Reset any virtual machine in a vApp.
vappResume Resume any virtual machine in a vApp.
vappRevertToCurrentSnapshot Revert the vApp to its current snapshot
vappShutdownGuest Shut down any virtual machine in a vApp.
vappSuspend Suspend any virtual machine in a vApp.
vappUndeployPowerOff Undeploy any virtual machine in a vApp by powering it off.
vappUndeploySuspend Undeploy any virtual machine in a vApp by suspending it.
vappUpdateVm Modify one or more properties of a virtual machine.
vappUpgradeHwVersion Upgrade the hardware version of any virtual machine in a vApp.
Table 10‑7. Blocking Task Operations for VDC Tasks
Operation Name Description
vdcCaptureTemplate Capture a vApp as a vApp template.
vdcComposeVapp Compose a vApp.
vCloud API Programming Guide
320 VMware, Inc.