應用程序和集群管理

stop [pid_file]

用于停止運行RabbitMQ的Erlang node.如果指定了pid_file，還將等待指定的過程結束。例如：

rabbitmqctl stop

此命令會終止RabbitMQ node的運行.

stop_app

停止RabbitMQ application,但Erlang node會繼續運行.此命令主要用于優先執行其它管理操作（這些管理操作需要先停止RabbitMQ application），如. reset.例如：

rabbitmqctl stop_app

start_app

啟動RabbitMQ application.

此命令典型用于在執行了其它管理操作之后，重新啟動停止的RabbitMQ application。如reset.例如：

rabbitmqctl start_app

此命令來指導RabbitMQ node來啟動RabbitMQ application.

wait {pid_file}

等待RabbitMQ application啟動.此命令用來等待RabbitMQ application來啟動node。它會等待創建pid文件，然后等待pid文件中的特定pid過程啟動，最后等待RabbitMQ  application 來啟動node. 

pid file是通過rabbitmq-server 腳本來創建的.默認情況下，它存放于Mnesia目錄中. 修改RABBITMQ_PID_FILE 環境變量可以改變此位置。如：

rabbitmqctl wait /var/run/rabbitmq/pid

此命令會在RabbitMQ node啟動后返回.

reset

將RabbitMQ node還原到最初狀態.包括從所在群集中刪除此node,從管理數據庫中刪除所有配置數據，如已配置的用戶和虛擬主機，以及刪除所有持久化消息.

執行reset和force_reset之前，必須停止RabbitMQ application ,如使用stop_app.

示例:

rabbitmqctl reset

此命令會重設RabbitMQ　node.

force_reset

強制RabbitMQ node還原到最初狀態.

不同于reset ， force_reset 命令會無條件地重設node,不論當前管理數據庫的狀態和集群配置是什么. 它只能在數據庫或集群配置已損壞的情況下才可使用。

執行reset和force_reset之前，必須停止RabbitMQ application ,如使用stop_app.

示例:

rabbitmqctl force_reset

此命令會重設RabbitMQnode.

rotate_logs {suffix}

指示RabbitMQ node循環日志文件.

RabbitMQ 中間件會將原來日志文件中的內容追加到原始名稱和后輟的日志文件中，然后再將原始日志文件內容復制到新創建的日志上。實際上，當前日志內容會移到以此后輟結尾的文件上。當目標文件不存在時，將會進行創建。如果不指定后輟，則不會發生循環，日志文件只是重新打開。示例：

rabbitmqctl rotate_logs .1

此命令指示RabbitMQ node將日志文件的內容追加到新日志文件（文件名由原日志文件名和.1后輟構成）中。如. rabbit@mymachine.log.1 和 rabbit@mymachine-sasl.log.1. 最后, 日志會在原始位置恢復到新文件中.

集群管理

join_cluster {clusternode} [--ram]

clusternode

加入集群的節點.

[--ram]

如果進行了設置，節點將以RAM節點身份加入集群.

指導節點成為集群中的一員. 在加入集群之前，節點會重置,因此在使用此命令時，必須小心. 這個命令要成功,RabbitMQ應用程序必須先停止,如stop_app.

集群節點可以是兩種類型: 磁盤節點(Disc Node) 或 內存節點(RAM Node).磁盤節點會在RAM和磁盤中復制數據, 通過冗余可以防止節點失效事件，并可從斷電這種全局事件中進行恢復. RAM節點只在RAM中復制數據(除了隊列的內容外，還依賴于隊列是否是持久化的或者內容對于內存來說是否過大) ，并主要用于可伸縮性. RAM節點只有當管理資源(如，增加/刪除隊列,交換機,或綁定)的時候才具有更高的性能.一個集群必須至少有一個磁盤節點，通常來說還不止一個.

默認情況下，節點是磁盤節點.如果你想要創建內存節點,需要提供--ram 標志.

在執行cluster命令之后, 無論何時，當前節點上啟動的RabbitMQ 應用程序在節點宕機的情況下，會嘗試連接集群中的其它節點。

要脫離集群, 必須重設(reset)節點. 你也可以通過forget_cluster_node 命令來遠程刪除節點.

更多詳情，參考集群指南.

例如:

rabbitmqctl join_cluster hare@elena --ram

此命令用于指示RabbitMQ node以ram節點的形式將 hare@elena 加入集群.

cluster_status

按節點類型來分組展示集群中的所有節點，包括當前運行的節點.

例如:

rabbitmqctl cluster_status

此命令會顯示集群中的所有節點.

change_cluster_node_type {disc | ram}

修改集群節點的類型. 要成功執行此操作，必須首先停止節點，要將節點轉換為RAM節點，則此節點不能是集群中的唯一disc節點。

例如:

rabbitmqctl change_cluster_node_type disc

此命令會將一個RAM節點轉換為disc節點.

forget_cluster_node [--offline]

[--offline]

允許節點從脫機節點中刪除. 這只在所有節點都脫機且最后一個掉線節點不能再上線的情況下有用，從而防止整個集群從啟動。它不能使用在其它情況下，因為這會導致不一致．

遠程刪除一個集群節點.要刪除的節點必須是脫機的, 而在刪除節點期間節點必須是在線的，除非使用了--offline 標志.

當使用--offline 標志時，rabbitmqctl不會嘗試正常連接節點;相反，它會臨時改變節點以作修改.如果節點不能正常啟動的話，這是非常有用的.在這種情況下，節點將變成集群元數據的規范源（例如，隊列的存在），即使它不是以前的。因此，如果有可能，你應該在最新的節點上使用這個命令來關閉。

例如:

rabbitmqctl -n hare@mcnulty forget_cluster_node rabbit@stringer

此命令會從節點hare@mcnulty中刪除rabbit@stringer節點.

rename_cluster_node {oldnode1} {newnode1} [oldnode2] [newnode2 ...]

支持在本地數據庫中重命名集群節點.

此子命令會促使rabbitmqctl臨時改變節點以作出修改. 因此本地集群必須是停止的，其它節點可以是在線或離線的．

這個子命令接偶數個參數，成對表示節點的舊名稱和新名稱.你必須指定節點的舊名稱和新名稱，因為其它停止的節點也可能在同一時間重命名.

同時停止所有節點來重命名也是可以的(在這種情況下，每個節點都必須給出舊名稱和新名稱)或一次停止一個節點來重命名(在這種情況下，每個節點只需要被告知其名句是如何變化的).

例如:

rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia

此命令來將節點名稱rabbit@misshelpful 重命名為rabbit@cordelia.

update_cluster_nodes {clusternode}

clusternode

用于咨詢具有最新消息的節點.

指示已集群的節點醒來時聯系clusternode.這不同于join_cluster ，因為它不會加入任何集群 - 它會檢查節點已經以clusternode的形式存在于集群中了．

需要這個命令的動機是當節點離線時，集群可以變化.考慮這樣的情況，節點Ａ和節點Ｂ都在集群里邊，這里節點Ａ掉線了，Ｃ又和Ｂ集群了，然后Ｂ又離開了集群．當Ａ醒來的時候，它會嘗試聯系Ｂ，但這會失敗，因為Ｂ已經不在集群中了.update_cluster_nodes -n A C 可解決這種場景．

force_boot

確保節點將在下一次啟動，即使它不是最后一個關閉的。通常情況下，當你關閉整個RabbitMQ 集群時，你重啟的第一個節點應該是最后一個下線的節點，因為它可以看到其它節點所看不到的事情. 但有時這是不可能的:例如，如果整個集群是失去了電力而所有節點都在想它不是最后一個關閉的．

在這種節點掉線情況下，你可以調用rabbitmqctl force_boot ．這就告訴節點下一次無條件的啟動節點.在此節點關閉后，集群的任何變化，它都會丟失．

如果最后一個掉線的節點永久丟失了，那么你需要優先使用rabbitmqctl forget_cluster_node --offline, 因為它可以確保在丟失的節點上掌握的鏡像隊列得到提升。

例如:

rabbitmqctl force_boot

這可以強制節點下次啟動時不用等待其它節點．

sync_queue [-p vhost] {queue}

queue

同步隊列的名稱

指示未同步slaves上的鏡像隊列自行同步.同步發生時，隊列會阻塞(所有出入隊列的發布者和消費者都會阻塞).此命令成功執行后，隊列必須是鏡像的．

注意，未同步隊列中的消息被耗盡后，最終也會變成同步. 此命令主要用于未耗盡的隊列。

cancel_sync_queue [-p vhost] {queue}

queue

取消同步的隊列名稱.

指示同步鏡像隊列停止同步.

purge_queue [-p vhost] {queue}

queue

要清除隊列的名稱.

清除隊列(刪除其中的所有消息).

set_cluster_name {name}

設置集群名稱. 集群名稱在client連接時，會通報給client,也可用于federation和shovel插件記錄消息的來源地. 群集名稱默認是來自在群集中的第一個節點的主機名，但可以改變。

例如:

rabbitmqctl set_cluster_name london

設置集群名稱為"london".

用戶管理

注意rabbitmqctl 管理RabbitMQ 內部用戶數據庫. 任何來自其它認證后端的用戶對于rabbitmqctl來說是不可見的.

add_user {username} {password}

username

要創建的用戶名稱.

password

設置創建用戶登錄broker的密碼.       

rabbitmqctl add_user tonyg changeit

此命令用于指示RabbitMQ broker 創建一個擁有非管理權限的用戶，其名稱為tonyg， 初始密碼為changeit.

delete_user {username}

username

要刪除的用戶名稱.

例如:

rabbitmqctl delete_user tonyg

此命令用于指示RabbitMQ broker刪除名為tonyg的用戶

change_password {username} {newpassword}

username

要修改密碼的用戶名稱.

newpassword

用戶的新密碼.

例如:

rabbitmqctl change_password tonyg newpass

此命令用于指定RabbitMQ broker將tonyg 用戶的密碼修改為newpass.

clear_password {username}

username

要清除密碼的用戶名稱.

例如:

rabbitmqctl clear_password tonyg

此命令會指示RabbitMQ broker清除名為tonyg的用戶密碼.現在，此用戶不能使用密碼登錄(但可以通過SASL EXTERNAL登錄，如果配置了的話).

authenticate_user {username} {password}

username

用戶的名稱.

password

用戶的密碼.

例如:

rabbitmqctl authenticate_user tonyg verifyit

此命令會指示RabbitMQ broker以名稱為tonyg， 密碼為verifyit來進行驗證.

set_user_tags {username} {tag ...}

username

要設置tag的用戶名稱.

tag

用于設置0個，1個或多個tags.任何現有的tags都將被刪除.

例如:

rabbitmqctl set_user_tags tonyg administrator

此命令指示RabbitMQ broker用于確保tonyg 是administrator.當通過AMQP來登錄時，這沒有什么效果,但用戶通過其它的途經來登錄時，它可用來管理用戶,虛擬主機和權限(如使用管理插件).

rabbitmqctl set_user_tags tonyg

此命令會指示RabbitMQ broker刪除tonyg上的任何現有的tag.

list_users

列出用戶. 每個結果行都包含用戶名，其后緊跟用戶的tags.

例如:

rabbitmqctl list_users

此命令指示RabbitMQ broker列出所有用戶.

訪問控制

注意rabbitmqctl 會管理RabbitMQ的內部用戶數據庫. 無權限的用戶將不能使用rabbitmqctl.

add_vhost {vhost}

vhost

要創建虛擬主機名稱.

創建一個虛擬主機.

例如:

rabbitmqctl add_vhost test

此命令指示RabbitMQ broker來創建一個新的名為test的虛擬主機.

delete_vhost {vhost}

vhost

要刪除的虛擬主機的名稱.

刪除一個虛擬主機.

刪除一個虛擬主機，同時也會刪除所有交換機，隊列，綁定，用戶權限，參數和策略.

例如:

rabbitmqctl delete_vhost test

此命令指示RabbitMQ broker刪除名為test的虛擬主機.

list_vhosts [vhostinfoitem ...]

列出所有虛擬主機.

vhostinfoitem 參數用于標識哪些虛擬主機應該包含在結果集中.結果集中的列順序會匹配參數的順序.vhostinfoitem 可接受下面的值：

name

虛擬主機的名稱.

tracing

是否對虛擬主機啟用追蹤.

如果沒有指定vhostinfoitem 參數，那么會顯示虛擬主機名稱.

例如：

rabbitmqctl list_vhosts name tracing

此命令用于指示RabbitMQ broker顯示所有虛擬主機.

set_permissions [-p vhost] {user} {conf} {write} {read}

vhost

授予用戶可訪問的虛擬機名稱，默認是/.

user

可訪問指定虛擬主機的用戶名稱.

conf

一個用于匹配用戶在哪些資源名稱上擁有配置權限的正則表達式

write

一個用于匹配用戶在哪些資源名稱上擁有寫權限的正則表達式.

read

一個用于匹配用戶在哪些資源名稱上擁有讀權限的正則表達式.

設置用戶權限.

例如:

rabbitmqctl set_permissions -p /myvhost tonyg "^tonyg-.*" ".*" ".*"

此命令表示RabbitMQ broker授予tonyg 用戶可訪問 /myvhost虛擬主機,并在資源名稱以"tonyg-"開頭的所有資源上都具有配置權限，并在所有資源上都擁有讀寫權限。

clear_permissions [-p vhost] {username}

vhost

用于設置禁止用戶訪問的虛擬主機名稱,默認為/.

username

禁止訪問特定虛擬主機的用戶名稱.

設置用戶權限.

例如:

rabbitmqctl clear_permissions -p /myvhost tonyg

此命令用于指示RabbitMQ broker禁止tonyg 用戶訪問/myvhost虛擬主機.

list_permissions [-p vhost]

vhost

用于指定虛擬主機名稱，將會列出所有可訪問此虛擬主機的所有用戶名稱和權限.默認為/.

顯示虛擬機上權限.

例如:

rabbitmqctl list_permissions -p /myvhost

此命令指示RabbitMQ broker列出所有已授權訪問/myvhost 虛擬主機的用戶，同時也會列出這些用戶能在虛擬主機資源可操作的權限.注意，空字符串表示沒有任何授予的權限。

list_user_permissions {username}

username

要顯示權限的用戶名稱.

列出用戶權限.

例如:

rabbitmqctl list_user_permissions tonyg

此命令指示RabbitMQ broker列出tonyg可授權訪問的所有虛擬主機名稱，以及在這些虛擬主機上的操作.

參數管理

RabbitMQ的某些特性(如聯合插件)是動態控制的. 每個參數都是與特定虛擬主機相關的組件名稱, name和value構成的. 組件名稱和name都是字符串,值是Erlang term. 參數可被設置，清除和顯示.通常你可以參考文檔來了解如何設置參數.

set_parameter [-p vhost] {component_name} {name} {value}

設置一個參數.

component_name

要設置的組件名稱.

name

要設置的參數名稱.

value

要設置的參數值，作不JSON項。在多數shells中，你更喜歡將其引起來.

例如:

rabbitmqctl set_parameter federation local_username '"guest"'

此命令用于在默認虛擬主機上設置federation 組件的local_username 參數值"guest".

clear_parameter [-p vhost] {component_name} {key}

清除參數.

component_name

要清除參數的組件名稱.

name

要清除的參數名稱.

例如:

rabbitmqctl clear_parameter federation local_username

此命令用于清除默認虛擬主機上的federation 組件的local_username 參數值.

list_parameters [-p vhost]

列出虛擬主機上的所有參數.

示例:

rabbitmqctl list_parameters

此命令用于列出默認虛擬主機上的所有參數.

策略管理

策略用于在集群范圍的基礎上用于控制和修改隊列和交換機的行為. 策略應用于虛擬主機,由name, pattern, definition或可選的priority組成. 策略可被設置，清除和列舉.

set_policy [-p vhost] [--priority priority] [--apply-to apply-to] {name} {pattern} {definition}

設置策略.

name

策略名稱.

pattern

正則表達式, 匹配要應用的資源

definition

策略的定義,JSON形式．在大多數shells中，你很可能需要引用這個

priority

策略的整數優先級. 數字越高則優先級越高.默認是０.

apply-to

策略適用的對象類型，其值可為 "queues", "exchanges" 或 "all".默認是"all".

例如:

rabbitmqctl set_policy federate-me "^amq." '{"federation-upstream-set":"all"}'

此命令在默認虛擬主機上設置策略為federate-me，這樣內建的交換器將進行聯合.

clear_policy [-p vhost] {name}

清除策略.

name

要清除的策略名稱.

例如:

rabbitmqctl clear_policy federate-me

此命令來清除默認虛擬主機上的federate-me 策略.

list_policies [-p vhost]

顯示虛擬主機上的所有策略.

例如:

rabbitmqctl list_policies

此命令會顯示默認虛擬主機上的所有策略.

服務器狀態

服務器狀態查詢查詢服務器返回一個結果以制表符分隔的列表. 某些查詢(list_queues, list_exchanges, list_bindings, 和 list_consumers) 接受一個可選的vhost 參數. 如果這個參數出現了，那么它必須指定在查詢的后面.

list_queues, list_exchanges and list_bindings 命令接受一個可選的虛擬主機參數以顯示其結果．默認值為"/".

list_queues [-p vhost] [queueinfoitem ...]

返回隊列的詳細信息. 如果無-p標志，將顯示／虛擬主機上的隊列詳情．"-p" 標志可用來覆蓋此默認值．

queueinfoitem 參數用于指示哪些隊列信息項會包含在結果集中.結果集的列順序將匹配參數的順序.queueinfoitem 可以是下面列表中的任何值:

name

非ASCII字符的隊列名稱.

durable

服務器重啟后，隊列是否能幸存.

auto_delete

不再使用時，是否需要自動刪除隊列.

arguments

隊列參數.

policy

應用到隊列上的策略名稱.

pid

關聯隊列的Erlang進程ID.

owner_pid

表示隊列專用所有者的代表連接的Erlang進程ID.如果隊列是非專用的，此值將為空．

exclusive

True:如果隊列是專用的(即有owner_pid), 反之false

exclusive_consumer_pid

表示此channel的專用消費者訂閱到此隊列的Erlang進程Id. 如果沒有專用消費者，則為空．

exclusive_consumer_tag

專用消費者訂閱到此隊列的Consumer tag.如果沒有專用消費者，則為空.

messages_ready

準備分發給客戶端的消息數目.

messages_unacknowledged

分發到客戶端但尚未應答的消息數目.

messages

準備分發和未應答消息的總和(隊列深度).

messages_ready_ram

駐留在ram中messages_ready的消息數目.

messages_unacknowledged_ram

駐留在ram中messages_unacknowledged的消息數目.

messages_ram

駐留在ram中的消息總數.

messages_persistent

隊列中持久化消息的數目(對于瞬時隊列總是0).

message_bytes

隊列中所有消息體的大小總和.這不包括消息屬性(包括headers) 或任何開銷(overhead)。

message_bytes_ready

類似于message_bytes ，但只統計準備投遞給clients的那些消息．

message_bytes_unacknowledged

類似于message_bytes ，但只統計那些已經投遞給clients但還未應答的消息

message_bytes_ram

類似于message_bytes ，但只統計那些在RAM中的消息

message_bytes_persistent

類似于message_bytes ，但只統計那些持久化的消息

head_message_timestamp

如果存在，只顯示隊列中第１個消息的timestamp屬性. 消息的時間戳只出現在分頁情況下．

disk_reads

從隊列啟動開如，已從磁盤上讀取該隊列的消息總次數.

disk_writes

從隊列啟動開始，已向磁盤隊列寫消息總次數.

consumers

消費者數目.

consumer_utilisation

時間分數(0.0與1.0之間)，隊列可立即向消費者投遞消息. 它可以小于1.0，如果消費者受限于網絡堵塞或預提取數量.

memory

與隊列相關的Erlang進程消耗的內存字節數,包括棧,堆以及內部結構.

slave_pids

如果隊列是鏡像的，這里給出的是當前slaves的IDs.

synchronised_slave_pids

如果隊列是鏡像的，當前slaves的IDs是master同步的- 即它們可在無消息丟失的情況下，接管master.

state

隊列狀態.正常情況下是'running', 但如果隊列正在同步也可能是"{syncing, MsgCount}". 處于集群下的節點如果掉線了，隊列狀態交顯示'down' (大多數queueinfoitems 將不可用).

如果沒有指定queueinfoitems，那么將顯示隊列名稱和隊列深度．

例如:

rabbitmqctl list_queues -p /myvhost messages consumers

此命令顯示了/myvhost虛擬主機中每個隊列的深度和消費者數目.

list_exchanges [-p vhost] [exchangeinfoitem ...]

返回交換器細節.如果沒有指定"-p"選項，將返回 / 虛擬主機的細節.  "-p" 選項可用來覆蓋默認虛擬主機.

exchangeinfoitem 參數用來表示哪些交換器信息要包含在結果中. 結果集中列的順序將與參數順序保持一致. exchangeinfoitem 可接受下面的列表中任何值：

name

交換器名稱.

type

交換器類型(如[direct, topic, headers, fanout]).

durable

當服務器重啟時，交換器是否能復活.

auto_delete

當不再使用時，交換器是否需要自動刪除.

internal

交換器是否是內部的，即不能由client直接發布.

arguments

交換器參數

policy

應用到交換器上的策略名稱.

如果沒有指定exchangeinfoitems，那么將會顯示交換器類型和類型

例如:

rabbitmqctl list_exchanges -p /myvhost name type

此命令會顯示/myvhost中每個交換器的名稱和類型.

rabbitmqctl list_bindings -p /myvhost exchange_name queue_name

rabbitmqctl list_connections send_pend port

rabbitmqctl list_channels connection messages_unacknowledged

rabbitmqctl status

rabbitmqctl report > server_report.txt

rabbitmqctl eval 'node().'

雜項

close_connection {connectionpid} {explanation}

connectionpid

要關閉的與連接相關的Erlang進程ID.

explanation

解釋字符串.

指示broker關閉與Erlang進程id相關的連接(可通過list_connections 命令查看), 通過為連接客戶端傳遞解釋字符串(作為AMQP連接關閉協議的一部分).

例如:

rabbitmqctl close_connection "<rabbit@tanto.4262.0>" "go away"

此命令指示RabbitMQ broker關閉與Erlang 進程id<rabbit@tanto.4262.0>相關聯的連接, 同時向客戶端傳遞go away字符串.

trace_on [-p vhost]

vhost

要開啟追蹤的虛擬主機的名稱.

開啟追蹤.注意，追蹤狀態不是持久化的; 如果服務器重啟，追蹤狀態將會丟失.

trace_off [-p vhost]

vhost

要停止追蹤的虛擬主機名稱.

停止追蹤.

set_vm_memory_high_watermark {fraction}

fraction

當一個浮點數大于或等于0時，會觸發流量控制新內存閾值部分。

set_vm_memory_high_watermark absolute {memory_limit}

memory_limit

流程控制觸發的新內存限制, 以字節來表示大于或等于０的整數或以字符串和內存單位來表示(如 512M或1G). 可用的單位是: k, kiB: kibibytes (2^10 bytes) M, MiB: mebibytes (2^20) G, GiB: gibibytes (2^30) kB: kilobytes (10^3) MB: megabytes (10^6) GB: gigabytes (10^9)

set_disk_free_limit {disk_limit}

disk_limit

以整數或字符串單位的可用磁盤下限限制(查看vm_memory_high_watermark), 如 512M or 1G. 一旦可用磁盤空間達到這個限制，就會設置磁盤報警.

set_disk_free_limit mem_relative {fraction}

fraction

相對于整個可用內存的限制，其值為非負浮點數. 當值小于１.０時是很危險的，應該謹慎使用．