How do I download and install the SurePath agent?

To download and install the Entuity SurePath agent software

To manage your SurePath agents

Note on restricting access to a SurePath agent

Note on changing the network configuration on the server

SurePath uses tcptraceroute to create a TCP connection to the destination. tcptraceroute (the SurePath agent) has advantages over normal traceroute:

• SurePath agent sends packets to the destination. In this way, SurePath more closely mimics the behavior of an application, within your managed network or beyond it.
• the Entuity SurePath agent has enhanced tcptraceroute to remove queueing latency along each hop in the path.

Normal traceroute is agentless and uses ICMP, and therefore does not create a connection.

By default, Entuity comes with a SurePath agent installed on each Entuity server, but you can also download the SurePath agent software to non-Entuity servers (for example, if you are a MSP and want to run SurePath from a server at a customer site). The SurePath agent contains the traceroute software that goes out and collects and measures all the path data.

In Entuity, you can create up to 100 paths per agent. You can, however, have more agents. The overall number of paths you can create is determined by your license. For more information on licensing for SurePath in Entuity, see this article.

To download and install the Entuity SurePath agent software:

• Installing the Entuity SurePath agent software for Windows requires Npcap to be installed and the VCRUNTIME140.dll to be present within the C:\Windows\System32 directory. The Npcap driver and library are included in the Windows installation package for ENA v18.0 and upwards, which can be found in windows\system32. If you enable SurePath when running configure, you will be prompted to install the Npcap directory.

• For Linux, the libpcap.x86_64 and chrpath.x86_64 packages need to be installed. 

  In Red Hat and Oracle, run the following command:

  yum install -y libcap chrpath

  For Debian and Ubuntu, run the following command:

  apt install libcap.x86_64 chrpath.x86_64
   

   

To download the Entuity SurePath agent software:

Note, the commands in [square brackets] in the following procedure are variables - you must enter your own input.

1. From the Main Menu, click Administration and navigate to the SurePath Administration section of the Entuity Administration page.
2. Click Entuity SurePath Agent Software. 
   
   
   
   The Entuity Traceroute Agent Installation Packages page is displayed.
   
   
    
3. Do one of the following to download the SurePath Agent installer, based on the operating system of the server onto which you plan to install the software:
   • Click Download Windows Installer (for Windows), Download RPM (for Red Hat and Oracle Linux) or Download DEB (for Debian and Ubuntu Linux).
     
     Alternatively:
      

   • For Linux only, run one of these commands at a Linux shell (Requires root privileges.):

     • For Red Hat and Oracle:

       rpm -nodeps -ivh http://[local host]/EOS/entuitySurePathAgent/entuitySurePathAgent-[version].x86_64.rpm

     • For Debian and Ubuntu:

       dpkg -i http://[local host]/EOS/entuitySurePathAgent/entuitySurePathAgent-[version]_amd64.deb
        

      

To install a SurePath agent (Windows):

Note, you must have local administrator permissions to run the Entuity SurePath Agent installer.

1. On the Entuity server, navigate to the directory where you downloaded the msi installer file (see Step 3), and then upload the file to the server onto which you plan to install the agent software. 
2. On the target server, navigate to the directory where you uploaded the installer file in the previous step, and double-click or right-click the EntuitySurePathAgent.msi installer file.
   The Setup Wizard popup window is displayed.
3. From the Setup Wizard, click Next at the Welcome screen, accept the terms of the license agreement, and click Next again.
4. Click Next to accept the default installation path, or optionally enter a custom installation path.
5. Click Install and then click Finish complete the installation.

To install a SurePath agent (Linux):

Note, the commands in [square brackets] in the following procedure are variables - you must enter your own input.

1. On the Entuity server, navigate to the directory where you downloaded the rpm or deb installer file (see Step 3), and then upload the file to the server onto which you plan to install the agent software. 
    

2. On the target server, navigate to the directory where you uploaded the installer file in the previous step. 

   cd /[directory path]

    

3. Run the installer. 
   Note, you must run the installer as root or with sudo as a regular user.

   For Red Hat and Oracle Linux:

   rpm --nodeps -i entuitySurePathAgent-[version].x86_64.rpm

    

   For Debian and Ubuntu Linux:

   apt install entuitySurePathAgent-[version]_amd64.deb

    

To manage your SurePath agents:

You manage SurePath agents on the SurePath Agents page. From this page, you can create, edit, and remove SurePath agents, and can view a list of the SurePath agents that you have already created.

To create a SurePath agent:

1. From the Main Menu, click Administration and navigate to the SurePath Administration section of the Entuity Administration page.
2. Click SurePath Agents.
   
   
   
    The SurePath Agents page is displayed.

3. Click Create Agent at the top of the page (or from the Overflow Menu). 

   
    
   The Create Agent form is displayed. 

4. Enter values in the fields of the Create Agent form: 
   
    
   1. Specify an Agent Name.
   2. In the Agent Address field, specify the server on which the agent exists. This can either be a hostname or an IP address. 
      Note, Entuity recommends using a hostname, because this could change less frequently than an IP address.
   3. In the Agent Port field, specify the port that the agent uses (there is no need to change this. The port encrypts all traffic).
   4. In the Zone field, specify the zone to which the agent belongs.
   5. In the Description field, enter a description of the agent.
   6. From Entuity v19.0 P02 upwards, click the Advanced Settings field to open the Advanced form, where you can specify custom username and password credentials for the agent. See the note in this article on restricting access to the SurePath agent.
      
      
   7. If you entered information on the Advanced form, click Done to save your changes and return to the Create Agent form.
5. Click Done on the Create Agent form. Otherwise, click Cancel.
   The newly created agent is now displayed on the SurePath Agents page.

To edit a SurePath agent:

1. Navigate to the SurePath Agents page from the Entuity Administration page.
2. Click Edit Agent at the top of the page (or from the Overflow Menu).
   
   
   The Edit Agent form is displayed.
   
   
3. Edit the values in the fields of the Edit Agent form. 
   The fields are the same as those on the Create Agent form (see Step 4). 
4. Click Done on the Edit Agent form to save your changes. Otherwise, click Cancel.

To delete a SurePath agent

1. Navigate to the SurePath Agents page from the Entuity Administration page.
2. Click Remove Agent at the top of the page (or from the Overflow Menu).
   
3. At the confirmation window that opens, click Yes to confirm the removal. Otherwise, click No.

Note on restricting access to a SurePath agent:

You can restrict access to a SurePath agent by running commands described in the entuityAgent.users file, which can be found in the etc directory. This file has the following default contents:

# This file defines users that may connect to Entuity's traceroute agent.
# It should not be directly edited. Instead run entuityAgent with the "user" command line option.
#
# Examples
#
# To grant access to user named fred from any host using the password letmein
# entuityAgent user add fred 0.0.0.0/0 letmein
# To grant access to user named george from hosts with an IP address starting 10.44 using the password letmein
# entuityAgent user add george 10.44.0.0/16 letmein
# To grant access to user named claire from a host with an IP address of 10.44.2.201 using the password cheese
# entuityAgent user add claire 10.44.2.201/32 cheese
# To grant access to user named stephen from hosts within the domain entuity.local using the password cake
# entuityAgent user add stephen *.entuity.local cake
#
# To delete a user
# entuityAgent user delete george 10.44.0.0/16
#
# Use of IP addresses is prefered over host names as it avoids the need for reverse DNS look ups.
# Where a clients host address matches multiple entries the most selective is used.
# Eg. a host IP of 172.45.23.4 will matched with 172.45.23.0/24 in preference to 172.45.0.0/16 and
# me.my.domain.com will match *.my.domain.com before *.domain.com
# When checking credentials only the first matching entry is used.
#
# Using * as a host is equivalent to 0.0.0.0/0 and localhost is equivalent to 127.0.0.1
#
# As installed the user ENAServer is granted access from anywhere

Note on changing the network configuration on the server:

If you change the network configuration on the server to which the SurePath agent is installed, you will need to stop and restart the SurePath agent.

If the agent has been deployed with the Entuity install:

To stop the agent, you will need to run the following from the bin directory in the Entuity home folder:

stop entuityAgent

To restart the agent, run the following:

start entuityAgent

If the agent is running independently on its own on a different server:

To stop the agent, you will need to run the following from the agent folder:

entuityAgent stop

To restart the agent, run the following:

entuityAgent start