rabbitmq_exchange – Manage rabbitMQ exchanges
New in version 2.0.
Synopsis
- This module uses rabbitMQ Rest API to create/delete exchanges
Requirements
The below requirements are needed on the host that executes this module.
- requests >= 1.0.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| arguments
-
|
Default:
{}
|
extra arguments for exchange. If defined this argument is a key/value dictionary
|
| auto_delete
boolean
|
|
if the exchange should delete itself after all queues/exchanges unbound from it
|
| ca_cert
path
added in 2.3
|
CA certificate to verify SSL connection to management API.
aliases: cacert |
|
| client_cert
path
added in 2.3
|
Client certificate to send on SSL connections to management API.
aliases: cert |
|
| client_key
path
added in 2.3
|
Private key matching the client certificate.
aliases: key |
|
| durable
boolean
|
|
whether exchange is durable or not
|
| exchange_type
-
|
|
type for the exchange
aliases: type |
| internal
boolean
|
|
exchange is available only for other exchanges
|
| login_host
string
|
Default:
"localhost"
|
RabbitMQ host for connection.
|
| login_password
string
|
RabbitMQ password for connection.
|
|
| login_port
string
|
Default:
"15672"
|
RabbitMQ management API port.
|
| login_protocol
string
added in 2.3
|
|
RabbitMQ management API protocol.
|
| login_user
string
|
Default:
"guest"
|
RabbitMQ user for connection.
|
| name
- / required
|
Name of the exchange to create
|
|
| state
-
|
|
Whether the exchange should be present or absent
|
| vhost
string
|
Default:
"/"
|
RabbitMQ virtual host.
|
Examples
# Create direct exchange
- rabbitmq_exchange:
name: directExchange
# Create topic exchange on vhost
- rabbitmq_exchange:
name: topicExchange
type: topic
vhost: myVhost
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Manuel Sousa (@manuel-sousa)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/rabbitmq_exchange_module.html