Documentation

rabbitmq_exchange - This module manages rabbitMQ exchanges

New in version 2.0.

Synopsis

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

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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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