How To Install FreeBSD Agent

This section covers the following topics:

Install the Node Agent
- Verify Checksum for Node Agent Package File
Configure the Node Agent
Restart the Node Agent
Uninstall the Node Agent
Upgrade the Node Agent

Install the Node Agent

Log in to the ER Cloud Web Console.
Go to Settings > Agents > Node Agent Downloads.
On the Node Agent Downloads page, click on the Filename for your Platform.

Save the Node Agent installer on the machine where the Node Agent will be installed.
(Optional) Verify the checksum of the downloaded Node Agent package file.
Open a terminal on the machine where the Node Agent will be installed and run the following commands:
1. If there is a previous version of the Node Agent installed, remove it first:
  
  # Retrieves the name of the installed Node Agent. pkg info|grep er2 # Deletes the installed agent, <package name> pkg delete er2
2. Install the Node Agent:
  
  # Where './er2-2.x.xx-freebsdxx-x.tbz' is the full path of the installation package # Syntax: pkg install <path_to_package.tbz> pkg install ./er2-2.x.xx-freebsdxx-x.tbz
  
  If you are installing the Node Agent on FreeBSD versions that are no longer supported by the provider, run the command pkg install -U <path_to_package.tbz> instead. For more information, refer to FreeBSD - Unsupported FreeBSD Releases.
Restart the Node Agent. A restart is only required when upgrading the Node Agent.

Verify Checksum for Node Agent Package File

You can determine the integrity of the downloaded Node Agent package file by verifying the checksum before installing the Node Agent.

Download the Node Agent package file.
Run the commands in a terminal to generate the hash value for the Node Agent package file.
- MD5 hash (128-bit)
  
  # Syntax: md5 <path to Node Agent package file> md5 ./er2-2.x.xx-freebsdxx-x.tbz
  Example MD5 hash: f65a2cd26570ddb7efb6a2a4318388ac
- SHA1 hash (160-bit)
  
  # Syntax: sha1 <path to Node Agent package file> sha1 ./er2-2.x.xx-freebsdxx-x.tbz
  Example SHA1 hash: 33bcd6678580ae38a03183e94b4038e72b8f18f4
- SHA256 hash (256-bit)
  
  # Syntax: sha256 <path to Node Agent package file> sha256 ./er2-2.x.xx-freebsdxx-x.tbz
  Example SHA256 hash: 1ee094a222f7d9bae9015ab2c4ea37df71000556b3acd2632ee27013844c49da
In the ER Cloud Web Console, go to the Settings > Agents > Node Agent Downloads page. The Hash column lists the expected hash values for each Node Agent package file.
Compare the generated hash values from Step 2 with the expected hash values listed in the Web Console; both hash values should be equal.

If the hash values do not match, check that your network connection is stable, download the Node Agent package again from the Web Console, and verify the checksums again. If the issue still persists, contact Ground Labs Technical Support.

Configure the Node Agent

After you have installed the Node Agent, configure the Node Agent to:

Point to the Master Server.
(Optional) Use the Master Public Key (refer to View Server Information) when connecting to the Master Server.
(Optional) Specify Target initial group.
Test the connection settings.

To configure the Node Agent, choose either mode:

Interactive Mode
Manual Mode

For the changes to take effect, you must Restart the Node Agent.

Interactive Mode

Running this command helps you to quickly configure the Node Agent:

er2-config -interactive

The interactive mode asks you for the following information to help you configure the Node Agent.

Pressing ENTER while configuring the Node Agent with the interactive mode configures the Node Agent to use the last saved value for that parameter. If there is no last saved value, an empty or default value is used. This may cause the Node Agent to fail to locate the Master Server.

Interactive Mode Command Prompts	Description
Master server host name or IP Address [10.1.100.0]	Specify the ER Cloud Master Server's host name (er2-master-server) or IP address (e.g. 10.1.100.100).
(Optional) Master server public key	Enter the Master Public Key. Get the Master Server public key from the Server Information page. Refer to View the Server Information.
(Optional) Target initial group	Specify Target initial group.
Test connection settings (Y/N)	Test the Node Agent\'s connection settings to the Master Server, enter Y.

For the changes to take effect, you must Restart the Node Agent.

Manual Mode

To configure the Node Agent without interactive mode, run:

## Required for connecting to the Master Server # -i <hostname|ip_address>: Master Server IP address or host name (er2-master-server). ## Optional parameters # -t: Tests if the Node Agent can connect to the given host name or IP address. # -k <master_public_key>: Sets the Master Public Key. # -g <target_group>: Sets the default Target Group for scan locations added for this Agent. er2-config -i <hostname|ip_address> [-t] [-k <master_public_key>] [-g <target_group>]

For the changes to take effect, you must Restart the Node Agent.

Restart the Node Agent

For your configuration settings to take effect, you must restart the Node Agent:

## Run either of these options # Option 1 er2-agent -stop # stops the agent er2-agent -start # starts the agent # Option 2 /etc/rc.d/er2_agent restart

Uninstall the Node Agent

To uninstall the Node Agent, run the following commands:

# Retrieve the name of the installed Node Agent pkg info | grep er2 # Delete the installed agent, <package name> pkg delete er2

Upgrade the Node Agent

Refer to Update Node Agents in the Node Agents section.