Connecting to RabbitMQ

About RabbitMQ Management HTTP API

RabbitMQ is an open-source message broker that supports multiple messaging protocols. The RabbitMQ Management HTTP API provides HTTP-based access to management and monitoring data for a RabbitMQ server. The API exposes information about virtual hosts, exchanges, queues, bindings, connections, channels, consumers, users, permissions, policies, and cluster-wide statistics.

The Management plugin must be enabled on the RabbitMQ server for the HTTP API to be available. By default, the management interface listens on port 15672.

Using Basic Authentication

RabbitMQ Management HTTP API uses HTTP Basic authentication. You must supply the username and password of a RabbitMQ management user.

To enable access to the management API:

1. Ensure the RabbitMQ Management plugin is enabled on your server (rabbitmq-plugins enable rabbitmq_management).
2. Use an existing management user or create one with the appropriate management tag (management, policymaker, monitoring, or administrator).
3. Note the full base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).

After configuring your RabbitMQ server, set the following connection properties to connect:

• AuthScheme: Set this to Basic.
• URL: Set this to the base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).
• User: Set this to your RabbitMQ management username (e.g., guest).
• Password: Set this to your RabbitMQ management password.

Example connection string:

Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;

Available Tables

The RabbitMQ profile provides access to the following tables:

• Overview - Cluster-wide statistics and information about the RabbitMQ node
• Nodes - Information about individual nodes in the RabbitMQ cluster
• NodeMemory - Detailed memory usage breakdown for a specific cluster node
• Connections - List of all open AMQP connections to the broker
• Channels - List of all open AMQP channels across all connections
• Consumers - List of all consumers registered across all queues
• Exchanges - List of exchanges declared across all virtual hosts
• Queues - List of queues declared across all virtual hosts
• Bindings - List of all bindings between exchanges and queues
• VirtualHosts - List of virtual hosts configured on the broker
• VhostPermissions - User permissions within a specific virtual host
• Users - List of all RabbitMQ users
• Permissions - Permission records for all users across all virtual hosts
• TopicPermissions - Topic-level permission records for all users
• Policies - List of policies applied to queues and exchanges in virtual hosts
• OperatorPolicies - List of operator policies applied to queues in virtual hosts
• Parameters - List of component parameters (e.g., federation, shovel) per virtual host
• GlobalParameters - List of global parameters that apply across all virtual hosts
• VhostLimits - Resource limits configured for specific virtual hosts
• UserLimits - Resource limits configured for specific users
• FeatureFlags - List of feature flags and their enabled/disabled state on the node
• DeprecatedFeatures - List of deprecated features and their usage state
• AuthAttempts - Authentication attempt statistics for the node
• ClusterName - The name of the RabbitMQ cluster
• WhoAmI - Information about the currently authenticated management user
• ExchangeBindingsSource - Bindings for which a specific exchange is the source
• ExchangeBindingsDestination - Bindings for which a specific exchange is the destination
• QueueBindings - Bindings for a specific queue within a virtual host

Usage Examples

AuthAttempts:

SELECT * FROM AuthAttempts WHERE NodeName = 'rabbit@hostname'

Bindings:

SELECT * FROM Bindings

Channels:

SELECT * FROM Channels

ClusterName:

SELECT * FROM ClusterName

Connections:

SELECT * FROM Connections

Consumers:

SELECT * FROM Consumers

DeprecatedFeatures:

SELECT * FROM DeprecatedFeatures

ExchangeBindingsDestination:

SELECT * FROM ExchangeBindingsDestination WHERE Vhost = '/' AND ExchangeName = 'amq.direct'

ExchangeBindingsSource:

SELECT * FROM ExchangeBindingsSource WHERE Vhost = '/' AND ExchangeName = 'amq.direct'

Exchanges:

SELECT * FROM Exchanges

FeatureFlags:

SELECT * FROM FeatureFlags

GlobalParameters:

SELECT * FROM GlobalParameters

NodeMemory:

SELECT * FROM NodeMemory WHERE NodeName = 'rabbit@hostname'

Nodes:

SELECT * FROM Nodes

OperatorPolicies:

SELECT * FROM OperatorPolicies

Overview:

SELECT * FROM Overview

Parameters:

SELECT * FROM Parameters

Permissions:

SELECT * FROM Permissions

Policies:

SELECT * FROM Policies

QueueBindings:

SELECT * FROM QueueBindings WHERE Vhost = '/' AND QueueName = 'my.queue'

Queues:

SELECT * FROM Queues

TopicPermissions:

SELECT * FROM TopicPermissions

UserLimits:

SELECT * FROM UserLimits

Users:

SELECT * FROM Users

VhostLimits:

SELECT * FROM VhostLimits

VhostPermissions:

SELECT * FROM VhostPermissions WHERE Vhost = '/'

VirtualHosts:

SELECT * FROM VirtualHosts

WhoAmI:

SELECT * FROM WhoAmI

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are Basic or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT