Documentation

rabbitmq_policy – Manage the state of policies in RabbitMQ

Synopsis

  • Manage the state of a policy in RabbitMQ.

Parameters

Parameter Choices/Defaults Comments
apply_to
-
added in 2.1
    Choices:
  • all ←
  • exchanges
  • queues
What the policy applies to. Requires RabbitMQ 3.2.0 or later.
name
- / required
The name of the policy to manage.
node
-
Default:
rabbit
Erlang node name of the rabbit we wish to configure.
pattern
- / required
A regex of queues to apply the policy to.
priority
-
Default:
0
The priority of the policy.
state
-
    Choices:
  • present ←
  • absent
The state of the policy.
tags
- / required
A dict or string describing the policy.
vhost
-
Default:
/
The name of the vhost to apply to.

Examples

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

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

Status

Authors

  • John Dewey (@retr0h)

Hint

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