community.rabbitmq.rabbitmq_parameter – Manage RabbitMQ parameters

Note

This plugin is part of the community.rabbitmq collection.

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 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 user 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)