rabbitmq-plugins.8

名称

rabbitmq-plugins — 用于管理 RabbitMQ 插件的命令行工具

概要

rabbitmq-plugins

[-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

描述

rabbitmq-plugins 是一个用于管理 RabbitMQ 插件的命令行工具。有关 RabbitMQ 插件及其使用方式的概述，请参阅 RabbitMQ 插件指南。

rabbitmq-plugins 允许操作员启用、禁用和检查插件。它必须由对 RabbitMQ 配置目录具有写入权限的用户运行。

插件可以依赖于其他插件。rabbitmq-plugins 会解析依赖关系并启用或禁用所有依赖项，以便用户不必显式管理它们。在 rabbitmq-plugins 命令行上列出的插件被标记为显式启用；依赖插件被标记为隐式启用。当不再需要隐式启用的插件时，它们会自动再次禁用。

enable、disable 和 set 命令将更新插件文件，然后尝试连接到 broker 并确保它正在运行所有已启用的插件。默认情况下，如果无法连接到目标节点并进行身份验证（例如，如果它已停止），则操作将失败。如果在与目标节点相同的主机上使用 rabbitmq-plugins，则可以指定 --offline 使 rabbitmq-plugins 直接解析和更新插件状态（无需联系节点）。此类更改仅在下次节点启动时生效。要了解更多信息，请参阅 RabbitMQ 插件指南

选项

-n node

默认节点为“rabbit@target-hostname”，其中 target-hostname 是本地主机。在名为“myserver.example.com”的主机上，节点名称通常为“rabbit@myserver”（除非 RABBITMQ_NODENAME 已被覆盖）。“hostname -s”的输出通常是在“@”符号后使用的正确后缀。有关配置 RabbitMQ 节点的详细信息，请参阅 rabbitmq-server(8)。

-q，--quiet

选择静默输出模式。当静默模式生效时，信息性消息会减少。

-s，--silent

选择静默输出模式。当静默模式生效时，信息性消息会减少，并且表头会被抑制。

-t timeout，--timeout timeout

操作超时时间（秒）。并非所有命令都支持超时。默认为 infinity。

-l，--longnames

当集群配置为使用长 (FQDN) 节点名称时，必须指定此选项。要了解更多信息，请参阅 RabbitMQ 集群指南

--erlang-cookie cookie

用于对目标节点进行身份验证的共享密钥。建议使用本地文件或 RABBITMQ_ERLANG_COOKIE 环境变量，而不是在命令行上指定此选项。要了解更多信息，请参阅 RabbitMQ CLI 工具指南

命令

list [-Eemv] [pattern]

-E

仅显示显式启用的插件。

-e

仅显示显式或隐式启用的插件。

-m

仅显示插件名称（最小）。

-v

显示所有插件详细信息（详细）。

pattern

用于过滤插件名称的模式。

列出所有插件、其版本、依赖项和描述。每个插件都以 [ ] 内的两个状态指示符作为前缀。第一个指示符可以是

<space> {#space}

表示插件未启用

E

表示它是显式启用的

e

表示它是隐式启用的

表示它已启用但缺少，因此无法运行

第二个指示符可以是

<space> {#space~2}

表示插件未运行

*

表示它正在运行

如果给出了可选的 pattern，则仅显示名称与 pattern 匹配的插件。

例如，此命令在一行中列出所有插件

rabbitmq-plugins list

此命令列出所有插件

rabbitmq-plugins list -v

此命令列出名称包含“management”的所有插件。

rabbitmq-plugins list -v management

此命令列出所有隐式或显式启用的 RabbitMQ 插件。

rabbitmq-plugins list -e rabbit

enable [--offline] [--online] plugin ...

--offline

直接修改节点的已启用插件状态，而无需联系节点。

--online

将连接到正在运行的 broker 失败视为致命错误。

plugin

要启用的一个或多个插件。

启用指定的插件及其所有依赖项。

例如，此命令启用“shovel”和“management”插件及其所有依赖项

rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management

disable [--offline] [--online] plugin ...

--offline

直接修改节点的已启用插件状态，而无需联系节点。

--online

将连接到正在运行的 broker 失败视为致命错误。

plugin

要禁用的一个或多个插件。

禁用指定的插件及其所有依赖项。

例如，此命令禁用“rabbitmq_management”以及所有依赖于它的插件

rabbitmq-plugins disable rabbitmq_management

set [--offline] [--online] [plugin ...]

--offline

直接修改节点的已启用插件状态，而无需联系节点。

--online

将连接到正在运行的 broker 失败视为致命错误。

plugin

零个或多个要禁用的插件。

启用指定的插件及其所有依赖项。与 enable 不同，此命令会忽略并覆盖任何现有的已启用插件。set 命令在没有插件参数的情况下是合法的，表示“禁用所有插件”。

例如，此命令启用“management”插件及其依赖项，并禁用所有其他插件

rabbitmq-plugins set rabbitmq_management

另请参阅

rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5), rabbitmq-echopid(8)

作者

RabbitMQ 团队 <contact-tanzu-data.pdl@broadcom.com>