community.rabbitmq.rabbitmq_policy – Manage the state of policies in RabbitMQ

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_policy.

Synopsis

  • Manage the state of a policy in RabbitMQ.

Parameters

Parameter Choices/Defaults Comments
apply_to
string
    Choices:
  • all ←
  • exchanges
  • queues
What the policy applies to. Requires RabbitMQ 3.2.0 or later.
name
string / required
The name of the policy to manage.
node
string
Default:
"rabbit"
Erlang node name of the rabbit we wish to configure.
pattern
string
A regex of queues to apply the policy to. Required when state=present. This option is no longer required as of Ansible 2.9.
priority
string
Default:
"0"
The priority of the policy.
state
string
    Choices:
  • present ←
  • absent
The state of the policy.
tags
dictionary
A dict or string describing the policy. Required when state=present. This option is no longer required as of Ansible 2.9.
vhost
string
Default:
"/"
The name of the vhost to apply to.

Examples

- name: ensure the default vhost contains the HA policy via a dict
  community.rabbitmq.rabbitmq_policy:
    name: HA
    pattern: .*
  args:
    tags:
      ha-mode: all

- name: ensure the default vhost contains the HA policy
  community.rabbitmq.rabbitmq_policy:
    name: HA
    pattern: .*
    tags:
      ha-mode: all

Authors

  • John Dewey (@retr0h)