community.rabbitmq.rabbitmq_parameter module – Manage RabbitMQ parameters

Note

This module is part of the community.rabbitmq collection (version 1.3.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_parameter.

Synopsis

  • Manage dynamic, cluster-wide parameters for RabbitMQ

Parameters

Parameter

Comments

component

string / required

Name of the component of which the parameter is being set

name

string / required

Name of the parameter being set

node

string

erlang node name of the rabbit we wish to configure

Default: "rabbit"

state

string

Specify if parameter is to be added or removed

Choices:

  • "present" ← (default)

  • "absent"

value

string

Value of the parameter, as a JSON term

vhost

string

vhost to apply access privileges.

Default: "/"

Examples

- name: Set the federation parameter 'local_username' to a value of 'guest' (in quotes)
  community.rabbitmq.rabbitmq_parameter:
    component: federation
    name: local-username
    value: '"guest"'
    state: present

- name: Create or update a shovel
  vars:
    payload:
      src-protocol: "amqp091"
      src-uri: "amqp://"
      src-queue: "src-queue"
      dest-protocol: "amqp091"
      dest-uri: "amqp://guest:[email protected]"
      dest-queue: "dest-queue"
  community.rabbitmq.rabbitmq_parameter:
    component: shovel
    name: "shovel-name"
    value: "{{ payload | to_json }}"
    state: present

Authors

  • Chris Hoffman (@chrishoffman)