Broker and Edge Listing Reference
The Connect tab opens on a list of every broker and edge the platform knows about. The list includes the instances connected to the platform and instances the platform has detected but not yet connected. This page explains how an instance appears, what each column and value means, and what you can do from a row.
The Empty State
On a fresh installation, the list is empty. The platform reports No brokers or edges detected yet and offers three options:
-
Get a broker or edge: Deploy a new broker or edge in the cloud or on-prem. See Deploy a Broker.
-
Connect what you already run: Register an existing HiveMQ broker, HiveMQ Edge, or Mosquitto instance. See Connect a Broker or Edge with the Platform.
-
Get a license: Purchase a license for a self-managed HiveMQ Software broker. See Get a License.
How an Instance Appears in the List
You do not add a row directly. A row appears when the platform first detects a deployment tied to your account. A deployment can be detected in one of two ways:
-
You generate a connection string for the deployment through the (Connect what you already run) option.
-
You purchase a license for the deployment through the (Get a license) option.
| Deploying a broker does not automatically add it to the list. A broker appears only after a component reports to the platform and the platform associates the component with your account. If you have a running broker but the list is empty, you have not yet connected the broker. For more information, see Troubleshooting. |
Columns
| Column | What it Shows | Values |
|---|---|---|
Name |
The display name you chose for the instance |
Free-text display name |
Type |
What kind of instance this is |
|
Deployment |
How the instance is run and licensed |
|
Data Intelligence |
Whether the instance is connected to the Data Intelligence capabilities of the platform |
|
Name
The display name you entered when you created the connection string or purchased the license. The platform shows the name with an optional description. The name is a label that helps you recognize the instance. You can choose any name. Names do not need to be unique and do not have to match the hostname or cluster name of the broker.
Deployment
-
Cloud: A HiveMQ Cloud broker that HiveMQ manages and operates.
-
Software: A HiveMQ broker that you deploy and that reports to the platform.
-
License — a license you have purchased but have not yet deployed and connected. Once a deployment with that license key phones home, the Deployment changes to Software.
Data Intelligence
The Data Intelligence column tells you where the instance is in the connection process.
| State | Meaning |
|---|---|
Not ready to connect |
The deployment is still pending. This state typically applies after you purchase a license but before any deployment reports to the platform. |
Ready to connect |
The instance is known to the platform, but the connection is still pending. This state appears right after you generate a connection string and before the broker applies it. |
Connected |
The instance is up, running, and connected to Data Intelligence. This state is the goal. |
Offline |
The instance was connected but no longer reaches the platform. For example, the broker was shut down and has stopped reporting to the platform. |
Not eligible |
The instance cannot use Data Intelligence. This state applies to HiveMQ Cloud Serverless and Starter plans. You can connect all other deployments. |
How an Instance Moves Through These States
Self-Managed Broker (Software)
-
You generate a connection string and the broker appears. Data Intelligence shows Ready to connect.
-
You apply the connection string and restart the broker. The broker connects. Data Intelligence shows Connected.
Purchased License
-
You buy a license. The license appears with Deployment License, Data Intelligence Not ready to connect.
-
You deploy a broker, apply the license key, and the broker reports to the platform. Deployment changes to Software and Data Intelligence shows Ready to connect.
-
You apply the connection string and restart the broker. Data Intelligence shows Connected.
| A purchased license still requires the connection-string step. A license alone does not connect the broker. |
HiveMQ Cloud Serverless / Starter remain at Data Intelligence Not eligible. Data Intelligence is not available on those plans.
What You Can Do from a Row
Select any broker or edge to open it. The detail view shows the name, type, and deployment of the instance in every state. What differs is the connection state. For an instance that is not connected, the detail view shows a Reconnect option. Click Reconnect to complete or retry the connection.
-
For Cloud clusters, you can also manage the cluster. For more information, see the HiveMQ Cloud documentation.
Troubleshooting: "I Deployed a Broker but It’s Not in the List"
This behavior is expected. A broker does not register with the platform when you deploy it. First, a component must report to the platform and associate with your account. To add the broker to the list, complete these steps:
-
Go to Connect what you already run and select Broker or Edge.
-
Enter a name and description, then generate a connection string.
-
Apply the connection string to your deployment and restart the broker.
After step 2, the instance appears as Ready to connect. After step 3, the instance connects and moves to Connected. See Connect a Broker or Edge with the Platform.