Install the agent one-at-a-time with Product Key

Product Key-based installation is a newer way to install the XShield agents on the assets. In this installation mode, you use the Product Key (for the instance) to install the agents. Another (traditional) way to install agents is the Installer Key-based installation, by using the instance FQDN, instance name, and the Installer Key for the instance.

With the Product Key-based approach, the downloaded installer file name contains the Product Key for the instance. The installer automatically fetches the key from the file name at the time of the installation. During the installation, if the Product Key cannot be derived from the file name (if the file is changed after the download), you will be prompted to enter the Product Key.

Product Key-based installation mode is an easier and quicker way to install agents (on both workloads and user assets). This mode is supported for Xshield agent versions 8.7.x.x and newer.

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 Fully Qualified Domain Name (FQDN) and the Product Key for the instance.

The Product Key is listed in the Installation Details > Installation Options tab.

Support for Asset Onboarding modes

Instances that use Product Key-based installation can use the different Asset Onboarding modes in Xshield to control how and when assets are registered to the instance. Asset Onboarding modes enable staggered discovery of assets (by manual approval or using a reference list of assets).

Prerequisites

  • Meet the prerequisites to install the Xshield agent on assets.

  • 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 Product Key of the instance handy in case the installer cannot fetch it automatically from the file name.

From the UI

  1. (Optional) Copy the downloaded agent installer package to the asset.

  2. Double-click the installer.

    Agents are listed by the flavors of OSes - Windows, macOS, Ubuntu, RedHat, CentOS, SUSE, and AIX.

  3. Accept the End User License Agreement.

  4. (Optional) Enter the Product key.

  5. 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 using Web proxy support for workloads or tag assets during the installation.

  1. Go to Settings > Agent Download.

  2. Select the agent type ( Microsegementation or User Access) for the relevant OS family.

  3. Click View CLI for the OS family and copy the required installation command.

  4. Use the Copy icon to copy the command.

  5. 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 (based on the Onboarding mode for the instance), the asset shows up as Reachable on the Assets page (State column).

Failed installation

Agent installations can fail if the prerequisites are not met. See installation issues for more details.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.