Install and Configure the eyeInspect Content Distributor v1.0.0

 

This page describes how to install and configure the eyeInspect Content Distributor.

Pre-requisites for Installation

Before installing the eyeInspect Content Distributor, make sure the following requirements are met:

  • Minimum computing resources:
    • Processors: 2 CPUs
    • Memory: 4GB RAM
    • Storage: 10GB or more of free disk space for the eyeInspect Content Distributor component and content files
  • Operating system: Ubuntu 22.04 LTS or Ubuntu 20.04 LTS. Note that while the eyeInspect Content Distributor can be installed on eyeInspect v5.2.x (based on Ubuntu 20.04 LTS), it is recommended to upgrade to eyeInspect v5.5.x (based on Ubuntu 22.04 LTS) to ensure the latest functionality. Customers who want to stay on eyeInspect v5.2.x can update their OS to Ubuntu 22.04 LTS through an update package provided by Forescout.
  • Software: Docker 24 or higher
  • Networking rules: Ensure the Command Center's HTTPS port is available. For details on port numbers, refer to Configure Firewall and Proxy Rules for eyeInspect

The eyeInspect Content Distributor can be installed on Ubuntu machines running the following versions, as they already meet the pre-requisites (except for networking rules);

  • eyeInspect Command Center 5.2.x

  • eyeInspect Command Center 5.5.x

  • eyeInspect Enterprise Command Center 5.2.x

  • eyeInspect Enterprise Command Center 5.5.x

Note: eyeInspect Content Distributor can be installed on Ubuntu machines running eyeInspect Command Center/Enterprise Command Center v5.2.0 or higher.

Download the Installer and Script Files

The installer and script files are available in a zip file (eyeinspect_content-distributor-1.0.0.zip), which contains the installer file, the run script and a readme text file.

Download the zip file from the Forescout Support Portal, unzip it on your local machine and move the contents to the target machine.

The zip file contains:

  • eyeinspect_content-distributor-1.0.0.tar.gz - installer file
  • eyeinspect_content-distributor-cli-1.0.0.sh - run script
  • README.txt - contains information about the tool

Install the eyeInspect Content Distributor

Note: Docker is necessary to install the eyeInspect Content Distributor. If Docker is not installed, download the relevant Docker Debian package for your operating system (Ubuntu 20 / Ubuntu 22) and install it by following the instructions here.

To install the eyeInspect Content Distributor:

  1. Load the installer file into the Docker engine by running the following command:
    sudo docker load --input eyeinspect_content-distributor-1.0.0.tar.gz

    Example output:

    $ sudo docker load --input eyeinspect_content-distributor-1.0.0.tar.gz
    d2dc803b7424: Loading layer [==================================================>]  347.6kB/347.6kB
    44c3e6f022fe: Loading layer [==================================================>]  34.01MB/34.01MB
    fc20e9fc76a0: Loading layer [==================================================>]  7.168kB/7.168kB
    Loaded image: content-distributor-cli:1.0.0

  2. Verify that the image has been successfully loaded by running the following command:
    sudo docker images content-distributor-cli:1.0.0

    Example output:

    $ sudo docker images content-distributor-cli:1.0.0
    REPOSITORY                TAG       IMAGE ID       CREATED       SIZE
    content-distributor-cli   1.0.0     8822abc901e4   2 hours ago   441MB

Run the eyeInspect Content Distributor

Note: The user must have write permissions for the base path to run the tool.

To run the eyeInspect Content Distributor:

  1. Grant executable permission to the script by running the following command:
    sudo chmod a+x eyeinspect_content-distributor-cli-1.0.0.sh
  2. Start the eyeInspect Content Distributor by running the following command:
    ./eyeinspect_content-distributor-cli-1.0.0.sh

The eyeInspect Content Distributor command line interface opens.

Add the Command Center(s)

Before using the eyeInspect Content Distributor, you must add one or more Command Centers to which you wish to distribute the content to.

Some key command center configuration commands are listed below, along with example outputs:

  1. Add a Command Center configuration:
    eyeinspect:> cc add <CC_IP_Address> admin
    ? Enter password for admin ********
    Configuration of Command Center with address <CC_IP_Address> is added
  2. List existing Command Center configurations:
    eyeinspect:> cc list
    Command Center address=<CC_IP_Address1>, hostname=<hostname1>, version=5.5.1, username=admin, status=Disconnected
    Command Center address=<CC_IP_Address2>, hostname=<hostname2>, version=5.5.1, username=admin, status=Connected
  3. Remove a Command Center configuration:
    eyeinspect:> cc delete <CC_IP_Address>
    ? Do you confirm that the configuration of Command Center with address <CC_IP_Address> will be deleted? true
    Configuration of Command Center with address <CC_IP_Address> has been deleted.

Note: For more information about configuration commands, go here.

eyeInspect Content Distributor Folders

Running the eyeInspect Content Distributor for the first time creates various folders which are used to hold various files and configurations. These folders and their contents are described below:

Sub-folder Description
export Root folder for exported files
export/engine Folder for backed-up engine .profile files
export/template Folder for distribution task templates
export/cc Folder for the Command Center configuration JSON file (command_centers.json)
content Root folder for content files
content/sd-script Folder for SD Scripts, including:
  • Device Visibility Add-on (DVA) SD Scripts
  • Threat Detection Add-on (TDA) SD Scripts
  • Custom SD Scripts
content/cve-ioc-bundle Folder for CVE (Common Vulnerabilities and Exposures) and IoC (Indicators of Compromise) files
log Folder for application and distribution task logs