rabbitmq_queue – Manage rabbitMQ queues — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# rabbitmq_queue – Manage rabbitMQ queues

New in version 2.0.

- Synopsis
- Requirements
- Parameters
- Examples
- Status

## Synopsis

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

## 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 queue. If defined this argument is a key/value dictionary
auto_delete boolean | Choices: no ← yes | if the queue should delete itself after all queues/queues unbound from it
auto_expires - | Default: "forever" | How long a queue can be unused before it is automatically deleted (milliseconds)
ca_cert path added in 2.3 |  | CA certificate to verify SSL connection to management API. aliases: cacert
client_cert path added in 2.3 |  | Client certificate to send on SSL connections to management API. aliases: cert
client_key path added in 2.3 |  | Private key matching the client certificate. aliases: key
dead_letter_exchange - |  | Optional name of an exchange to which messages will be republished if they are rejected or expire
dead_letter_routing_key - |  | Optional replacement routing key to use when a message is dead-lettered. Original routing key will be used if unset
durable boolean | Choices: no yes ← | whether queue is durable or not
login_host string | Default: "localhost" | RabbitMQ host for connection.
login_password string |  | RabbitMQ password for connection.
login_port string | Default: "15672" | RabbitMQ management API port.
login_protocol string added in 2.3 | Choices: http ← https | RabbitMQ management API protocol.
login_user string | Default: "guest" | RabbitMQ user for connection.
max_length - | Default: "no limit" | How many messages can the queue contain before it starts rejecting
max_priority - added in 2.4 |  | Maximum number of priority levels for the queue to support. If not set, the queue will not support message priorities. Larger numbers indicate higher priority.
message_ttl - | Default: "forever" | How long a message can live in queue before it is discarded (milliseconds)
name - / required |  | Name of the queue
state - | Choices: present ← absent | Whether the queue should be present or absent
vhost string | Default: "/" | 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 not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Manuel Sousa (@manuel-sousa)

Hint

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