Company Confidential & Proprietary Page 1
Contents
DEFINITIONS .................................................................................................................................... 3
INSTALLING CYMULATE AGENT – Windows OS .......................................................................... 4
LOGIN TO PLATFORM & DOWNLOAD THE AGENT ........................................................................................................... 4
INSTALLATION ............................................................................................................................................................................. 5
COMMAND-LINE INSTALLATION: ........................................................................................................................................... 5
RUNNING THE AGENT............................................................................................................................................................... 6
INSTALLING CYMULATE AGENT – Mac OS / Linux ...................................................................... 8
LOGIN TO PLATFORM & DOWNLOAD THE AGENT ........................................................................................................... 8
INSTALL DEPENDENCIES ........................................................................................................................................................ 8
INSTALLATION ............................................................................................................................................................................. 9
RUNNING THE AGENT.............................................................................................................................................................10
STOPPING THE AGENT...........................................................................................................................................................10
CHANGING AGENT CONFIGU RATION ................................................................................................................................10
Company Confidential & Proprietary Page 2
DEFINITIONS
CYMULATE AGENT
Cymulate uses a lightweight agent called Cymulate Agent to test
corporate network security and communicate with the Cymulate Cloud.
In this section, unless explicitly stated, the Cymulate Agent is commonly
referred to as “Agent”.
CYMULATE CLOUD
Cymulate assessments are managed over the Cymulate Cloud,
which provides an easy-to- use web user interface and can be
accessed at:
[Link]
Company Confidential & Proprietary Page 3
INSTALLING CYMULATE AGENT – Windows OS
LOGIN TO PLATFORM & DOWNLOAD THE AGENT
The Cymulate agent can be downloaded directly from Cymulate Cloud interface:
1. Open [Link] (Use Google Chrome for best experience)
2. Enter your credentials and click Login
3. Click on Agents appearing on the top right side of the screen and download the relevant
agent.
4. Write down your "Agent linking key", this key will be used to authenticate your agent.
Company Confidential & Proprietary Page 4
INSTALLATION
Follow the setup wizard to complete installation.
Please note: Local Admin privileges are required in order to install the Agent.
*It is recommended to install Cymulate Agent on an instance of the organization’s Windows
golden image.
COMMAND-LINE INSTALLATION:
You can use the command line interface to expedite the installation process by suppressing
some or all of the dialog boxes that appear during a GUI installation. This becomes
particularly useful when installing multiple instances of Cymulate agent.
When entering the command, use the following syntax:
msiexec /i "[Link]" /q KEY=<your linking key>
During installation, the following folders will be created:
- C:\Program Files (x86)\Cymulate\Agent (32-Bit Windows)
- C:\Program Files\Cymulate\Agent (64-Bit Windows)
- C:\ProgramData\Cymulate\ (internal resources folder)
Company Confidential & Proprietary Page 5
RUNNING THE AGENT
To start the agent, click on the Cymulate Agent shortcut created on desktop
*Agent should start automatically after installation is completed.
When starting Cymulate Agent for the first time, you'll be required to enter your Agent Linking
key (This process is required only once.)
Enter your agent linking key that you saved from step 3.
Company Confidential & Proprietary Page 6
Check if Agent is running
When the agent is up, the following processes should be run in the background:
In addition, the Agent icon will appear under system tray icons:
*During installation, a scheduled task, responsible for starting the Agent automatically, will be
created. This task is scheduled to run in case the Agent is not running on the target workstation.
Company Confidential & Proprietary Page 7
INSTALLING CYMULATE AGENT – Mac OS / Linux
LOGIN TO PLATFORM & DOWNLOAD THE AGENT
The Cymulate agent can be downloaded directly from Cymulate App:
1. Open [Link] (Use Google Chrome for best experience)
2. Enter your credentials and click Login
3. Click on Agents appearing on the top right side of the screen and download the relevant
agent based on your OS.
4. Write down your "Agent linking key", this key will be used to authenticate your agent.
INSTALL DEPENDENCIES
You would need to install the following dependencies before running the Cymulate Agent installation
process.
Mac OS:
First, install Homebrew by following instructions on the Homebrew site. Homebrew is a free and open-
source package management system that simplifies the installation of software on macOS .
While installing
Homebrew, you may be prompted to install additional missing dependencies; please follow any such
instructions as well.
As soon as Homebrew is installed, you will be ready to start Cymulate Agent installation process:
1. brew install mono-libgdiplus
2. brew install cups
Linux (Red Hat, CentOS):
1. sudo yum update
2. sudo yum install libgdiplus
3. sudo yum install libicu
4. sudo yum install cups
Linux (Ubuntu, Debian):
1. sudo apt-get update -y
2. sudo apt-get install libgdiplus
3. sudo apt-get install cups
Company Confidential & Proprietary Page 8
INSTALLATION
Follow the steps:
Please note: Root privileges are required in order to install the Agent.
1. Unzip the downloaded "[Link]" file
2. Add execution permissions to the "[Link]" file
3. Execute the [Link] file using sudo
4. During the installation process you would be required to configure the following
information (if applicable):
• Agent linking key - When starting Cymulate Agent for the first time, you will be
required to enter your Agent Linking key (Can be retrieved from Cymulate "Agents"
page).
• HTTP/HTTPS Proxy – If you do not use a proxy server, leave this field empty. If
you use a proxy, make sure the address and port information in this field match
the information in your browser settings.
• Email provider – If you do not use an Email provider server, leave this field empty.
Cymulate currently supports Microsoft Exchange server and Microsoft 365
integration.
5. Check if Agent is running
When the agent is up, the following processes should be run in the background:
During the installation:
1. The following folders will be created:
Linux OS:
- /usr/lib/Cymulate/Agent/
- /usr/share/Cymulate/Agent/
Mac OS:
- /Applications/Cymulate/Agent
- /Users/Shared/Cymulate
Company Confidential & Proprietary Page 9
2. Cron job will be created, responsible for starting the Agent automatically. This
task is scheduled to run in case the Agent is not running on the target workstation.
RUNNING THE AGENT
To start the agent, run the following command "sudo cymulate-run & disown"
*Agent should start automatically after installation is completed.
STOPPING THE AGENT
To stop the agent process, run the following command "sudo cymulate-kill"
CHANGING AGENT CONFIGURATION
To change agent settings, you should first stop Cymulate agent, then run the following commands:
• Changing Agent Linking key:
sudo cymulate-run -set https
• Changing Email provider configuration:
sudo cymulate-run -set smtp
• Changing HTTP/HTTPS proxy configuration:
sudo cymulate-run -set proxy
Company Confidential & Proprietary Page 10