VMware Cloud Director API - AmqpSettings

AmqpSettingsType

Element:

AmqpSettings

Type:

AmqpSettingsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

Represents the settings for the AMQP broker.

Since:

1.5

Schema:

settings.xsd

Media type(s):

application/vnd.vmware.admin.amqpSettings+json
application/vnd.vmware.admin.amqpSettings+xml

Extends:

ResourceType

XML Representation:

<AmqpSettings xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <AmqpHost> xs:string </AmqpHost>
    <AmqpPort> xs:int </AmqpPort>
    <AmqpUsername> xs:string </AmqpUsername>
    <AmqpPassword> xs:string </AmqpPassword>
    <AmqpExchange> xs:string </AmqpExchange>
    <AmqpVHost> xs:string </AmqpVHost>
    <AmqpUseSSL> xs:boolean </AmqpUseSSL>
    <AmqpPrefix> xs:string </AmqpPrefix>
</AmqpSettings>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	1.5		The URI of the entity.
type	string	No	always	1.5		The MIME type of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
AmqpExchange	string	Yes	always	1.5	AMQP exchange for publishing.
AmqpHost	string	Yes	always	1.5	Hostname of the AMQP broker.
AmqpPassword	string	No	always	1.5	Password for the AMQP broker.
AmqpPort	int	Yes	always	1.5	Port of the AMQP broker.
AmqpPrefix	string	Yes	always	5.1	AMQP vcloud instance prefix.
AmqpUseSSL	boolean	Yes	always	1.5	Use SSL for communication with the AMQP broker.
AmqpUsername	string	Yes	always	1.5	Username for the AMQP broker.
AmqpVHost	string	Yes	always	1.5	Virtual host for the AMQP broker.
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since
read	GET /admin/extension/settings/amqp	Retrieve system AMQP settings.	1.5
as input	PUT /admin/extension/settings/amqp	Update system AMQP settings.	1.5
as input	POST /admin/extension/settings/amqp/action/test	Validate provisional AMQP settings.	1.5