Troubleshooting Agent Communications


- Overview

- Using the Agent Configuration Tool

- Troubleshooting Connection Errors

- Incorrect Port

- Failed Lookups

- Firewall is Blocking the Connection

- SiteBackup Server

- SiteBackup Agent


Overview

The Agent Configuration Tool is installed with Macrium SiteManager Platform. This tool can be used to assist in troubleshooting communication issues between the agents and the server. The Agent Configuration Tool can be downloaded on the 'Computers' page of SiteBackup, by selecting 'More Actions' then 'Manual Agent Installation'.

The Agent Configuration Tool can also be found at the following local paths.

SiteBackup Server:

C:\ProgramFiles\Macrium\SiteManager\AgentFiles\AgentConfigTool_x64/x86.exe

SiteBackup Agent:

C:\ProgramFiles\Macrium\Agent\AgentConfigTool.exe


Using the Agent Configuration Tool

The 'Connection' section of the 'Agent Configuration Tool' controls the TCP port that the SiteBackup Agent will use when attempting to connect to the SiteBackup server (51515 by default), and the connection method(s) and details for the connection.

Select 'Add' to add a connection method for the SiteBackup server. In the window that opens, enter the connection details of the SiteBackup server next to the relevant connection method. The SiteBackup Agent requires the IP (IPv4 or IPv6) address of the SiteBackup server, but can also resolve the NetBIOS or DNS name to the IP.

Select 'Add' to add the connection details to the table.

By clicking the 'Test' button the Agent Configuration Tool will attempt to connect to the SiteBackup server with all the specified connection methods. The results of the test will then be reported in the table:

If at least one test in the table is reported as 'Successful' the agent will be able to connect to SiteBackup server. If all the tests in the table are reported as 'Failed' the SiteBackup Agent will not be able to communicate with the SiteBackup server, some of the causes that may prevent the connection are shown below:


Troubleshooting Connection Errors

Incorrect Port

By default, SiteBackup uses TCP port 51515 for communications with SiteBackup Agents. This can be changed in the SiteManager Platform settings, as described here.

Failed Lookups

To connect DNS or NetBIOS names, the Agent Configuration Tool and SiteBackup Agent perform name lookups to resolve the name to an IP address. This uses both DNS and broadcast LLMNR lookups. To confirm that the lookups are working correctly, check the Agent Config Tool log in C:\ProgramData\Macrium\SiteManager\AgentConfigTool.log and attempt to ping the names directly using a Windows command line.

Firewall is Blocking the Connection 

 

SiteBackup Server

The firewall of the machine hosting SiteBackup must allow incoming TCP connections on the port specified in the 'Agent' page of the SiteManager Platform server settings. SiteBackup uses 51515 as the default port.

 

SiteBackup Agent

The firewall on the SiteBackup Agent must allow outbound TCP traffic on the specified port.