community.rabbitmq.rabbitmq_parameter – Manage RabbitMQ 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_parameter.

Synopsis
Parameters
Examples

Synopsis

Manage dynamic, cluster-wide parameters for RabbitMQ

Parameters

Parameter	Choices/Defaults	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	Default: "rabbit"	erlang node name of the rabbit we wish to configure
state string	Choices: present ← absent	Specify if parameter is to be added or removed
value string		Value of the parameter, as a JSON term
vhost string	Default: "/"	vhost to apply access privileges.

Examples

# 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

Authors

Chris Hoffman (@chrishoffman)

© 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_parameter_module.html