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 命令将更新插件文件，然后尝试连接到消息代理并确保它运行所有已启用的插件。默认情况下，如果无法连接到目标节点并进行身份验证（例如，如果目标节点已停止），操作将失败。如果 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>