ansible.builtin.rabbitmq_queue (v2.6.2) — module

Install Ansible via pip

Install with pip install ansible==2.6.2

Description

This module uses rabbitMQ Rest API to create/delete queues

Requirements

• requests >= 1.0.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Create a queue
- rabbitmq_queue:
    name: myQueue

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - Name of the queue to create
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the queue should be present or absent
    - Only present implemented atm

vhost:
    default: /
    description:
    - rabbitMQ virtual host

durable:
    default: 'yes'
    description:
    - whether queue is durable or not
    type: bool

arguments:
    default: {}
    description:
    - extra arguments for queue. If defined this argument is a key/value dictionary

login_host:
    default: localhost
    description:
    - rabbitMQ host for connection

login_port:
    default: 15672
    description:
    - rabbitMQ management api port

login_user:
    default: guest
    description:
    - rabbitMQ user for connection

max_length:
    default: no limit
    description:
    - How many messages can the queue contain before it starts rejecting

auto_delete:
    default: 'no'
    description:
    - if the queue should delete itself after all queues/queues unbound from it
    type: bool

message_ttl:
    default: forever
    description:
    - How long a message can live in queue before it is discarded (milliseconds)

auto_expires:
    default: forever
    description:
    - How long a queue can be unused before it is automatically deleted (milliseconds)

max_priority:
    description:
    - 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.
    version_added: '2.4'
    version_added_collection: ansible.builtin

login_password:
    default: 'no'
    description:
    - rabbitMQ password for connection
    type: bool

dead_letter_exchange:
    description:
    - Optional name of an exchange to which messages will be republished if they
    - are rejected or expire

dead_letter_routing_key:
    description:
    - Optional replacement routing key to use when a message is dead-lettered.
    - Original routing key will be used if unset