Documentation Index

Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt

Use this file to discover all available pages before exploring further.

Linux Installation Guide

Prev Next

This chapter provides instructions for installing, configuring, verifying, upgrading, and uninstalling the Nectar Endpoint Client (EPC) on Linux systems.

Overview

The Nectar Endpoint Client can operate as either a standard Endpoint or a Hub, depending on the license assigned by a Nectar administrator. In most Linux deployments, the EPC is licensed and deployed as a Hub.

A Hub hosts virtual endpoints and executes active tests used to measure network, voice, video, collaboration, and digital experience performance. The number of virtual endpoints that can be hosted by a Hub is determined by the assigned license capacity.

For supported operating systems, hardware sizing requirements, and network requirements, refer to the Linux Hub Requirements document.

Prerequisites

For Linux systems, the Nectar EPC installation software is provided as an RPM package.

Prior to installation:

  • Verify that the target operating system is supported/platform meets the required hardware specifications.

  • Verify that the system can reach the Controller.

For complete platform, hardware, and firewall requirements, refer to the Linux Hub Requirements and Ports and Protocols documentation.

Example:

nslookup neccontroller.us.nectar.services

or

ping neccontroller.us.nectar.services

Important

These instructions do not reference the exact RPM filename (for example, nectarepc-3.1.156-1.el9.x86_64.rpm). Instead, wildcards (for example, *.rpm) are used so that the commands remain valid for future EPC versions.

Installing the Nectar EPC

Download the latest EPC  package and transfer it to the target Linux system using your preferred method.

Common transfer methods include:

  • SCP

  • SFTP

  • WinSCP

  • MobaXterm

  • USB storage

  • Internal package repositories

The following example outlines a USB transfer.

Insert and Mount the USB

Identify the USB device:

lsblk

Create a mount directory:

sudo mkdir -p /mnt/usb

Mount the USB device:

sudo mount /dev/sdb1 /mnt/usb

Create a working directory for the EPC:

mkdir -p ~/epc

Copy the EPC installation package:

cp /mnt/usb/*.rpm ~/epc/

Navigate to the EPC directory:

cd ~/epc

Convert RPM to DEB (Ubuntu/Debian Only)

If the target system is Ubuntu or Debian, convert the RPM package using the Alien utility:

sudo alien -d *.rpm

Install the EPC

RHEL / Rocky Linux / AlmaLinux / Oracle Linux

sudo dnf install ./*.rpm

Ubuntu / Debian

sudo apt install ./*.deb

The EPC service starts automatically after package installation. This behavior is intended to simplify upgrades.

For a new deployment, stop the service temporarily so that the initial configuration can be completed before registration with the Controller.

sudo nectarepc stop

Configure the EPC

Launch the configuration utility:

sudo nectarepc config
    1. Select 1 (Full Config)

    2. Enter a detailed display name

      1. Valid characters for the agent's name include the following a-z A-Z 0-9 $ * + ? ^ ! . = @ _ ~ - : Spaces are not allowed

    3. [Optional] Enter a description

    4. Enter the Organization ID and Group ID provided to you

    5. Set the logging level to INFO

    6. Enter the management domain and password provided to you

    7. Enter the controller address: neccontroller.us.nectar.services:443

    8. Set Outbound Controller is Fixed to True

    9. Select Quit to save the configuration

Complete the requested configuration values provided by your Nectar administrator.

After configuration is complete, start the EPC service:

sudo nectarepc start

Registration Verification

Verify that the EPC service is running:

sudo nectarepc status

A successful deployment should show the service in a Running state.

After startup, verify the following:

  • The EPC appears in DXP.

  • The EPC is assigned to the correct Organization and Group.

  • The appropriate license has been assigned.

  • The EPC successfully establishes connectivity to the Controller.

Upgrading the EPC

When upgrading an existing Linux EPC installation, install the new package directly over the existing installation.

RPM-Based Systems

rpm -Uvh nectarepc<version>.rpm

The upgrade process preserves the existing EPC configuration.

After the upgrade completes, verify that the EPC service is running:

sudo nectarepc status

If necessary, restart the service:

sudo systemctl restart nectarepc

DEB-Based Systems

For Ubuntu and Debian systems, convert the RPM package using Alien and install the updated DEB package using the standard installation procedure.

After upgrading, verify that the EPC reconnects to the Controller and appears correctly in DXP.

Linux Service Management

This section will outline managing the Linux EPC

Commands

The following commands can be used to manage the EPC service.

Start the service:

sudo nectarepc start

Stop the service:

sudo nectarepc stop

Check service status:

sudo nectarepc status

Using systemd:

sudo systemctl start nectarepc
sudo systemctl stop nectarepc
sudo systemctl restart nectarepc
sudo systemctl status nectarepc

Viewing EPC Logs

EPC log files are stored in:

/var/log/nectarepc/

To view a log file:

cat /var/log/nectarepc/nectarepc_20260609.log

Additional log files may be present depending on EPC version and logging configuration.

Uninstalling the EPC

Navigate to the EPC directory:

cd ~/epc

Stop the EPC:

sudo nectarepc stop

Remove the EPC using the command corresponding to the operating system.

Ubuntu / Debian

sudo apt remove nectarepc

RHEL / Rocky Linux / AlmaLinux / Oracle Linux

sudo dnf -y remove nectarepc

or

sudo rpm -e nectarepc

Troubleshooting

EPC Service Is Not Running

Verify the service status:

sudo nectarepc status

or

sudo systemctl status nectarepc

Review the EPC logs for startup errors.

EPC Cannot Connect to the Controller

Verify DNS resolution:

nslookup neccontroller.us.nectar.services

Verify network connectivity:

ping neccontroller.us.nectar.services

Confirm that outbound TCP 443 access to the Controller is permitted by the firewall.

Refer to the Ports and Protocols Guide for complete connectivity requirements.

EPC Appears Offline in DXP

Verify:

  • Organization ID and Group ID configuration.

  • Management domain credentials.

  • Controller address configuration.

  • Firewall access to required ports.

Restart the service after making configuration changes:

sudo systemctl restart nectarepc

Tests Fail to Execute

If the EPC registers successfully but cannot execute tests:

  • Verify that all required ports are open.

  • Verify that firewall policies allow required UDP traffic.

  • Verify that test interfaces have valid network connectivity.

  • Verify that static IP addressing is used for interfaces that will run tests.

Refer to the Linux Hub Requirements and Ports and Protocols documentation for detailed network requirements.

For additional questions or concerns, contact support@nectarcorp.com.