Documentation

rabbitmq_exchange - This module manages 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
bool
    Choices:
  • no ←
  • yes
if the exchange should delete itself after all queues/exchanges unbound from it
durable
bool
    Choices:
  • no
  • yes ←
whether exchange is durable or not
exchange_type
    Choices:
  • fanout
  • direct ←
  • headers
  • topic
type for the exchange

aliases: type
internal
bool
    Choices:
  • no ←
  • yes
exchange is available only for other exchanges
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
Name of the exchange to create
state
    Choices:
  • present ←
  • absent
Whether the exchange should be present or absent
Only present implemented atm
vhost 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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Manuel Sousa (@manuel-sousa)

Hint

If you notice any issues in this documentation you can edit this document to improve it.