Relay settings

The Settings > Data > Relay page lets admins manage relay agents and agent groups, which allow you to securely connect to data sources inside your own network.

The page is only visible to administrators. Agents and agent groups are listed in two separate tables, each with its own search box.

Agents

Relay agents allow you to securely connect to data sources inside your own network (on-prem).

A relay agent is installed on a server on your internal network, and has access to your data source.

When a plugin uses a relay agent it means that you don't need to open your firewall to allow SquaredUp access to the data source.

See Deploying a relay agent.

Column
Description
Status
An icon reporting whether the agent is connected. Hover it for the reason and the time the agent last connected, or never if it has not connected yet.
Name
The name given to the agent.
Description
The description given to the agent, if it has one.
Host
The hostname of the server the agent is installed on.
Platform
The operating system the agent runs on.
Version
The agent version. A warning icon appears when a newer version is available, naming that version. An agent that has not reported a version shows unknown.
API Key
The last four characters of the agent API key. The rest is masked and cannot be revealed.
Agent Group(s)
The agent groups the agent belongs to. An agent in no group is flagged in red, because it cannot be used to retrieve data until it joins one.

Adding an agent generates its API key and shows it once, along with the installation options for Windows and Linux. Copy the key before closing the window, because it cannot be shown again.

Agent controls

Icon
Control
Description
—
Search
Enter text to filter the agents list.
—
Add agent
Click to open the Add agent window.
Deploy SquaredUp Cloud agent
Click to open the installation options: a Windows agent download, or the Linux agent image on Docker Hub.
Edit agent
Click to open the Edit agent window and change the agent name, description, groups or API key.
Delete agent
Click to permanently remove the agent. Any data source relying on it stops retrieving data.

Agent status

Status
Meaning
Agent connected
The agent has checked in within the last six minutes.
Agent heartbeat missed
The agent has not checked in for more than six minutes. Either it is not running, or it cannot reach SquaredUp.
Awaiting first connection
The agent has been added but has never connected. Expect this between adding an agent and installing it.
Agent disabled (not included in current plan)
Relay agents are not included in your plan, so the agent is not used.

Add agent window

Setting
Description
Name
Required. Enter a name for the agent, from 2 to 128 characters. Agent names must be unique.
Description
Enter a description for the agent, up to 128 characters.
Agent group(s)
Select the groups the agent belongs to. Each option names the group and the platform it is restricted to. A group is unavailable when a data source assigned to it does not support this agent's platform.
API key
Generated for you when you click Next. When editing an existing agent you can replace the key here, and the new key takes effect when you save.

Agent Groups

Agent groups dynamically determine which agents are used to retrieve data.

See Agent Groups.

Column
Description
Status
An icon reporting how many of the group's agents are currently listening. Hover it for the count, shown as N of M agents listening.
Name
The name given to the group.
Description
The description given to the group, if it has one.
Platform
The platform inferred from the agents in the group. Shows Mixed when the agents do not all run the same platform, and Unknown when the group has no agents.
Agent(s)
The agents in the group. A group with no agents is flagged in red, because it cannot retrieve data.

An agent joins a group from either side: from the agent, or from the group. Both write the same membership.

Agent group controls

Icon
Control
Description
—
Search
Enter text to filter the agent groups list.
—
Add agent group
Click to open the Add agent group window.
Edit agent group
Click to open the Edit agent group window and change the group name, description or members.
Delete agent group
Click to permanently remove the group. Any data source assigned to it stops retrieving data.

Agent group status

A group is healthy when every agent in it is listening. Where only some are, the group still works but has lost redundancy. Where none are, the group cannot retrieve data.

Add agent group window

Setting
Description
Name
Required. Enter a name for the group, from 2 to 128 characters. Group names must be unique.
Description
Enter a description for the group, up to 128 characters.
Agent(s)
Select the agents in the group. Each option names the agent and its platform. An agent is unavailable when a data source assigned to the group does not support that agent's platform.

A group's platform is inferred from its agents rather than set directly, so it changes as agents join and leave.

Permissions and plans

Only administrators can reach this page.

Relay agents depend on your plan. Where they are not included, agents and groups stay listed but are not used, Add agent and Add agent group are unavailable, and the install and edit buttons are hidden. Delete stays available.

There is no limit on how many agents or agent groups you can create.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket