• 欢迎光临~

rabbitmq

开发技术 开发技术 2022-06-02 次浏览

rabbitmq使用帮助

查看代码
rabbitmqctl -h

Usage

rabbitmqctl [--node <node>] [--timeout <timeout>] [--longnames] [--quiet] <command> [<command options>]

Available commands:

Help:

help Displays usage information for a command
version Displays CLI tools version

Nodes:

await_startup Waits for the RabbitMQ application to start on the target node
reset Instructs a RabbitMQ node to leave the cluster and eturn to its virgin state
rotate_logs Instructs the RabbitMQ node to perform internal log rotation
shutdown Stops RabbitMQ and its runtime (Erlang VM). Monitors progress for local nodes. Does not require a PID file path.
start_app Starts the RabbitMQ application but leaves the runtime (Erlang VM) running
stop Stops RabbitMQ and its runtime (Erlang VM). Requires a local node pid file path to monitor progress.
stop_app Stops the RabbitMQ application, leaving the runtime (Erlang VM) running
wait Waits for RabbitMQ node startup by monitoring a local PID file. See also 'rabbitmqctl await_online_nodes'

Cluster:

await_online_nodes Waits for <count> nodes to join the cluster
change_cluster_node_type Changes the type of the cluster node
cluster_status Displays all the nodes in the cluster grouped by node type, together with the currently running nodes
force_boot Forces node to start even if it cannot contact or rejoin any of its previously known peers
force_reset Forcefully returns a RabbitMQ node to its virgin state
forget_cluster_node Removes a node from the cluster
join_cluster Instructs the node to become a member of the cluster that the specified node is in
rename_cluster_node Renames cluster nodes in the local database
update_cluster_nodes Instructs a cluster member node to sync the list of known cluster members from <seed_node>

Replication:

cancel_sync_queue Instructs a synchronising mirrored queue to stop synchronising itself
sync_queue Instructs a mirrored queue with unsynchronised mirrors (follower replicas) to synchronise them

Users:

add_user Creates a new user in the internal database
authenticate_user Attempts to authenticate a user. Exits with a non-zero code if authentication fails.
change_password Changes the user password
clear_password Clears (resets) password and disables password login for a user
delete_user Removes a user from the internal database. Has no effect on users provided by external backends such as LDAP
list_users List user names and tags
set_user_tags Sets user tags

Access Control:

clear_permissions Revokes user permissions for a vhost
clear_topic_permissions Clears user topic permissions for a vhost or exchange
list_permissions Lists user permissions in a virtual host
list_topic_permissions Lists topic permissions in a virtual host
list_user_permissions Lists permissions of a user across all virtual hosts
list_user_topic_permissions Lists user topic permissions
list_vhosts Lists virtual hosts
set_permissions Sets user permissions for a vhost
set_topic_permissions Sets user topic permissions for an exchange

Monitoring, observability and health checks:

environment Displays the name and value of each variable in the application environment for each running application
list_bindings Lists all bindings on a vhost
list_channels Lists all channels in the node
list_ciphers Lists cipher suites supported by encoding commands
list_connections Lists AMQP 0.9.1 connections for the node
list_consumers Lists all consumers for a vhost
list_exchanges Lists exchanges
list_hashes Lists hash functions supported by encoding commands
list_queues Lists queues and their properties
list_unresponsive_queues Tests queues to respond within timeout. Lists those which did not respond
node_health_check Performs several opinionated health checks of the target node
ping Checks that the node OS process is up, registered with EPMD and CLI tools can authenticate with it
report Generate a server status report containing a concatenation of all server status information for support purposes
schema_info Lists schema database tables and their properties
status Displays status of a node

Parameters:

clear_global_parameter Clears a global runtime parameter
clear_parameter Clears a runtime parameter.
list_global_parameters Lists global runtime parameters
list_parameters Lists runtime parameters for a virtual host
set_global_parameter Sets a runtime parameter.
set_parameter Sets a runtime parameter.

Policies:

clear_operator_policy Clears an operator policy
clear_policy Clears (removes) a policy
list_operator_policies Lists operator policy overrides for a virtual host
list_policies Lists all policies in a virtual host
set_operator_policy Sets an operator policy that overrides a subset of arguments in user policies
set_policy Sets or updates a policy

Virtual hosts:

add_vhost Creates a virtual host
clear_vhost_limits Clears virtual host limits
delete_vhost Deletes a virtual host
list_vhost_limits Displays configured virtual host limits
restart_vhost Restarts a failed vhost data stores and queues
set_vhost_limits Sets virtual host limits
trace_off
trace_on

Node configuration:

decode Decrypts an encrypted configuration value
encode Encrypts a sensitive configuration value
set_cluster_name Sets the cluster name
set_disk_free_limit Sets the disk_free_limit setting
set_log_level Sets log level in the running node
set_vm_memory_high_watermark Sets the vm_memory_high_watermark setting

Definitions:

export_definitions Exports definitions in JSON or compressed Erlang Term Format.
import_definitions Imports definitions in JSON or compressed Erlang Term Format.

Feature flags:

enable_feature_flag Enables a feature flag on target node
list_feature_flags Lists feature flags

Operations:

close_all_connections Instructs the broker to close all connections for the specified vhost or entire RabbitMQ node
close_connection Instructs the broker to close the connection associated with the Erlang process id
eval Evaluates a snippet of Erlang code on the target node
exec Evaluates a snippet of Elixir code on the CLI node
force_gc Makes all Erlang processes on the target node perform/schedule a full sweep garbage collection
hipe_compile Only exists for backwards compatibility. HiPE support has been dropped starting with Erlang 22. Do not use

Queues:

delete_queue 删除队列。
purge_queue 清除队列(删除其中的所有消息)。
quorum_status Displays quorum status of a quorum queue

Use 'rabbitmqctl help <command>' to learn more about a specific command

Management UI

rabbitmq-plugins enable rabbitmq_management

常用命令

虚拟主机管理
rabbitmqctl add_vhost vhost
rabbitmqctl delete_vhost <vhost>
rabbitmqctl list_vhosts [vhostinfoitem ...]

添加用户
rabbitmqctl add_user username password
删除用户
rabbitmqctl delete_user username
修改密码
rabbitmqctl change_password username newpassword
清除密码
rabbitmqctl clear_password username
用户校验
rabbitmqctl authenticate_user username password
验成功则返回success,否则出现错误信息。
设置用户标签
rabbitmqctl set_user_tags <username> <tag> ...

用户标签类型包括:
management :访问 management plugin;
policymaker :访问 management plugin 和管理自己 vhosts 的策略和参数;
monitoring :访问 management plugin 和查看所有配置和通道以及节点信息;
administrator :一切权限;
None :无配置

权限

设置用户权限
rabbitmqctl set_permissions [-p <vhost>] <user> <conf> <write> <read>
使用# vhost 被授权的虚拟机,默认是“/”
rabbitmqctl add_vhost vh
rabbitmqctl add_user test test
rabbitmqctl set_user_tags test management

使用户 test 具有‘vh’这个 virtual host 中所有资源的配置、写、读权限

rabbitmqctl set_permissions -p vh test "." "." ".*"

清除权限
clear_permissions [-p vhost] username
虚拟机权限查询
list_permissions [-p vhost]
用户权限查询
list_user_permissions username

topic 权限:

创建 topic 权限

语法: set_topic_permissions [-p <vhost>] <username> <exchange> <write_pattern> <read_pattern>
用户 user1 在 vhost1 虚拟机上的 topicExchange 交换器具备如下权限:能够发布和消费以"log."开头的消息

rabbitmqctl set_topic_permissions -p vhost user1 topicExchange "^log." "^log."
1

清除topic权限
clear_topic_permissions [-p vhost] username [exchange]

vhost 虚拟机名称,默认是“/”
username 用户名
exchange topic交换器名称,不设置则为username用户授权的所有topic交换器

虚拟机的topic权限查询
list_topic_permissions [-p vhost]
用户的topic权限查询
list_user_topic_permissions username

 

程序员灯塔
转载请注明原文链接:rabbitmq
喜欢 (0)