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@目标主机名”，其中 目标主机名 是本地主机。在名为“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] [模式]

-E

仅显示显式启用的插件。

-e

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

-m

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

-v

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

模式

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

列出所有插件、其版本、依赖项和描述。每个插件前面都有两个状态指示符字符，位于 [ ] 内。第一个指示符可以是

<space> {#空格}

表示插件未启用

E

表示它是显式启用的

e

表示它是隐式启用的

表示它已启用但丢失，因此无法运行

第二个指示符可以是

<space> {#空格~2}

表示插件未运行

*

表示它正在运行

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

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

rabbitmq-plugins list

此命令列出所有插件

rabbitmq-plugins list -v

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

rabbitmq-plugins list -v management

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

rabbitmq-plugins list -e rabbit

enable [--offline] [--online] 插件 ...

--offline

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

--online

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

插件

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

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

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

rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management

disable [--offline] [--online] 插件 ...

--offline

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

--online

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

插件

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

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

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

rabbitmq-plugins disable rabbitmq_management

set [--offline] [--online] [插件 ...]

--offline

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

--online

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

插件

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

启用指定的插件及其所有依赖项。与 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>