CYFOX OmniSec, the latest AI-driven CISO by CYFOX, delivers advanced insights based on various data sources within an organization. To integrate with these data sources, OmniSec offers two connection methods:
API-Based Integration
OmniSec connects to external data sources via connectors, including EDR and XDR systems, Active Directory, workspaces, CNAPP tools, and more.
Agent-Based Integration
Users can install the OmniSec Agent (also known as the OmniSec Adapter) on endpoints (e.g., laptops) to securely transmit data to the OmniSec platform.
Prerequisites
To install the OmniSec Agent (Adapter), you will need your organization's license and activation keys, which will be provided during installation.
If you are unsure about your license or activation key, please get in touch with [email protected].
The license and activation key are unique to each organization. You will use the same keys whether deploying OmniSec on a single endpoint or thousands of devices.
As of March 2025, only Windows OS is supported. The complete list of supported systems is available here.
Set-Up
To proceed with the OmniSec installation, you will need two installation packages:
CYFOX's Installation File
CYFOX MSI script
To obtain these packages, please contact the CYFOX Support Team. Once you have both files, follow these steps to complete the installation.
Open Command Prompt
Press Win + R, type cmd, and press Enter to open Command Prompt.
Navigate to the Installation Directory
Use the
cdcommand to navigate to the installation script's directory. For example:cd C:\Path\to\directory
Run the Installation Script with Required Arguments
Execute the script using the following format
Each argument must follow the
key=valueformat<path to installationScript.exe> msiPath="C:\Path\to\Your.msi" serverAddress="" activationKey="" license="" password=YourPassword123 agentMode=1 machineType=2 product="Omnisec"
Please note that the
serverAddressargument is configured to accept an IP address, not a domain.If your Omnisec agent operates on-prem, you will need to enter your on-prem server's IP address.
If your Omnisec agent communicates directly with the cloud, you must set it to the IP address of
cyfox.cloud.com(which can be retrieved via a ping command).
If you encounter any issues obtaining the cloud IP address, please contact our support team for assistance.
Execute the Script
The script will validate the provided arguments. If all conditions are met, the installation will proceed. If any condition is incorrect, an error message will display the reason for failure.
Please remember to replace all placeholder values (e.g., "C: PathtoYour.msi") with actual paths and parameters specific to your setup.
Post-Installation Guidelines
Once the agent is installed, it will appear in the System Tray, near the clock.
Clicking on the agent icon provides a status update on your OmniSec Agent operation, including:
Service Status (Running/Pending)
Last Sync
OmniSec Version
You can adjust configuration settings in the top-right corner by clicking the Settings (⚙) icon.
Uninstallation
Method 1: Using the Uninstallation Script
Open Command Prompt with Administrator privileges on the machine where you want to uninstall the agent.
Run one of the following commands:
If the agent was installed with a password:
<Path to Uninstallation Script> <password>
If no password was set:
<Path to Uninstallation Script>
Method 2: Using MSI Uninstallation
You can also uninstall the agent using the msiexec command:
msiexec /x "<PRODUCT_CODE>" /qn Password="<PASSWORD>"
Finding the Product Code
The Product Code can be found in the Windows Registry:
Open Registry Editor (
Win + R, type regedit, and press Enter).Navigate to:
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Cyfox Agent\ProductCode
3. Copy the Product Code (including the curly brackets {}) for use in the command.
Example: Uninstalling an Agent Without a Password
msiexec /x {DE05DA50-988A-4655-8427-81555F57D4AE}