rabbitmqctl(8)

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

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.

list_global_parameters

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_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.

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

Returns exchange details. Exchange details of the "/" virtual host are returned if the -p flag is absent. The -p flag can be used to override this default.

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

name

The name of the exchange with non-ASCII characters escaped as in C.

type

The exchange type, such as:

direct
topic
headers
fanout

durable

Whether or not the exchange survives server restarts.

auto_delete

Whether the exchange will be deleted automatically when no longer used.

internal

Whether the exchange is internal, i.e. cannot be directly published to by a client.

arguments

Exchange arguments.

policy

Policy name for applying to the exchange.

If no exchangeinfoitem are specified then exchange name and type are displayed.

For example, this command displays the name and type for each exchange of the virtual host named "my-vhost":

rabbitmqctl list_exchanges -p my-vhost name type

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_queues [-p vhost] [--offline | --online | --local] [queueinfoitem ...]

Returns queue details. Queue details of the "/" virtual host are returned if the -p flag is absent. The -p flag can be used to override this default.

Displayed queues can be filtered by their status or location using one of the following mutually exclusive options:

--offline: List only those durable queues that are not currently available (more specifically, their leader node isn't).
--online: List queues that are currently available (their leader node is).
--local: List only those queues whose leader replica is located on the current node.

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

name: The name of the queue with non-ASCII characters escaped as in C.
durable: Whether or not the queue survives server restarts.
auto_delete: Whether the queue will be deleted automatically when no longer used.
arguments: Queue arguments.
policy: Effective policy name for the queue.
pid: Erlang process identifier of the queue.
owner_pid: Id of the Erlang process of the connection which is the exclusive owner of the queue. Empty if the queue is non-exclusive.
exclusive: True if queue is exclusive (i.e. has owner_pid), false otherwise.
exclusive_consumer_pid: Id of the Erlang process representing the channel of the exclusive consumer subscribed to this queue. Empty if there is no exclusive consumer.
exclusive_consumer_tag: Consumer tag of the exclusive consumer subscribed to this queue. Empty if there is no exclusive consumer.
messages_ready: Number of messages ready to be delivered to clients.
messages_unacknowledged: Number of messages delivered to clients but not yet acknowledged.
messages: Sum of ready and unacknowledged messages (queue depth).
messages_ready_ram: Number of messages from messages_ready which are resident in ram.
messages_unacknowledged_ram: Number of messages from messages_unacknowledged which are resident in ram.
messages_ram: Total number of messages which are resident in ram.
messages_persistent: Total number of persistent messages in the queue (will always be 0 for transient queues).
message_bytes: Sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead.
message_bytes_ready: Like message_bytes but counting only those messages ready to be delivered to clients.
message_bytes_unacknowledged: Like message_bytes but counting only those messages delivered to clients but not yet acknowledged.
message_bytes_ram: Like message_bytes but counting only those messages which are currently held in RAM.
message_bytes_persistent: Like message_bytes but counting only those messages which are persistent.
head_message_timestamp: The timestamp property of the first message in the queue, if present. Timestamps of messages only appear when they are in the paged-in state.
disk_reads: Total number of times messages have been read from disk by this queue since it started.
disk_writes: Total number of times messages have been written to disk by this queue since it started.
consumers: Number of consumers.
consumer_utilisation: Fraction of the time (between 0.0 and 1.0) that the queue is able to immediately deliver messages to consumers. This can be less than 1.0 if consumers are limited by network congestion or prefetch count.
memory: Bytes of memory allocated by the runtime for the queue, including stack, heap and internal structures.
mirror_pids: If the queue is mirrored, this lists the IDs of the mirrors (follower replicas). To learn more, see the RabbitMQ Mirroring guide
synchronised_mirror_pids: If the queue is mirrored, this gives the IDs of the mirrors (follower replicas) which are in sync with the leader replica. To learn more, see the RabbitMQ Mirroring guide
state: The state of the queue. Normally "running", but may be "{syncing, message_count}" if the queue is synchronising.
Queues which are located on cluster nodes that are currently down will be shown with a status of "down" (and most other queueinfoitem will be unavailable).
type: Queue type, one of: quorum, stream, classic.

If no queueinfoitem are specified then queue name and depth are displayed.

For example, this command displays the depth and number of consumers for each queue of the virtual host named "my-vhost"

rabbitmqctl list_queues -p my-vhost messages consumers

list_unresponsive_queues [--local] [--queue-timeout milliseconds] [queueinfoitem ...] [--no-table-headers]

Tests queue leader replicas to respond within the given timeout. Lists those which did not respond in time.

Displayed queues can be filtered by their status or location using one of the following mutually exclusive options:

--all: List all queues.
--local: List only those queues whose leader replica is located on the current node.

name: The name of the queue with non-ASCII characters escaped as in C.
durable: Whether or not the queue should survive server restarts.
auto_delete: Whether the queue will be deleted automatically when all of its explicit bindings are deleted.
arguments: Queue arguments.
policy: Effective policy name for the queue.
pid: Erlang process identifier of the leader replica.
recoverable_mirrors: Erlang process identifiers of the mirror replicas that are considered reachable (available).
type: Queue type, one of: quorum, stream, classic.

For example, this command lists only those unresponsive queues whose leader replica is hosted on the target node.

rabbitmqctl list_unresponsive_queues --local name

ping

Checks that the node OS process is up, registered with EPMD and CLI tools can authenticate with it

Example:

rabbitmqctl ping -n rabbit@hostname

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

schema_info [--no-table-headers] [column ...]

Lists schema database tables and their properties

For example, this command lists the table names and their active replicas:

rabbitmqctl schema_info name active_replicas

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

Runtime Parameters and Policies

Certain features of RabbitMQ (such as the Federation plugin) are controlled by dynamic, cluster-wide parameters. There are 2 kinds of parameters: parameters scoped to a virtual host and global parameters. Each vhost-scoped parameter consists of a component name, a name and a value. The component name and name are strings, and the value is a valid JSON document. A global parameter consists of a name and value. The name is a string and the value is an arbitrary Erlang data structure. Parameters can be set, cleared and listed. In general you should refer to the documentation for the feature in question to see how to set parameters.

Policies is a feature built on top of runtime parameters. Policies are used to control and modify the behaviour of queues and exchanges on a cluster-wide basis. Policies apply within a given vhost, and consist of a name, pattern, definition and an optional priority. Policies can be set, cleared and listed.

clear_global_parameter name

Clears a global runtime parameter. This is similar to clear_parameter but the key-value pair isn't tied to a virtual host.

name: The name of the global runtime parameter being cleared.

For example, this command clears the global runtime parameter "mqtt_default_vhosts":

rabbitmqctl clear_global_parameter mqtt_default_vhosts

clear_parameter [-p vhost] component_name key

Clears a parameter.

component_name: The name of the component for which the parameter is being cleared.
name: The name of the parameter being cleared.

For example, this command clears the parameter "node01" for the "federation-upstream" component in the default virtual host:

rabbitmqctl clear_parameter federation-upstream node01

Lists all global runtime parameters. This is similar to list_parameters but the global runtime parameters are not tied to any virtual host.

For example, this command lists all global parameters:

rabbitmqctl list_global_parameters

list_parameters [-p vhost]

Lists all parameters for a virtual host.

For example, this command lists all parameters in the default virtual host:

rabbitmqctl list_parameters

set_global_parameter name value

Sets a global runtime parameter. This is similar to set_parameter but the key-value pair isn't tied to a virtual host.

name: The name of the global runtime parameter being set.
value: The value for the global runtime parameter, as a JSON document. In most shells you are very likely to need to quote this.

For example, this command sets the global runtime parameter "mqtt_default_vhosts" to the JSON document {"O=client,CN=guest":"/"}:

rabbitmqctl set_global_parameter mqtt_default_vhosts '{"O=client,CN=guest":"/"}'

set_parameter [-p vhost] component_name name value

Sets a parameter.

component_name: The name of the component for which the parameter is being set.
name: The name of the parameter being set.
value: The value for the parameter, as a JSON document. In most shells you are very likely to need to quote this.

For example, this command sets the parameter "node01" for the "federation-upstream" component in the default virtual host to the following JSON "guest":

rabbitmqctl set_parameter federation-upstream node01 '{"uri":"amqp://user:password@server/%2F","ack-mode":"on-publish"}'

list_policies [-p vhost]

Lists all policies for a virtual host.

For example, this command lists all policies in the default virtual host:

rabbitmqctl list_policies

set_operator_policy [-p vhost] [--priority priority] [--apply-to apply-to] name pattern definition

Sets an operator policy that overrides a subset of arguments in user policies. Arguments are identical to those of set_policy.

Supported arguments are:

expires
message-ttl
max-length
max-length-bytes

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

Sets a policy.

name

The name of the policy.

pattern

The regular expression, which when matches on a given resources causes the policy to apply.

definition

The definition of the policy, as a JSON document. In most shells you are very likely to need to quote this.

priority

The priority of the policy as an integer. Higher numbers indicate greater precedence. The default is 0.

apply-to

Which types of object this policy should apply to. Possible values are:

queues
exchanges
all

The default is all ..

For example, this command sets the policy "federate-me" in the default virtual host so that built-in exchanges are federated:

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

clear_policy [-p vhost] name

Clears a policy.

name: The name of the policy being cleared.

For example, this command clears the "federate-me" policy in the default virtual host:

rabbitmqctl clear_policy federate-me

clear_operator_policy [-p vhost] name

Clears an operator policy. Arguments are identical to those of clear_policy.

list_operator_policies [-p vhost]

Lists operator policy overrides for a virtual host. Arguments are identical to those of list_policies.

Virtual hosts

Note that rabbitmqctl manages the RabbitMQ internal user database. Permissions for users from any alternative authorisation backend will not be visible to rabbitmqctl.

add_vhost vhost [--description desc --tags tags --default-queue-type default-q-type]

vhost: The name of the virtual host entry to create.
desc: Arbitrary virtual host description, e.g. its purpose, for operator's convenience.
tags: A comma-separated list of virtual host tags for operator's convenient
default-q-type: If clients do not specify queue type explicitly, this type will be used. One of: quorum, stream.

Creates a virtual host.

For example, this command instructs the RabbitMQ broker to create a new virtual host called "project9_dev_18":

rabbitmqctl add_vhost project9_dev_18 --description 'Dev environment no. 18' --tags dev,project9

clear_vhost_limits [-p vhost]

Clears virtual host limits.

For example, this command clears vhost limits in vhost "qa_env":

rabbitmqctl clear_vhost_limits -p qa_env

delete_vhost vhost

vhost: The name of the virtual host entry to delete.

Deletes a virtual host.

Deleting a virtual host deletes all its exchanges, queues, bindings, user permissions, parameters and policies.

For example, this command instructs the RabbitMQ broker to delete the virtual host called "test":

rabbitmqctl delete_vhost a-vhost

list_vhost_limits [-p vhost] [--global] [--no-table-headers]

Displays configured virtual host limits.

--global: Show limits for all vhosts. Suppresses the -p parameter.

restart_vhost [-p vhost]

vhost: The name of the virtual host entry to restart, defaulting to "/".

Restarts a failed vhost data stores and queues.

For example, this command instructs the RabbitMQ broker to restart a virtual host called "test":

rabbitmqctl restart_vhost test

set_vhost_limits [-p vhost] definition

Sets virtual host limits.

definition

The definition of the limits, as a JSON document. In most shells you are very likely to need to quote this.

Recognised limits are:

max-connections
max-queues

Use a negative value to specify "no limit".

For example, this command limits the max number of concurrent connections in vhost "qa_env" to 64:

rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 64}'

This command limits the max number of queues in vhost "qa_env" to 256:

rabbitmqctl set_vhost_limits -p qa_env '{"max-queues": 256}'

This command clears the max number of connections limit in vhost "qa_env":

rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": -1}'

This command disables client connections in vhost "qa_env":

rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 0}'

set_user_limits username definition

Sets user limits.

username

The name of the user to apply limits to

definition

The definition of the limits, as a JSON document. In most shells you are very likely to need to quote this.

Recognised limits are:

max-connections
max-channels

Use a negative value to specify "no limit".

For example, this command limits the max number of concurrent connections a user is allowed to open "limited_user" to 64:

rabbitmqctl set_user_limits limited_user '{"max-connections": 64}'

This command limits the max number of channels a user is allowed to open on a connection "limited_user" to 16:

rabbitmqctl set_user_limits limited_user '{"max-channels": 16}'

This command clears the max number of connections limit for user "limited_user":

rabbitmqctl clear_user_limits limited_user 'max-connections'

This command disables client connections for user "limited_user":

rabbitmqctl set_user_limits limited_user '{"max-connections": 0}'

clear_user_limits username limit

Clears user limits.

username: The name of the user to clear limits of
limit: The name of the limit or "all" to clear all limits at once.

Recognised limits are:

max-connections
max-channels

For example, this command clears max connection limits of user "limited_user":

rabbitmqctl clear_user_limits limited_user 'max-connections'

This command clears all limits of user "limited_user":

rabbitmqctl clear_user_limits limited_user all

trace_off [-p vhost]

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

Stops tracing.

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 node is restarted.

Configuration

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

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

set_cluster_name name

Sets the cluster name to name. The cluster name is announced to clients on connection, and used by the federation and shovel plugins to record where a message has been. The cluster name is by default derived from the hostname of the first node in the cluster, but can be changed.

For example, this sets the cluster name to "london":

rabbitmqctl set_cluster_name london

set_disk_free_limit disk_limit

disk_limit: Lower bound limit as an integer in bytes or a string with memory unit symbols (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.

set_log_level [log_level]

Sets log level in the running node

Supported log_level values are:

debug
info
warning
error
critical
none

Example:

rabbitmqctl set_log_level debug

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 unit symbol(e.g. 512M or 1G). Available unit symbols 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)

Feature flags

enable_feature_flag feature_flag

Enables a feature flag on the target node.

Example:

rabbitmqctl enable_feature_flag stream_queue

You can also enable all feature flags by specifying "all":

rabbitmqctl enable_feature_flag all

list_feature_flags [column ...]

Lists feature flags

Supported column values are:

name
state
stability
provided_by
desc
doc_url

Example:

rabbitmqctl list_feature_flags name state

Connection Operations

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

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"

Misc

eval expression: Evaluates an Erlang expression on the target node

Queue Operations

delete_queue queue_name [--if-empty | -e] [--if-unused | -u]

queue_name: The name of the queue to delete.
--if-empty: Delete the queue if it is empty (has no messages ready for delivery)
--if-unused: Delete the queue only if it has no consumers

Deletes a queue.

purge_queue [-p vhost] queue

queue: The name of the queue to purge.

Purges a queue (removes all messages in it).

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 turned off.

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 turned off.

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.

TLS protocol (e.g. "tlsv1").

TLS key exchange algorithm (e.g. "rsa").

TLS cipher algorithm (e.g. "aes_256_cbc").