community.windows.win_rabbitmq_plugin module – Manage RabbitMQ plugins

Note

This module is part of the community.windows collection (version 2.4.0).

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

  • Manage RabbitMQ plugins.

Parameters

Parameter

Comments

names

aliases: name

string / required

Comma-separated list of plugin names.

new_only

boolean

Only enable missing plugins.

Does not disable plugins that are not in the names list.

Choices:

  • false ← (default)

  • true

prefix

string

Specify a custom install prefix to a Rabbit.

state

string

Specify if plugins are to be enabled or disabled.

Choices:

  • "disabled"

  • "enabled" ← (default)

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

Description

disabled

list / elements=string

List of plugins disabled during task run.

Returned: always

Sample: ["rabbitmq_management"]

enabled

list / elements=string

List of plugins enabled during task run.

Returned: always

Sample: ["rabbitmq_management"]

Authors

  • Artem Zinenko (@ar7z1)