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
Routing key components include:
operationSuccess
A Boolean value denoting whether the operation that triggered the notification
succeeded or failed.
entity
The object identifier of the object on which an operation, an event of type
com/vmware/vcloud/event/, triggered the notification. For more information
about object identifiers, see “Objects, References, and Representations,” on
page 12.
org
The object identifier of the organization that owns the affected object.
user
The object identifier of the user who made the request.
subType1-subTypeN
Each subType is a single component of the event type name. See “Notification
Types,” on page 269.
taskName
If entity is a task or blocking task, the task name is appended to the routing key.
The following routing key, in which the object identifiers are truncated to save space, is an example of a routing
key that might have been created for a successful com/vmware/vcloud/event/vapp/create event:
true.dc6a-
xxx
.0b8a-
xxx
.832c-
xxx
.com.vmware.vcloud.event.vapp.create
Notification Headers
The vCloud API defines notification headers and prepends them to every notification.
Table 10-1. Notification Headers
Header Value
notification.type See “Notification Types,” on page 269.
notification.entityType The type of vCloud entity is associated with this notification.
For example, vm.
notification.entityUUID The object identifier of the object on which an operation, an
event of type com/vmware/vcloud/event/, triggered the
notification.
notification.orgUUID The object identifier of the organization that owns the
affected object.
notification.userUUID The object identifier of the user who made the request.
notification.operationSuccess A Boolean value denoting whether the operation that
triggered the notification succeeded or failed.
Example: Notification Message Format
In addition to the routing key, a notification message contains a Notification element. This one was generated
by a blocking task.
<vmext:Notification
xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
type="com/vmware/vcloud/event/blockingtask/create"
eventId="a1440dd8-60ae-46c7-b216-44693bc00c90">
<vmext:Link
rel="entityResolver"
href="https://vcloud.example.com/api/entity/" />
<vmext:EntityLink
rel="entity"
type="vcloud:blockingTask"
vCloud API Programming Guide
268 VMware, Inc.