AMQP 0-9-1 Model Explained

Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was disabled.

peer_port

Peer port.

peer_host

Peer hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled.

ssl

Boolean indicating whether the connection is secured with SSL.

SSL protocol (e.g. “tlsv1”).

SSL key exchange algorithm (e.g. “rsa”).

SSL cipher algorithm (e.g. “aes_256_cbc”).

SSL hash function (e.g. “sha”).

peer_cert_subject

The subject of the peer's SSL certificate, in RFC4514 form.

peer_cert_issuer

The issuer of the peer's SSL certificate, in RFC4514 form.

peer_cert_validity

The period for which the peer's SSL certificate is valid.

state

Connection state; one of:

starting
tuning
opening
running
flow
blocking
blocked
closing
closed

channels

Number of channels using the connection.

protocol

Version of the AMQP protocol in use; currently one of:

{0,9,1}
{0,8,0}

Note that if a client requests an AMQP 0-9 connection, we treat it as AMQP 0-9-1.

auth_mechanism

SASL authentication mechanism used, such as “PLAIN”.

user

Username associated with the connection.

vhost

Virtual host name with non-ASCII characters escaped as in C.

timeout

Connection timeout / negotiated heartbeat interval, in seconds.

Maximum frame size (bytes).

channel_max

Maximum number of channels on this connection.

client_properties

Informational properties transmitted by the client during connection establishment.

Octets received.

Packets received.

Octets send.

Packets sent.

Send queue size.

Date and time this connection was established, as timestamp.

If no connectioninfoitem are specified then user, peer host, peer port, time since flow control and memory block state are displayed.

For example, this command displays the send queue size and server port for each connection:

rabbitmqctl list_connections send_pend port

list_channels [channelinfoitem ...]

Returns information on all current channels, the logical containers executing most AMQP commands. This includes channels that are part of ordinary AMQP connections, and channels created by various plug-ins and other extensions.

The channelinfoitem parameter is used to indicate which channel information items to include in the results. The column order in the results will match the order of the parameters. channelinfoitem can take any value from the list that follows:

pid: Id of the Erlang process associated with the connection.
connection: Id of the Erlang process associated with the connection to which the channel belongs.
name: Readable name for the channel.
number: The number of the channel, which uniquely identifies it within a connection.
user: Username associated with the channel.
vhost: Virtual host in which the channel operates.
transactional: True if the channel is in transactional mode, false otherwise.
confirm: True if the channel is in confirm mode, false otherwise.
consumer_count: Number of logical AMQP consumers retrieving messages via the channel.
messages_unacknowledged: Number of messages delivered via this channel but not yet acknowledged.
messages_uncommitted: Number of messages received in an as yet uncommitted transaction.
acks_uncommitted: Number of acknowledgements received in an as yet uncommitted transaction.
messages_unconfirmed: Number of published messages not yet confirmed. On channels not in confirm mode, this remains 0.
prefetch_count: QoS prefetch limit for new consumers, 0 if unlimited.
global_prefetch_count: QoS prefetch limit for the entire channel, 0 if unlimited.

If no channelinfoitem are specified then pid, user, consumer_count, and messages_unacknowledged are assumed.

For example, this command displays the connection process and count of unacknowledged messages for each channel:

rabbitmqctl list_channels connection messages_unacknowledged

list_consumers [-p vhost]

Lists consumers, i.e. subscriptions to a queue´s message stream. Each line printed shows, separated by tab characters, the name of the queue subscribed to, the id of the channel process via which the subscription was created and is managed, the consumer tag which uniquely identifies the subscription within a channel, a boolean indicating whether acknowledgements are expected for messages delivered to this consumer, an integer indicating the prefetch limit (with 0 meaning “none”), and any arguments for this consumer.

status

Displays broker status information such as the running applications on the current Erlang node, RabbitMQ and Erlang versions, OS name, memory and file descriptor statistics. (See the cluster_status command to find out which nodes are clustered and running.)

For example, this command displays information about the RabbitMQ broker:

rabbitmqctl status

node_health_check

Health check of the RabbitMQ node. Verifies the rabbit application is running, list_queues and list_channels return, and alarms are not set.

For example, this command performs a health check on the RabbitMQ node:

rabbitmqctl node_health_check -n rabbit@stringer

environment

Displays the name and value of each variable in the application environment for each running application.

report

Generate a server status report containing a concatenation of all server status information for support purposes. The output should be redirected to a file when accompanying a support request.

For example, this command creates a server report which may be attached to a support request email:

rabbitmqctl report > server_report.txt

eval expr

Evaluate an arbitrary Erlang expression.

For example, this command returns the name of the node to which rabbitmqctl has connected:

rabbitmqctl eval “node().”

Miscellaneous

close_connection connectionpid explanation

connectionpid: Id of the Erlang process associated with the connection to close.
explanation: Explanation string.

Instructs the broker to close the connection associated with the Erlang process id connectionpid (see also the list_connections command), passing the explanation string to the connected client as part of the AMQP connection shutdown protocol.

For example, this command instructs the RabbitMQ broker to close the connection associated with the Erlang process id “<rabbit@tanto.4262.0>”, passing the explanation “go away” to the connected client:

rabbitmqctl close_connection “<rabbit@tanto.4262.0>” “go away”

close_all_connections [-p vhost] [--global] [--per-connection-delay delay] [--limit limit] explanation

-p vhost: The name of the virtual host for which connections should be closed. Ignored when --global is specified.
--global: If connections should be close for all vhosts. Overrides -p
--per-connection-delay delay: Time in milliseconds to wait after each connection closing.
--limit limit: Number of connection to close. Only works per vhost. Ignored when --global is specified.
explanation: Explanation string.

Instructs the broker to close all connections for the specified vhost or entire RabbitMQ node.

For example, this command instructs the RabbitMQ broker to close 10 connections on “qa_env” vhost, passing the explanation “Please close”:

rabbitmqctl close_all_connections -p qa_env --limit 10 'Please close'

This command instructs broker to close all connections to the node:

rabbitmqctl close_all_connections --global

trace_on [-p vhost]

vhost: The name of the virtual host for which to start tracing.

Starts tracing. Note that the trace state is not persistent; it will revert to being off if the server is restarted.

trace_off [-p vhost]

vhost: The name of the virtual host for which to stop tracing.

Stops tracing.

set_vm_memory_high_watermark fraction

fraction: The new memory threshold fraction at which flow control is triggered, as a floating point number greater than or equal to 0.

set_vm_memory_high_watermark absolute memory_limit

memory_limit

The new memory limit at which flow control is triggered, expressed in bytes as an integer number greater than or equal to 0 or as a string with memory units (e.g. 512M or 1G). Available units are:

k, kiB: kibibytes (2^10 bytes)
M, MiB: mebibytes (2^20 bytes)
G, GiB: gibibytes (2^30 bytes)
kB: kilobytes (10^3 bytes)
MB: megabytes (10^6 bytes)
GB: gigabytes (10^9 bytes)

set_disk_free_limit disk_limit

disk_limit: Lower bound limit as an integer in bytes or a string with memory units (see vm_memory_high_watermark), e.g. 512M or 1G. Once free disk space reaches the limit, a disk alarm will be set.

set_disk_free_limit mem_relative fraction

fraction: Limit relative to the total amount available RAM as a non-negative floating point number. Values lower than 1.0 can be dangerous and should be used carefully.

encode value passphrase [--cipher cipher] [--hash hash] [--iterations iterations]

value passphrase

Value to encrypt and passphrase.

For example:

rabbitmqctl encode '<<"guest">>' mypassphrase

--cipher cipher --hash hash --iterations iterations

Options to specify the encryption settings. They can be used independently.

For example:

rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase

decode value passphrase [--cipher cipher] [--hash hash] [--iterations iterations]

value passphrase

Value to decrypt (as produced by the encode command) and passphrase.

For example:

rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase

--cipher cipher --hash hash --iterations iterations

Options to specify the decryption settings. They can be used independently.

For example:

rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase

list_hashes

Lists hash functions supported by encoding commands.

For example, this command instructs the RabbitMQ broker to list all hash functions supported by encoding commands:

rabbitmqctl list_hashes

list_ciphers

Lists cipher suites supported by encoding commands.

For example, this command instructs the RabbitMQ broker to list all cipher suites supported by encoding commands:

rabbitmqctl list_ciphers

PLUGIN COMMANDS

RabbitMQ plugins can extend rabbitmqctl tool to add new commands when enabled. Currently available commands can be found in rabbitmqctl help output. Following commands are added by RabbitMQ plugins, available in default distribution:

Shovel plugin

shovel_status: Prints a list of configured shovels
delete_shovel [-p vhost] name: Instructs the RabbitMQ node to delete the configured shovel by name.

Federation plugin

federation_status [--only-down]

Prints a list of federation links.

--only-down: Only list federation links which are not running.

restart_federation_link link_id

Instructs the RabbitMQ node to restart the federation link with specified link_id.

AMQP-1.0 plugin

list_amqp10_connections [amqp10_connectioninfoitem ...]

Similar to the list_connections command, but returns fields which make sense for AMQP-1.0 connections. amqp10_connectioninfoitem parameter is used to indicate which connection information items to include in the results. The column order in the results will match the order of the parameters. amqp10_connectioninfoitem can take any value from the list that follows:

pid

Id of the Erlang process associated with the connection.

auth_mechanism

SASL authentication mechanism used, such as “PLAIN”.

Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was disabled.

Maximum frame size (bytes).

timeout

Connection timeout / negotiated heartbeat interval, in seconds.

user

Username associated with the connection.

state

Connection state; one of:

starting
waiting_amqp0100
securing
running
blocking
blocked
closing
closed

Octets received.

Packets received.

Octets send.

Packets sent.

Boolean indicating whether the connection is secured with SSL.

SSL protocol (e.g. “tlsv1”).

SSL key exchange algorithm (e.g. “rsa”).

SSL cipher algorithm (e.g. “aes_256_cbc”).

SSL hash function (e.g. “sha”).

peer_cert_subject

The subject of the peer's SSL certificate, in RFC4514 form.

peer_cert_issuer

The issuer of the peer's SSL certificate, in RFC4514 form.

peer_cert_validity

The period for which the peer's SSL certificate is valid.

node

The node name of the RabbitMQ node to which connection is established.

MQTT plugin

list_mqtt_connections [mqtt_connectioninfoitem]

Similar to the list_connections command, but returns fields which make sense for MQTT connections. mqtt_connectioninfoitem parameter is used to indicate which connection information items to include in the results. The column order in the results will match the order of the parameters. mqtt_connectioninfoitem can take any value from the list that follows:

Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was disabled.

port

Server port.

peer_host

Peer hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled.

peer_port

Peer port.

protocol

MQTT protocol version, which can be on of the following:

{'MQTT', N/A}
{'MQTT', 3.1.0}
{'MQTT', 3.1.1}

channels

Number of channels using the connection.

channel_max

Maximum number of channels on this connection.

Maximum frame size (bytes).

client_properties

Informational properties transmitted by the client during connection establishment.

ssl

Boolean indicating whether the connection is secured with SSL.

SSL protocol (e.g. “tlsv1”).

SSL key exchange algorithm (e.g. “rsa”).

SSL cipher algorithm (e.g. “aes_256_cbc”).

SSL hash function (e.g. “sha”).

conn_name

Readable name for the connection.

connection_state

Connection state; one of:

starting
running
blocked

connection

Id of the Erlang process associated with the internal amqp direct connection.

consumer_tags

A tuple of consumer tags for QOS0 and QOS1.

message_id

The last Packet ID sent in a control message.

client_id

MQTT client identifier for the connection.

clean_sess

MQTT clean session flag.

will_msg

MQTT Will message sent in CONNECT frame.

exchange

Exchange to route MQTT messages configured in rabbitmq_mqtt application environment.

ssl_login_name

SSL peer cert auth name

retainer_pid

Id of the Erlang process associated with retain storage for the connection.

user

Username associated with the connection.

vhost

Virtual host name with non-ASCII characters escaped as in C.

STOMP plugin

list_stomp_connections [stomp_connectioninfoitem]

Similar to the list_connections command, but returns fields which make sense for STOMP connections. stomp_connectioninfoitem parameter is used to indicate which connection information items to include in the results. The column order in the results will match the order of the parameters. stomp_connectioninfoitem can take any value from the list that follows:

conn_name

Readable name for the connection.

connection

Id of the Erlang process associated with the internal amqp direct connection.

connection_state

Connection state; one of:

running
blocking
blocked

session_id

STOMP protocol session identifier

channel

AMQP channel associated with the connection

version

Negotiated STOMP protocol version for the connection.

implicit_connect

Indicates if the connection was established using implicit connect (without CONNECT frame)

auth_login

Effective username for the connection.

auth_mechanism

STOMP authorization mechanism. Can be one of:

config
ssl
stomp_headers

port

Server port.

Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled.

peer_port

Peer port.

peer_host

Peer hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled.

protocol

STOMP protocol version, which can be on of the following:

{'STOMP', 0}
{'STOMP', 1}
{'STOMP', 2}

channels

Number of channels using the connection.

channel_max

Maximum number of channels on this connection.

Maximum frame size (bytes).

client_properties

Informational properties transmitted by the client during connection

ssl

Boolean indicating whether the connection is secured with SSL.

SSL protocol (e.g. “tlsv1”).

SSL key exchange algorithm (e.g. “rsa”).

SSL cipher algorithm (e.g. “aes_256_cbc”).