How to install ColorTokens Agents
  • 22 Jun 2022
  • Dark

How to install ColorTokens Agents

  • Dark

Agent Download page

Xshield agents are available for download from the Settings > Agent Download page. Agents are listed by the flavors of Xshield-supported OSes - Windows, macOS, Ubuntu, RedHat, CentOS, SUSE, and AIX. This page also lists the CLI commands to install the agents. The CLI commands are specific for your instance - they contain the FQDN, instance name, and the Installer Key for the instance.

The FQDN, instance name, and installer key are listed in the Installation Details > Installation Options tab.


Meet the prerequisites to install the Xshield agent on assets.
OS family
Supported versions
CentOS6.7, 6.8, 6.9, 6.10, 7.2, 7.3, 7.6
macOS10.10, 10.11, 10.12, 10.13, 10.14, 10.15
RHEL6.7, 6.8, 7.1, 7.2, 7.3, 7.4
SUSE12, 12 SP2, 12 SP3, 12 SP4
Ubuntu12.04, 14.04, 16.04, 18.04
Windows 32-bitXP SP3, 7, 2003 SP2, 2003 R2, 2008 SP1, 2008 SP2, 2008 R2
Windows 64-bit2003 SP2, 2003 R2, 2008 SP1, 2008 SP2, 2008 R2, 2012, 2012 R2, 2016, 2019 Standard, 2019 Datacenter, Windows 7 Embedded Standard, 10 Pro, 10 Home, 11

  • For Windows assets that use third-party Security solutions such as Symantec Endpoint Protection or Bitdefender Total Security, you must tune the Security configuration to install the agents and protect the assets with Xshield policies.
  • Download the packages of the agents(s) you want to install.
  • For UI-based installation, keep the FQDN, instance name, and the Installer Key of the instance handy.

From the UI

  • (Optional) Copy the downloaded agent installer package to the asset.
  • Double-click the installer .
  • Agents are listed by the flavors of OSes - Windows, macOS, Ubuntu, RedHat, CentOS, SUSE, and AIX.
  • Accept the End User License Agreement.
  • In the Server Name or Address text box, enter the FQDN.
  • In the Tenant Name field, enter the instance name.
  • In the Installer Key field, enter the Installer Key.
  • Complete the installation.

From the CLI

Agents can be installed using different tools (Windows PowerShell and cmd for Windows) and different methods (CLI or interactive installation for Linux OSes). Also, commands are listed for when you want to use Web proxy support for workloads or tag assets during the installation.

  • Go to Settings > Agent Download.
  • Select the agent type ( Microsegementation or User Access) for the relevant OS family.
  • Click View CLI for the OS family and copy the required installation command.
  • Use the Copy icon to copy the command.
  • Paste and run the command on the asset.

Successful installation

Upon successful installation, the agent log file on the asset ( mtoken.log) logs the installation successful message. Also, upon successful registration, the asset shows up as Reachable on the Assets page (State column).

Failed installation

Agent installations can fail if the prerequisites are not met.

Was this article helpful?