ansible.builtin.rabbitmq_policy (v2.9.27) — module

Manage the state of policies in RabbitMQ

| "added in version" 1.5 of ansible.builtin"

Authors: John Dewey (@retr0h)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manage the state of a policy in RabbitMQ.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: ensure the default vhost contains the HA policy via a dict
  rabbitmq_policy:
    name: HA
    pattern: .*
  args:
    tags:
      ha-mode: all
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: ensure the default vhost contains the HA policy
  rabbitmq_policy:
    name: HA
    pattern: .*
    tags:
      ha-mode: all

Inputs

    
name:
    description:
    - The name of the policy to manage.
    required: true

node:
    default: rabbit
    description:
    - Erlang node name of the rabbit we wish to configure.

tags:
    default: null
    description:
    - A dict or string describing the policy. Required when C(state=present). This option
      is no longer required as of Ansible 2.9.
    required: false

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of the policy.

vhost:
    default: /
    description:
    - The name of the vhost to apply to.

pattern:
    default: null
    description:
    - A regex of queues to apply the policy to. Required when C(state=present). This option
      is no longer required as of Ansible 2.9.
    required: false

apply_to:
    choices:
    - all
    - exchanges
    - queues
    default: all
    description:
    - What the policy applies to. Requires RabbitMQ 3.2.0 or later.
    version_added: '2.1'
    version_added_collection: ansible.builtin

priority:
    default: 0
    description:
    - The priority of the policy.