community.windows.win_rabbitmq_plugin – Manage RabbitMQ plugins

Note

This plugin is part of the community.windows collection (version 1.7.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.windows.

To use it in a playbook, specify: community.windows.win_rabbitmq_plugin.

Synopsis
Parameters
Examples
Return Values

Synopsis

Manage RabbitMQ plugins.

Parameters

Parameter	Choices/Defaults	Comments
names string / required		Comma-separated list of plugin names. aliases: name
new_only boolean	Choices: no ← yes	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	Choices: disabled enabled ←	Specify if plugins are to be enabled or disabled.

Examples

- name: Enables the rabbitmq_management plugin
  community.windows.win_rabbitmq_plugin:
    names: rabbitmq_management
    state: enabled

Return Values

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']

Authors

Artem Zinenko (@ar7z1)

© 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/windows/win_rabbitmq_plugin_module.html