Documentation

rabbitmq_queue - This module manages rabbitMQ queues

New in version 2.0.

Synopsis

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

Options

parameter required default choices comments
arguments
 no
extra arguments for queue. If defined this argument is a key/value dictionary
auto_delete
 no
  • yes
  • no
if the queue should delete itself after all queues/queues unbound from it
auto_expires
 no forever
How long a queue can be unused before it is automatically deleted (milliseconds)
dead_letter_exchange
 no None
Optional name of an exchange to which messages will be republished if they
are rejected or expire
dead_letter_routing_key
 no None
Optional replacement routing key to use when a message is dead-lettered.
Original routing key will be used if unset
durable
 no True
  • yes
  • no
whether queue is durable or not
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
max_length
 no no limit
How many messages can the queue contain before it starts rejecting
message_ttl
 no forever
How long a message can live in queue before it is discarded (milliseconds)
name
 yes
Name of the queue to create
state
 no present
  • present
  • absent
Whether the queue should be present or absent
Only present implemented atm
vhost
 no /
rabbitMQ virtual host

Examples

# Create a queue
- rabbitmq_queue:
    name: myQueue

# Create a queue on remote host
- rabbitmq_queue:
    name: myRemoteQueue
    login_user: user
    login_password: secret
    login_host: remote.example.org

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.