On this page
rabbitmq_policy - Manage the state of policies in RabbitMQ.
New in version 1.5.
Synopsis
- Manage the state of a virtual host in RabbitMQ.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
apply_to
(added in 2.1)
|
|
What the policy applies to. Requires RabbitMQ 3.2.0 or later.
|
name
required
|
Default:
None
|
The name of the policy to manage.
|
node | Default:
rabbit
|
Erlang node name of the rabbit we wish to configure.
|
pattern
required
|
Default:
None
|
A regex of queues to apply the policy to.
|
priority | Default:
0
|
The priority of the policy.
|
state |
|
The state of the policy.
|
tags
required
|
Default:
None
|
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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- John Dewey (@retr0h)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/rabbitmq_policy_module.html