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
Processing Messages from Blocking Tasks
Messages from blocking tasks are also sent to the configured message broker, and clients can use the routing
key to indicate their interest in these messages. See “Subscribing to Notifications,” on page 215. Messages from
blocking tasks contain additional information about the task itself. Clients that process these messages can use
the vCloud API to authenticate to the system and act on the blocked task.
This chapter includes the following topics:
n
“Configure Notifications and AMQP Settings,” on page 216
n
“Retrieve or Update Blocking Task Settings,” on page 225
n
“Monitor Blocking Tasks,” on page 228
n
“Take Action on a Blocking Task,” on page 229
n
“Extend The Timeout Expiration of an Active Task,” on page 232
Configure Notifications and AMQP Settings
The system administrator can enable or disable AMQP notification messages for events in a cloud. The system
administrator can also configure settings that the vCloud Director AMQP service uses when it sends messages
generated by notifications and blocking tasks.
AMQP broker settings are established when you install and configure RabbitMQ or another AMQP broker to
use with vCloud Director. These values include the following items:
n
The fully-qualified domain name of the RabbitMQ server host, for example amqp.example.com.
n
A username and password that are valid for authenticating with RabbitMQ.
n
The port at which the broker listens for messages. The default is 5672.
n
The RabbitMQ virtual host. The default is "/".
NOTE It is a good practice to test the AMQP settings before you change the configuration. See “Test AMQP
Settings,” on page 218.
Prerequisites
Verify that you are logged in as a system administrator.
Procedure
1 Retrieve the SystemSettings element.
2 Examine the response to locate the links that you can use to retrieve the system's
NotificationsSettings and AmqpSettings elements.
These links have a rel attribute value of down and a type attribute value of
application/vnd.vmware.admin.notificationsSettings+xml for NotificationsSettings or
application/vnd.vmware.admin.amqpSettings+xml for AmqpSettings, as shown here:
<Link href="https://vcloud.example.com/api/admin/extension/settings/amqp"
rel="down"
type="application/vnd.vmware.admin.amqpSettings+xml"/>
vCloud API Programming Guide
216 VMware, Inc.