community.rabbitmq.rabbitmq_queue – Manage rabbitMQ queues
Note
This plugin is part of the community.rabbitmq collection (version 1.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.rabbitmq
.
To use it in a playbook, specify: community.rabbitmq.rabbitmq_queue
.
Synopsis
This module uses rabbitMQ Rest API to create/delete queues.
Due to limitations in the API, it cannot modify existing queues.
Requirements
The below requirements are needed on the host that executes this module.
requests >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
extra arguments for queue. If defined this argument is a key/value dictionary Arguments here take precedence over parameters. If both are defined, the argument will be used. Default: {} |
|
if the queue should delete itself after all queues/queues unbound from it Choices:
|
|
How long a queue can be unused before it is automatically deleted (milliseconds) |
|
CA certificate to verify SSL connection to management API. |
|
Client certificate to send on SSL connections to management API. |
|
Private key matching the client certificate. |
|
Optional name of an exchange to which messages will be republished if they are rejected or expire |
|
Optional replacement routing key to use when a message is dead-lettered. Original routing key will be used if unset |
|
whether queue is durable or not Choices:
|
|
RabbitMQ host for connection. Default: “localhost” |
|
RabbitMQ password for connection. Default: “guest” |
|
RabbitMQ management API port. Default: “15672” |
|
RabbitMQ management API protocol. Choices:
|
|
RabbitMQ user for connection. Default: “guest” |
|
How many messages can the queue contain before it starts rejecting |
|
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. |
|
How long a message can live in queue before it is discarded (milliseconds) |
|
Name of the queue |
|
Whether the queue should be present or absent Choices:
|
|
RabbitMQ virtual host. Default: “/” |