W3cubDocs

/Ansible

rabbitmq_exchange - This module manages rabbitMQ exchanges

New in version 2.0.

Synopsis

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

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
auto_delete
no
  • yes
  • no
if the exchange should delete itself after all queues/exchanges unbound from it
durable
no True
  • yes
  • no
whether exchange is durable or not
exchange_type
no direct
  • fanout
  • direct
  • headers
  • topic
type for the exchange
aliases: type
internal
no
  • yes
  • no
exchange is available only for other exchanges
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
Name of the exchange to create
state
no present
  • present
  • absent
Whether the exchange should be present or absent
Only present implemented atm
vhost
no /
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 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–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/rabbitmq_exchange_module.html