Skip to main content

Endpoint agent

The endpoint agent is a single service that runs on your servers and workstations and reports to the CyberOptix CTEM Platform. It replaces a vulnerability scanning agent and a log forwarder with one install:

  • Inventory: hardware, operating system, installed software, local accounts, running processes and the updates the host is missing.
  • Vulnerabilities: the platform matches the installed packages and missing updates against the vulnerability feed. Nothing is matched on the host, so the agent stays small and the feed is always current.
  • Configuration checks: endpoint policies, built-in baselines you can clone and edit, evaluated on the host with failures raised as compliance findings.
  • Security events: Windows event log channels, the Linux journal and audit log, and the macOS unified log, forwarded to the SIEM with the host's own timestamps.

The agent connects out to the platform only. It needs no inbound port.

Supported systems​

OSArchitecturesPackageService
Windows 10, 11, Server 2016 and laterx64MSICyberOptixAgent
macOS 12 and laterIntel and Apple silicon (one universal package)pkgcom.cyberoptix.agent
Ubuntu, Debian, RHEL, Rocky, Alma, Fedora, Alpinex64 and arm64deb, rpmcyberoptix-agent.service

Every install needs two values from the Deploy page under Security Operations > Agents: the instance URL and your organization id. The Deploy page fills them into the commands below for you.

Windows​

Run as an administrator. The installer registers the service and links the host in one step:

msiexec /i cyberoptix-agent-<version>-windows-amd64.msi API_URL=https://<instance> ORGANIZATION_ID=<id> /qn

Optional properties:

PropertyEffect
PROXY_URL=https://proxy:3128Route platform traffic through a proxy

The installer also installs Microsoft Sysmon with the shipped configuration, which gives the platform process, network, file, registry and DNS telemetry. Sysmon is Microsoft software under the Sysinternals Software License Terms; installing the agent accepts them. A host that already runs Sysmon keeps its installation and receives the shipped configuration. The agent checks on every start and hourly that Sysmon is installed and configured, and reapplies it if not. Removing the agent leaves Sysmon in place.

If the host cannot reach the platform during install, the service links on its first start once it can. An image can be prepared the same way: install with the properties, seal the image, and every clone links itself.

macOS​

Install the universal package, then link:

sudo installer -pkg cyberoptix-agent-<version>-macos-universal.pkg -target /
sudo cyberoptix-agent link --url https://<instance> --organization_id <id>

For MDM deployments, place a pending-link.json in /Library/Application Support/CyberOptix/Agent/ before the first start:

{"url": "https://<instance>", "organization_id": "<id>"}

Linux​

From the package repository​

Debian and Ubuntu use the same repository as the other edge systems. If this host has never had a Purple Team Software package on it, add the repository first, including the rm -f that keeps the step re-runnable:

sudo rm -f /usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg
wget -O - https://apt.fury.io/purpleteamsoftware/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg] https://apt.purpleteamsoftware.com/ /" | sudo tee /etc/apt/sources.list.d/purpleteamsoftware.list
sudo apt update && sudo apt install cyberoptix.agent -y

RHEL, Rocky, Alma and Fedora use the matching yum repository. Create /etc/yum.repos.d/purpleteamsoftware.repo with this content:

[purpleteamsoftware]
name=Purple Team Software
baseurl=https://yum.fury.io/purpleteamsoftware/
enabled=1
gpgcheck=0

Then install:

sudo dnf install cyberoptix.agent -y

Link on either family:

sudo cyberoptix-agent link --url https://<instance> --organization_id <id>

Direct download​

For hosts without repository access, download the deb or rpm from the Deploy page and install it with the distribution's package manager, then run the same link command.

Proxies and private certificate authorities​

link accepts --proxy https://proxy:3128 and --ca-bundle /path/to/ca.pem. Both are stored in the agent's configuration and used for every connection. The agent refuses plain http:// instance URLs.

Checking the agent​

cyberoptix-agent status

Shows the version, whether the host is linked and to which instance, the check-in interval, the policy set in force and how many events are waiting to be sent. The host appears under Security Operations > Agents within one check-in interval.

Upgrading​

Windows and macOS agents update themselves from signed releases. Linux agents upgrade through the package manager (apt upgrade or dnf upgrade), which is what most fleets already run on a schedule.

Uninstalling​

OSCommand
WindowsRemove it from Apps and Features, or msiexec /x <msi> /qn
macOSsudo cyberoptix-agent uninstall, then remove /Library/CyberOptix
Linuxsudo apt remove cyberoptix.agent or sudo dnf remove cyberoptix.agent

Uninstalling leaves the host's record on the platform; delete the agent from the Agents page when the host is retired.

Upgrading from the previous agent​

Installing the new agent over a host that ran the previous agent carries its registration over: the host keeps its identity on the platform and does not need to be linked again. The old service is replaced during the install.

What the agent collects and what it needs​

The service runs as SYSTEM on Windows and as root on macOS and Linux, because the security event logs, the audit log and the local account database are readable only that way. It writes to its own state directory and nowhere else.

Collected on every check-in: load, memory use and running processes. Refreshed hourly: installed software, local accounts (names and group membership, never password material) and network interfaces. On a longer cadence: the updates the operating system reports as missing. Security events stream continuously, spooled on disk when the platform is unreachable and delivered once it is back.