rabbitmq-plugins.8

名称

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

概要

rabbitmq-plugins

[-q] [-s] [-l] [-n 节点] [-t 超时] 命令 [命令_选项]

描述

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

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

插件可以依赖于其他插件。rabbitmq-plugins 会自动解析依赖关系并启用或禁用所有相关插件，从而无需用户显式管理它们。在 rabbitmq-plugins 命令行中列出的插件被标记为“显式启用”；依赖插件则被标记为“隐式启用”。隐式启用的插件在不再需要时会被自动禁用。

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

选项

-n 节点

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

-q, --quiet

选择安静输出模式。在安静模式下，信息性消息会减少。

-s, --silent

选择静默输出模式。在静默模式下，信息性消息会减少，并且表格标题会被抑制。

-t 超时, --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 的插件。

例如，此命令列出所有插件，每行一个：

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

将无法连接到正在运行的消息代理视为致命错误。

plugin

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

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

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

rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management

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

--offline

直接修改节点的启用插件状态，而不连接到节点。

--online

将无法连接到正在运行的消息代理视为致命错误。

plugin

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

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

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

rabbitmq-plugins disable rabbitmq_management

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

--offline

直接修改节点的启用插件状态，而不连接到节点。

--online

将无法连接到正在运行的消息代理视为致命错误。

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)

作者

The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>