community.rabbitmq.rabbitmq_plugin 模块 – 管理 RabbitMQ 插件

注意

此模块是 community.rabbitmq 集合（版本 1.3.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.rabbitmq。

要在 playbook 中使用它，请指定：community.rabbitmq.rabbitmq_plugin。

概要

  • 此模块可用于启用或禁用 RabbitMQ 插件。

参数

参数

注释

broker_state

字符串

指定在插件更改时，broker 应处于在线还是离线状态。

选项

  • "online" ← (默认)

  • "offline"

names

别名: name

字符串 / 必需

以逗号分隔的插件名称列表。也接受插件名称。

new_only

布尔值

仅启用缺少的插件。

不禁用不在名称列表中的插件。

选项

  • false ← (默认)

  • true

prefix

字符串

指定 Rabbit 的自定义安装前缀。

state

字符串

指定是否启用或禁用插件。

选项

  • "enabled" ← (默认)

  • "disabled"

示例

- name: Enables the rabbitmq_management plugin
  community.rabbitmq.rabbitmq_plugin:
    names: rabbitmq_management
    state: enabled

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

- name: Disable plugin
  community.rabbitmq.rabbitmq_plugin:
    names: rabbitmq_management
    state: disabled

- name: Enable every plugin in list with existing plugins
  community.rabbitmq.rabbitmq_plugin:
    names: rabbitmq_management,rabbitmq_management_visualiser,rabbitmq_shovel,rabbitmq_shovel_management
    state: enabled
    new_only: true

- name: Enables the rabbitmq_peer_discovery_aws plugin without requiring a broker connection.
  community.rabbitmq.rabbitmq_plugin:
    names: rabbitmq_peer_discovery_aws_plugin
    state: enabled
    broker_state: offline

返回值

常见返回值记录在此处，以下是此模块独有的字段

键

描述

disabled

列表 / 元素=字符串

任务运行期间禁用的插件列表

返回: 始终

示例: ["rabbitmq_management"]

enabled

列表 / 元素=字符串

任务运行期间启用的插件列表

返回: 始终

示例: ["rabbitmq_management"]

作者

  • Chris Hoffman (@chrishoffman)