rabbitmq_plugin - Manage RabbitMQ plugins
Synopsis
- Manage RabbitMQ plugins.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| names | yes | Comma-separated list of plugin names. aliases: name | ||
| new_only | no | no |
| Only enable missing plugins. Does not disable plugins that are not in the names list. |
| prefix (added in 1.3)
| no | Specify a custom install prefix to a Rabbit. | ||
| state | no | enabled |
| Specify if plugins are to be enabled or disabled. |
Examples
- name: Enables the rabbitmq_management plugin
rabbitmq_plugin:
names: rabbitmq_management
state: enabled
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| disabled | list of plugins disabled during task run | always | list | ['rabbitmq_management'] |
| enabled | list of plugins enabled during task run | always | list | ['rabbitmq_management'] |
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/rabbitmq_plugin_module.html