RabbitMQ

https://www.rabbitmq.com/docs
Admin
RabbitMQ is an open-source message broker that enables applications to communicate with each other...
Tokens:635,213
Snippets:5,487
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /api/global-parameters - rabbitmqadmin example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists all global runtime parameters using rabbitmqadmin.

```bash
rabbitmqadmin global_parameters list
```

--------------------------------

### GET /api/policies - rabbitmqadmin example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists policies across all virtual hosts using rabbitmqadmin.

```bash
rabbitmqadmin list policies
```

--------------------------------

### Start Portal

Source: https://www.rabbitmq.com/docs/oauth2-examples-idp-initiated

Starts the Portal application.

```bash
make start-portal  
```

--------------------------------

### Enable Web MQTT examples plugin

Source: https://www.rabbitmq.com/docs/web-mqtt

Enables the RabbitMQ Web MQTT examples plugin. After enabling, the examples are available at http://127.0.0.1:15670/.

```bash
rabbitmq-plugins enable rabbitmq_web_mqtt_examples
```

--------------------------------

### Start UAA with make start-uaa

Source: https://www.rabbitmq.com/docs/oauth2-examples-idp-initiated

Command to start UAA. The commands used to start UAA, RabbitMQ, and the web portal automatically generate their x.509 certificates required for HTTPS.

```bash
make start-uaa  

```

--------------------------------

### Quick Start Script for Team RabbitMQ apt Repository

Source: https://www.rabbitmq.com/docs/install-debian

Shell script that provisions RabbitMQ and Erlang from a Team RabbitMQ-hosted apt repository. Installs required packages, adds the Team RabbitMQ signing key, and configures the apt repository before installing RabbitMQ. Only provides amd64 (x86-64) Erlang packages; arm64 (aarch64) requires modification to use a supported Erlang series from Launchpad.

```shell
#!/bin/sh  

sudo apt-get install curl gnupg apt-transport-https -y  

## Team RabbitMQ's signing key  
curl -1sLf "https://keys.openpgp.org/vks/v1/by-fingerprint/0A9AF2115F4687BD29803A206B73A36E6026DFCA" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/com.rabbitmq.team.gpg > /dev/null  

## Add apt repositories maintained by Team RabbitMQ  
sudo tee /etc/apt/sources.list.d/rabbitmq.list <<EOF  

## Modern Erlang/OTP releases  

##  

deb [arch=amd64 signed-by=/usr/share/keyrings/com.rabbitmq.team.gpg] https://deb1.rabbitmq.com/rabbitmq/DEB.asc
EOF

```

--------------------------------

### Install rabbitmqadmin via Homebrew tap

Source: https://www.rabbitmq.com/docs/management-cli

Installs rabbitmqadmin from Team RabbitMQ's Homebrew tap. Run these two commands in order to add the tap and install the tool.

```shell
brew tap rabbitmq/tap  

brew install rabbitmqadmin  
```

--------------------------------

### Example JWT token with variable expansion scope

Source: https://www.rabbitmq.com/docs/oauth2

Shows a JWT token with a scope using variable expansion for vhost and sub claim. The user connected to vhost 'prod' gets write permission on exchanges starting with 'x-prod-' and routing keys starting with 'u-bob-'.

```json
{
  "sub" : "bob",
  "scope" : [ "rabbitmq.write:*/x-{vhost}-*/u-{sub}-*" ]
}
```

--------------------------------

### Example output of show overview

Source: https://www.rabbitmq.com/docs/management-cli

Example output of the rabbitmqadmin show overview command, displaying a table with key-value pairs such as Product name and Product version.

```text
┌───────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Overview                                                                                                                                                            │
├───────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────┤
│ key                                                               │ value                                                                                           │
├───────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Product name                                                      │ RabbitMQ                                                                                        │
├───────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Product version                                                   │ 4.3.1                                                                                           │
```

--------------------------------

### Start Keycloak with make start-keycloak

Source: https://www.rabbitmq.com/docs/oauth2-examples-keycloak

Deploys the preconfigured Keycloak server with the required scopes, users, and clients. Use admin:admin when prompted for credentials to access the Keycloak Administration page.

```bash
make start-keycloak  
```

--------------------------------

### Install RabbitMQ Windows service with rabbitmq-service.bat install

Source: https://www.rabbitmq.com/docs/install-windows-manual

Installs the RabbitMQ service. After installation, a service with the name defined by RABBITMQ_SERVICENAME should appear in the Windows Services control panel (Start > Run services.msc).

```bat
rabbitmq-service.bat install  
```

--------------------------------

### Install RabbitMQ via Homebrew

Source: https://www.rabbitmq.com/docs/install-homebrew

Installs the RabbitMQ formula from Homebrew's core tap. This installs a supported Erlang/OTP version as a dependency but does not start the RabbitMQ service.

```bash
brew install rabbitmq  
```

--------------------------------

### Import definitions after node boot using rabbitmqctl and rabbitmqadmin

Source: https://www.rabbitmq.com/docs/definitions

Use these commands to import definitions after node boot. First, await startup with rabbitmqctl await_startup --timeout 300. Then import definitions using either rabbitmqctl import_definitions or rabbitmqadmin definitions import (the latter requires the management plugin to be enabled).

```bash
# await startup for up to 5 minutes  

rabbitmqctl await_startup --timeout 300  

  

# import definitions using rabbitmqctl  

rabbitmqctl import_definitions /path/to/definitions.file.json  

  

# OR, import using rabbitmqadmin  

# Requires management plugin to be enabled  

rabbitmqadmin definitions import /path/to/definitions.file.json  

```

--------------------------------

### Install Essential Dependencies

Source: https://www.rabbitmq.com/docs/install-debian

Updates the package index and installs curl and gnupg, which are required for the subsequent repository setup steps.

```bash
sudo apt-get update -y  

  

sudo apt-get install curl gnupg -y  
```

--------------------------------

### Start UAA

Source: https://www.rabbitmq.com/docs/oauth2-examples

Launches the UAA authorization server.

```bash
make start-uaa
```

--------------------------------

### GET /api/global-parameters - curl example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists all global runtime parameters using curl.

```bash
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters
```

--------------------------------

### Start Keycloak

Source: https://www.rabbitmq.com/docs/oauth2-examples-multiresource

Launches Keycloak. Check the admin page with credentials admin:admin. It is recommended to follow the logs until Keycloak is fully initialized.

```makefile
make start-keycloak  

```

--------------------------------

### Start RabbitMQ Node in Foreground

Source: https://www.rabbitmq.com/docs/install-homebrew

Starts a RabbitMQ node in the foreground using the Homebrew installation. Sets the CONF_ENV_FILE environment variable to the RabbitMQ environment configuration file before launching the server.

```bash
CONF_ENV_FILE="/opt/homebrew/etc/rabbitmq/rabbitmq-env.conf" /opt/homebrew/opt/rabbitmq/sbin/rabbitmq-server
```

--------------------------------

### Start RabbitMQ with scenario1 config

Source: https://www.rabbitmq.com/docs/oauth2-examples-multiresource

Starts RabbitMQ with the scenario1 configuration file, using the multi-keycloak mode.

```makefile
MODE="multi-keycloak" CONF="rabbitmq.scenario1.conf" make start-rabbitmq  

```

--------------------------------

### Deploy example workload with docker compose

Source: https://www.rabbitmq.com/docs/prometheus

Deploys the example workload app defined in docker-compose-overview.yml. Running the same command again after editing the file redeploys the app.

```bash
docker compose -f docker-compose-overview.yml up -d
```

--------------------------------

### GET /api/policies - curl example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists policies across all virtual hosts using curl.

```bash
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/policies
```

--------------------------------

### Start stunnel with concatenated certificate and key

Source: https://www.rabbitmq.com/docs/troubleshooting-ssl

Concatenates the client certificate and private key into a single PEM file, then starts stunnel in daemon mode using the stunnel.conf configuration file. The certificate and private key must be concatenated as shown before starting stunnel.

```bash
cat client_key.pem client_certificate.pem > client/key-cert.pem

stunnel stunnel.conf
```

--------------------------------

### Delete workload containers with docker compose down

Source: https://www.rabbitmq.com/docs/prometheus

Deletes all workload containers started by the example workload app.

```bash
docker compose -f docker-compose-overview.yml down
```

--------------------------------

### Install RabbitMQ RPM with signing key from GitHub

Source: https://www.rabbitmq.com/docs/install-rpm

Use this command sequence to import the RabbitMQ signing key from GitHub and install the server package with dnf. It also installs the logrotate dependency. The package is suitable for both RHEL 9/10 and RHEL 8-based distributions.

```bash
rpm --import https://github.com/rabbitmq/signing-keys/releases/download/3.0/rabbitmq-release-signing-key.asc  

## install these dependencies from standard OS repositories  
dnf install -y logrotate  

# The RabbitMQ RPM package is suitable for both RHEL 9 and 10 (modern) and RHEL 8-based (older) distributions  
dnf install -y rabbitmq-server-4.3.6-1.el8.noarch.rpm  
```

--------------------------------

### Node startup log with home directory

Source: https://www.rabbitmq.com/docs/cli

Example log output from a RabbitMQ node startup, showing the node name and home directory. The cookie file is looked for in this directory unless server directories are overridden.

```text
node           : rabbit@cdbf4de5f22d
home dir       : /var/lib/rabbitmq
```

--------------------------------

### GET /api/operator-policies - curl example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists operator policies across all virtual hosts using curl.

```bash
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/operator-policies
```

--------------------------------

### Start RabbitMQ with make start-rabbitmq

Source: https://www.rabbitmq.com/docs/oauth2-examples-forward-proxy

Deploys RabbitMQ in its own network rabbitmq_net and starts it. Requires setting the Tanzu RabbitMQ OCI image name and tag via environment variables before running the make command.

```bash
export IMAGE=<Tanzu RabbitMQ OCI image name>

export IMAGE_TAG=<Tanzu RabbitMQ OCI image tag>

MODE=forward-proxy OAUTH_PROVIDER=keycloak make start-rabbitmq
```

--------------------------------

### GET /api/operator-policies - rabbitmqadmin example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists operator policies across all virtual hosts using rabbitmqadmin.

```bash
rabbitmqadmin list operator_policies
```

--------------------------------

### Install dependencies from standard repositories

Source: https://www.rabbitmq.com/docs/install-rpm

Installs the logrotate package from standard OS repositories, a prerequisite for RabbitMQ.

```bash
## install these dependencies from standard OS repositories  
dnf install -y logrotate  

```

--------------------------------

### GET /api/vhost-limits - curl example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists all virtual host limits configured across the cluster using curl.

```bash
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/vhost-limits
```

--------------------------------

### GET /api/global-parameters/{_name_} - curl example

Source: https://www.rabbitmq.com/docs/http-api-reference

Returns the value of a specific global runtime parameter using curl.

```bash
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_name
```

--------------------------------

### Start RabbitMQ nodes on three machines

Source: https://www.rabbitmq.com/docs/clustering

Starts RabbitMQ in detached mode on each of the three machines (rabbit1, rabbit2, rabbit3) to create three independent brokers. Run these commands after RabbitMQ is installed and the rabbitmq-server script is in the PATH.

```shell
# on rabbit1  

rabbitmq-server -detached  

# on rabbit2  

rabbitmq-server -detached  

# on rabbit3  

rabbitmq-server -detached  
```

--------------------------------

### Start RabbitMQ with MODE and OAUTH_PROVIDER

Source: https://www.rabbitmq.com/docs/oauth2-examples-idp-initiated

Run this command to start RabbitMQ with the portal mode and UAA OAuth provider. After startup, verify the expected version by searching for `Running RabbitMQ (<image>:<image_tag>) with` in `docker logs rabbitmq`.

```bash
export MODE=portal  

OAUTH_PROVIDER=uaa make start-rabbitmq  

```

--------------------------------

### Start multiple RabbitMQ nodes with distinct management plugin ports

Source: https://www.rabbitmq.com/docs/clustering

Starts two RabbitMQ nodes on a single machine with distinct management plugin ports to avoid collisions. This is used when the management plugin is installed and the nodes can then be clustered.

```bash
RABBITMQ_NODE_PORT=5672 RABBITMQ_SERVER_START_ARGS="-rabbitmq_management listener [{port,15672}]" RABBITMQ_NODENAME=rabbit rabbitmq-server -detached  

RABBITMQ_NODE_PORT=5673 RABBITMQ_SERVER_START_ARGS="-rabbitmq_management listener [{port,15673}]" RABBITMQ_NODENAME=hare rabbitmq-server -detached  

```

--------------------------------

### Install RabbitMQ RPM with signing key from rabbitmq.com

Source: https://www.rabbitmq.com/docs/install-rpm

Alternative to the GitHub key import, this command sequence imports the RabbitMQ signing key from rabbitmq.com and installs the server package with dnf. It also installs the logrotate dependency. The package is suitable for both RHEL 9/10 and RHEL 8-based distributions.

```bash
rpm --import https://www.rabbitmq.com/rabbitmq-release-signing-key.asc  

## install these dependencies from standard OS repositories  
dnf install -y logrotate  

# The RabbitMQ RPM package is suitable for both RHEL 9 and 10 (modern) and RHEL 8-based (older) distributions  
dnf install -y rabbitmq-server-4.3.6-1.el8.noarch.rpm  
```

--------------------------------

### GET /api/vhost-limits/{_vhost_} - rabbitmqadmin example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists virtual host limits for a specific virtual host using rabbitmqadmin.

```bash
rabbitmqadmin --vhost "/" list vhost_limits
```

--------------------------------

### GET /api/policies/{_vhost_} - curl example

Source: https://www.rabbitmq.com/docs/http-api-reference

Lists policies in a specific virtual host. The virtual host name must be percent-encoded.

```bash
# The virtual host name must be percent-encoded
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/policies/%2F
```

--------------------------------

### Get individual connection metrics with curl

Source: https://www.rabbitmq.com/docs/http-api-reference

Returns metrics of an individual connection. The connection name must be percent-encoded, as shown in the example.

```bash
# the connection name must be percent-encoded  

curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/connections/127.0.0.1%3A54594%20-%3E%20127.0.0.1%3A5672 | jq  

```

--------------------------------

### Wait for cluster nodes with rabbitmqctl await_online_nodes

Source: https://www.rabbitmq.com/docs/man/rabbitmqctl.8

Waits for the specified number of nodes to join the cluster. In this example, waits for two RabbitMQ nodes to start.

```shell
rabbitmqctl await_online_nodes 2
```

--------------------------------

### Start Forward Proxy with make start-forward-proxy

Source: https://www.rabbitmq.com/docs/oauth2-examples-forward-proxy

Deploys and starts the forward proxy in two networks, keycloak_net and rabbitmq_net. The proxy is configured using httpd.conf, which inserts the access token into the HTTP Authorization header.

```bash
PROVIDER_NETWORK=keycloak_net make start-forward-proxy
```

--------------------------------

### List all plugins with verbose details

Source: https://www.rabbitmq.com/docs/man/rabbitmq-plugins.8

Shows all plugin details including versions, dependencies, and descriptions.

```shell
rabbitmq-plugins list -v
```
Tokens:
Raw