On this page
rabbitmq_binding - This module manages rabbitMQ bindings
New in version 2.0.
Synopsis
- This module uses rabbitMQ Rest API to create/delete bindings
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
|
destination
required
|
destination exchange or queue for the binding
aliases: dst, dest |
|
destination_type
required
|
|
Either queue or exchange
aliases: type, dest_type |
login_host | Default:
localhost
|
rabbitMQ host for connection
|
login_password | Default:
no
|
rabbitMQ password for connection
|
login_port | Default:
15672
|
rabbitMQ management api port
|
login_user | Default:
guest
|
rabbitMQ user for connection
|
name
required
|
source exchange to create binding on
aliases: src, source |
|
routing_key | Default:
#
|
routing key for the binding
default is
|
state |
|
Whether the exchange should be present or absent
Only present implemented atm
|
vhost | Default:
/
|
rabbitMQ virtual host
default vhost is /
|
Examples
# Bind myQueue to directExchange with routing key info
- rabbitmq_binding:
name: directExchange
destination: myQueue
type: queue
routing_key: info
# Bind directExchange to topicExchange with routing key *.info
- rabbitmq_binding:
name: topicExchange
destination: topicExchange
type: exchange
routing_key: '*.info'
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- 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.5/modules/rabbitmq_binding_module.html