Docs4dev
Docs
ansible / 2.4 / rabbitmq_binding_module.html

rabbitmq_binding - This module manages rabbitMQ bindings

New in version 2.0.

Synopsis

  • This module uses rabbitMQ Rest API to create/delete bindings

Requirements (on host that executes module)

  • requests >= 1.0.0

Options

parameter required default choices comments
arguments
 no
extra arguments for exchange. If defined this argument is a key/value dictionary
destination
 yes
destination exchange or queue for the binding
aliases: dst, dest
destination_type
 yes
  • queue
  • exchange
Either queue or exchange
aliases: type, dest_type
login_host
 no localhost
rabbitMQ host for connection
login_password
 no
rabbitMQ password for connection
login_port
 no 15672
rabbitMQ management api port
login_user
 no guest
rabbitMQ user for connection
name
 yes
source exchange to create binding on
aliases: src, source
routing_key
 no #
routing key for the binding
default is
state
 no present
  • present
  • absent
Whether the exchange should be present or absent
Only present implemented atm
vhost
 no /
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.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/rabbitmq_binding_module.html