community.rabbitmq.rabbitmq_global_parameter – Manage RabbitMQ global parameters
Note
This plugin is part of the community.rabbitmq collection (version 1.1.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 | Choices/Defaults | Comments |
|---|---|---|
| name
string / required
|
Name of the global parameter being set
|
|
| node
string
|
Default:
"rabbit"
|
erlang node name of the rabbit we wish to configure
|
| state
string
|
|
Specify if global parameter is to be added or removed
|
| value
string
|
Value of the global parameter, as a JSON term
|
Examples
# 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 | Returned | Description |
|---|---|---|
| name
string
|
success |
name of the global parameter being set
Sample:
cluster_name
|
| value
string
|
changed |
value of the global parameter, as a JSON term
Sample:
the-cluster-name
|
Authors
- Juergen Kirschbaum (@jgkirschbaum)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/rabbitmq/rabbitmq_global_parameter_module.html