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_plugin.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| broker_state string |
| Specify whether the broker should be online or offline for the plugin change. |
| names string / required | Comma-separated list of plugin names. Also, accepts plugin name. aliases: name | |
| new_only boolean |
| Only enable missing plugins. Does not disable plugins that are not in the names list. |
| prefix string | Specify a custom install prefix to a Rabbit. | |
| state string |
| Specify if plugins are to be enabled or disabled. |
- name: Enables the rabbitmq_management plugin
community.rabbitmq.rabbitmq_plugin:
names: rabbitmq_management
state: enabled
- name: Enable multiple rabbitmq plugins
community.rabbitmq.rabbitmq_plugin:
names: rabbitmq_management,rabbitmq_management_visualiser
state: enabled
- name: Disable plugin
community.rabbitmq.rabbitmq_plugin:
names: rabbitmq_management
state: disabled
- name: Enable every plugin in list with existing plugins
community.rabbitmq.rabbitmq_plugin:
names: rabbitmq_management,rabbitmq_management_visualiser,rabbitmq_shovel,rabbitmq_shovel_management
state: enabled
new_only: 'yes'
- name: Enables the rabbitmq_peer_discovery_aws plugin without requiring a broker connection.
community.rabbitmq.rabbitmq_plugin:
names: rabbitmq_peer_discovery_aws_plugin
state: enabled
broker_state: offline
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| disabled list / elements=string | always | list of plugins disabled during task run Sample: ['rabbitmq_management'] |
| enabled list / elements=string | always | list of plugins enabled during task run Sample: ['rabbitmq_management'] |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/rabbitmq/rabbitmq_plugin_module.html