Documentation

rabbitmq_policy - Manage the state of policies in RabbitMQ.

New in version 1.5.

Synopsis

  • Manage the state of a virtual host in RabbitMQ.

Options

parameter required default choices comments
apply_to
(added in 2.1)
no all
  • all
  • exchanges
  • queues
What the policy applies to. Requires RabbitMQ 3.2.0 or later.
name
yes
The name of the policy to manage.
node
no rabbit
Erlang node name of the rabbit we wish to configure.
pattern
yes
A regex of queues to apply the policy to.
priority
no
The priority of the policy.
state
no present
  • present
  • absent
The state of the policy.
tags
yes
A dict or string describing the policy.
vhost
no /
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

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.