community.general.rabbitmq_queue (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

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
    required: true

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

vhost:
    default: /
    description:
    - RabbitMQ virtual host.
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - CA certificate to verify SSL connection to management API.
    type: path

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

client_key:
    aliases:
    - key
    description:
    - Private key matching the client certificate.
    type: path

login_host:
    default: localhost
    description:
    - RabbitMQ host for connection.
    type: str

login_port:
    default: '15672'
    description:
    - RabbitMQ management API port.
    type: str

login_user:
    default: guest
    description:
    - RabbitMQ user for connection.
    type: str

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

client_cert:
    aliases:
    - cert
    description:
    - Client certificate to send on SSL connections to management API.
    type: path

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.

login_password:
    description:
    - RabbitMQ password for connection.
    type: str

login_protocol:
    choices:
    - http
    - https
    default: http
    description:
    - RabbitMQ management API protocol.
    type: str

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