You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

rabbitmq_parameter - Adds or removes parameters to RabbitMQ¶

Synopsis
Options
Examples
- Status

Synopsis ¶

Manage dynamic, cluster-wide parameters for RabbitMQ

Options ¶

parameter	required	default	choices	comments
component	yes			Name of the component of which the parameter is being set
name	yes			Name of the parameter being set
node	no	rabbit		erlang node name of the rabbit we wish to configure
state	no	present	present absent	Specify if user is to be added or removed
value	no			Value of the parameter, as a JSON term
vhost	no	/		vhost to apply access privileges.

Examples ¶

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

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.