VMware Cloud Director API - POST-TestAmqpSettings
POST /admin/extension/settings/amqp/action/test
- Operation:
- POST /admin/extension/settings/amqp/action/test
- Description:
-
Validate provisional AMQP settings.
This request attempts to contact an AMQP broker using the values in the request body (an AmqpSettings element). If the attempt succeeds, the AmqpSettings are considered valid and can be used to update the system's AMQP settings.
- Since:
- 1.5
- Deprecated:
- 39.0
- Input parameters
-
the representation of the AMQP settings that will be tested.
- Consume media type(s):
-
application/vnd.vmware.admin.amqpSettings+xml
application/vnd.vmware.admin.amqpSettings+json
- Input type:
- AmqpSettingsType
- Output parameters
-
- Produce media type(s):
-
application/vnd.vmware.admin.amqpSettingsTest+xml
application/vnd.vmware.admin.amqpSettingsTest+json
- Output type:
- AmqpSettingsTestType
- Examples
-
- Request
-
HTTP 1.1
POST /api/admin/extension/settings/amqp/action/test
Headers:
Content-Length: 482
Content-Type: application/vnd.vmware.admin.amqpSettings+xml; charset=ISO-8859-1
x-vcloud-authorization: M69zc2o7Ol7AuYVBAslGYbnTluZZVZKIYa1HPe8MzEk=
Body:
<?xml version="1.0" encoding="UTF-8"?><vmext:AmqpSettings
xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5">
<vmext:AmqpHost>amqp.example.com</vmext:AmqpHost>
<vmext:AmqpPort>5672</vmext:AmqpPort>
<vmext:AmqpUsername>amqp-user</vmext:AmqpUsername>
<vmext:AmqpPassword>amqp-p4ssw0rd</vmext:AmqpPassword>
<vmext:AmqpExchange>systemExchange</vmext:AmqpExchange>
<vmext:AmqpVHost>/</vmext:AmqpVHost>
<vmext:AmqpUseSSL>false</vmext:AmqpUseSSL>
</vmext:AmqpSettings>
- Response
-
HTTP/1.1 200 OK
Headers:
Content-Length: 874
Content-Type: application/vnd.vmware.admin.amqpsettingstest+xml;version=5.5
Vary: Accept-Encoding
Body:
<?xml version="1.0" encoding="UTF-8"?><vmext:AmqpSettingsTest
xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
href="https://vcloud.example.com/api/admin/extension/settings/amqp/action/test"
type="application/vnd.vmware.admin.amqpSettingsTest+xml"
xsi:schemaLocation="http://www.vmware.com/vcloud/extension/v1.5 http://https://vcloud.example.com/api/v1.5/schema/vmwextensions.xsd http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
<vcloud:Link
href="https://vcloud.example.com/api/admin/extension/settings/amqp"
rel="up"
type="application/vnd.vmware.admin.amqpSettings+xml"/>
<vmext:Valid>false</vmext:Valid>
<vmext:error
majorErrorCode="403"
message="No route to host"
minorErrorCode="BAD_AMQP_SETTINGS"/>
</vmext:AmqpSettingsTest>