/ home / community / community.general / 0.1.1 / module / rabbitmq_plugin

community.general.rabbitmq_plugin (0.1.1) — module

Manage RabbitMQ plugins

Authors: Chris Hoffman (@chrishoffman)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module can be used to enable or disable RabbitMQ plugins.

Usage examples

Scanned by Steampunk Spotter

- name: Enables the rabbitmq_management plugin
  rabbitmq_plugin:
    names: rabbitmq_management
    state: enabled

Scanned by Steampunk Spotter

- name: Enable multiple rabbitmq plugins
  rabbitmq_plugin:
    names: rabbitmq_management,rabbitmq_management_visualiser
    state: enabled

Scanned by Steampunk Spotter

- name: Disable plugin
  rabbitmq_plugin:
    names: rabbitmq_management
    state: disabled

Scanned by Steampunk Spotter

- name: Enable every plugin in list with existing plugins
  rabbitmq_plugin:
    names: rabbitmq_management,rabbitmq_management_visualiser,rabbitmq_shovel,rabbitmq_shovel_management
    state: enabled
    new_only: 'yes'

Inputs

    
names:
    aliases:
    - name
    description:
    - Comma-separated list of plugin names. Also, accepts plugin name.
    required: true

state:
    choices:
    - enabled
    - disabled
    default: enabled
    description:
    - Specify if plugins are to be enabled or disabled.

prefix:
    description:
    - Specify a custom install prefix to a Rabbit.

new_only:
    default: 'no'
    description:
    - Only enable missing plugins.
    - Does not disable plugins that are not in the names list.
    type: bool

Outputs

disabled:
  description: list of plugins disabled during task run
  returned: always
  sample:
  - rabbitmq_management
  type: list
enabled:
  description: list of plugins enabled during task run
  returned: always
  sample:
  - rabbitmq_management
  type: list