Connect Network Reference
The Network view on the Connect page shows every instance of a HiveMQ Broker or HiveMQ Edge the platform knows about. The view includes the instances connected to the platform and instances the platform has detected but not yet connected. This page explains how an instance appears in the Network view, what each column and value means, and what tasks you can do from a row.
The Empty State
For a fresh installation, the Network view appears empty. Connect displays No brokers or edges detected yet and offers three options:
-
Get a broker or edge: Deploy a new HiveMQ broker or edge in the cloud or on-prem. For instructions, see Deploy a Broker.
-
Connect what you already run: Register an existing HiveMQ broker or HiveMQ Edge instance. For instructions, see Connect a Broker or Edge with the Platform.
-
Get a license: Purchase a license for a self-managed HiveMQ Software broker. For instructions, see Get a License.
How a Broker or Edge Instance Appears in the Network View
You do not add a row to Connect directly. A row appears in Network when the platform first detects a deployment registered to your account. The platform detects a deployment after you do one of two tasks:
-
You generate a connection string for the deployment. For more information, see Connect what you already run.
-
You purchase a license for the deployment. For more information, see Get a license.
| Deploying a broker does not automatically add it to the Network view. An instance appears in Network only after it reports to the platform and the platform associates it 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. After a deployment with that license key completes an online entitlement call successfully, the Deployment changes to Software.
Data Intelligence
The Data Intelligence column shows you the state of the Broker or Edge during 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 Changes Its State
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 shows 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. |
Brokers deployed under a HiveMQ Cloud Serverless or Starter plan remain at the Data Intelligence Not eligible state. Data Intelligence is not available on those plans.
What You Can Do in a Row on Network
On Connect, in Network, select any broker or edge to open it. The Network view shows the name, type, and deployment of the instance in every state. For an instance that is not connected, the Network view shows a Reconnect option. To complete or retry the connection, click Reconnect. For more information, see Connect a Broker or Edge with the Platform.
Select the row for a broker to view Broker Details. To view more details for a HiveMQ Cloud broker, in Broker Details, click Configure For more information, see HiveMQ Cloud Cluster Details.
Troubleshooting:
"I Deployed a Broker, but It’s Not in Network on Connect"
This behavior is expected. A broker does not register with the platform when you deploy it. To appear in Network on Connect, a Broker instance must report to the platform and associate with your account. To add the Broker to Network, complete all steps for your deployment in Connect a Broker or Edge with the Platform. If you completed this procedure, and the instance does not connect, check the path to the configuration file, the connection string, and confirm that the broker restarted.