ansible.builtin.rabbitmq_plugin (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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.
    version_added: '1.3'
    version_added_collection: ansible.builtin

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