community.rabbitmq.rabbitmq_global_parameter module – Manage RabbitMQ global parameters
Note
This module is part of the community.rabbitmq collection (version 1.4.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_global_parameter
.
Synopsis
Manage dynamic, cluster-wide global parameters for RabbitMQ
Parameters
Parameter |
Comments |
---|---|
Name of the global parameter being set |
|
erlang node name of the rabbit we wish to configure Default: |
|
Specify if global parameter is to be added or removed Choices:
|
|
Value of the global parameter, as a JSON term |
Examples
- name: Set the global parameter 'cluster_name' to a value of 'mq-cluster' (in quotes)
community.rabbitmq.rabbitmq_global_parameter:
name: cluster_name
value: "{{ 'mq-cluster' | to_json }}"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
name of the global parameter being set Returned: success Sample: |
|
value of the global parameter, as a JSON term Returned: changed Sample: |