The settings/amqp/action/test link of the AmqpSettings element allows you to test AMQP settings before configuring them for the cloud.

Verify that you are logged in to the vCloud API as a system administrator.

Verify that you know the AMQP broker password.

Retrieve the SystemSettings element. See Retrieve or Update System Settings.

1

Examine the SystemSettings element to locate the link that you can use to retrieve the system's AmqpSettings element.

This link has a rel attribute value of down and a type attribute value of application/vnd.vmware.admin.amqpSettings+xml as shown here:

<Link href="https://vcloud.example.com/api/admin/extension/settings/amqp"
   rel="down"
   type="application/vnd.vmware.admin.amqpSettings+xml"/>
2

Retrieve the AmqpSettings element and locate the settings/amqp/action/test link it contains.

The response portion of Example: Update AMQP Settings includes this link.

3

Create a new AmqpSettings element that contains the values you want to test.

You can use the existing AmqpSettings element as a template. Whether you want to test the existing values or create new ones, you must include the AMQP broker password in the AmqpPassword element. This element is always returned empty when you retrieve the system's AmqpSettings.

4

Test the AMQP settings.

POST the AmqpSettings element to the settings/amqp/action/test link described in Step 2.

This example tests the settings shown in the request portion of Example: Update AMQP Settings

Request:

POST https://vcloud.example.com/api/admin/extension/settings/amqp/action/test
Content-Type: application/vnd.vmware.admin.amqpSettings+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<AmqpSettings
   xmlns="http://www.vmware.com/vcloud/extension/v1.5"
   type="application/vnd.vmware.admin.amqpSettings+xml">
   <AmqpHost />
   <AmqpPort>5672</AmqpPort>
   <AmqpUsername>guest</AmqpUsername>
   <AmqpPassword>Pa55w0rd</AmqpPassword>
   <AmqpExchange>systemExchange</AmqpExchange>
   <AmqpVHost>/</AmqpVHost>
   <AmqpUseSSL>true</AmqpUseSSL>
</AmqpSettings>

The response is an AmqpSettingsTest element whose Valid element contains a Boolean indication of whether the settings are valid. This response indicates that they are. If a value in the POSTed AmqpSettings element is incorrect, the AmqpSettingsTest response has a Valid value of false.

Response:

200 OK
Content-Type: application/vnd.vmware.admin.amqpSettingsTest+xml
...
<vmext:AmqpSettingsTest
   xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
   xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
   type="application/vnd.vmware.admin.amqpSettingsTest+xml"
   href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/test"
   ... >
   <vcloud:Link
      rel="up"
      type="application/vnd.vmware.admin.amqpSettings+xml"
      href="https://vcloud.example.com/api/admin/extension/settings/amqp" />
   <vmext:Valid>true</vmext:Valid>
</vmext:AmqpSettingsTest>