Contents
- Managing Kaspersky Endpoint Agent for Windows
- Installing and uninstalling Kaspersky Endpoint Agent
- Preparing for Kaspersky Endpoint Agent installation
- Installing Kaspersky Endpoint Agent
- Installing and uninstalling Kaspersky Endpoint Agent locally
- Installing Kaspersky Endpoint Agent using Kaspersky Security Center
- Installing Kaspersky Endpoint Agent administration tools
- Updating Kaspersky Endpoint Agent from the previous version
- Repairing Kaspersky Endpoint Agent
- Changes in the system after Kaspersky Endpoint Agent installation
- Kaspersky Endpoint Agent activation
- Managing Kaspersky Endpoint Agent using Kaspersky Security Center Administration Console
- Managing Kaspersky Endpoint Agent policies
- Configuring Kaspersky Endpoint Agent settings
- Opening Kaspersky Endpoint Agent settings window
- Configuring Kaspersky Endpoint Agent security settings
- Configuring Kaspersky Endpoint Agent connection settings to a proxy server
- Configuring Kaspersky Security Center as a proxy server for Kaspersky Endpoint Agent activation
- Configuring KSN usage in Kaspersky Endpoint Agent
- Configuring integration between Kaspersky Endpoint Agent and KATA Central Node
- Configuring EDR telemetry settings
- Configuring storage settings in Kaspersky Endpoint Agent
- Configuring integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response
- Configuring failure diagnosis
- Managing Kaspersky Endpoint Agent tasks
- Creating a local task
- Creating a group task
- Viewing the table of tasks
- Deleting a task from the list
- Starting tasks manually
- Starting tasks by schedule
- Viewing task execution results
- Configuring the storage time for the task execution results on the Administration Server
- Creating Kaspersky Endpoint Agent activation task
- Managing Kaspersky Endpoint Agent database and module update tasks
- Managing IOC Scan tasks in Kaspersky Endpoint Agent
- Managing Kaspersky Endpoint Agent using Kaspersky Security Center Web Console
- Managing Kaspersky Endpoint Agent policies
- Configuring Kaspersky Endpoint Agent settings
- Opening Kaspersky Endpoint Agent settings window
- Configuring Kaspersky Endpoint Agent security settings
- Configuring Kaspersky Endpoint Agent connection settings to a proxy server
- Configuring Kaspersky Security Center as a proxy server for Kaspersky Endpoint Agent activation
- Configuring Kaspersky Endpoint Agent policy type
- Configuring KSN usage in Kaspersky Endpoint Agent
- Configuring integration between Kaspersky Endpoint Agent and KATA Central Node
- Configuring EDR telemetry settings
- Configuring integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response
- Configuring storage settings in Kaspersky Endpoint Agent
- Configuring failure diagnosis
- Managing Kaspersky Endpoint Agent tasks
- Creating tasks
- Viewing the table of tasks
- Deleting a task from the list
- Configuring task schedule settings
- Starting tasks manually
- Creating Kaspersky Endpoint Agent activation tasks
- Configuring Database and application module update task
- Managing Standard IOC Scan tasks
- Configuring the Quarantine file task
- Configuring the Delete file task
- Configuring the Run process task
- Configuring the Terminate process task
- Managing Kaspersky Endpoint Agent using the command line interface
- Managing Kaspersky Endpoint Agent activation
- Managing Kaspersky Endpoint Agent authentication
- Configuring tracing
- Configuring creating a dump of Kaspersky Endpoint Agent processes
- Viewing information about quarantine settings and quarantined objects
- Actions on quarantined objects
- Managing integration settings with KATA Central Node component
- Running Kaspersky Endpoint Agent database and module update
- Starting, stopping and viewing the current application status
- Protecting the application with password
- Protecting application services with PPL technology
- Managing self-defense settings
- Managing event filtering
- Managing Standard IOC Scan tasks
- Managing scanning of files and processes according to YARA rules
- Managing scanning of autorun point objects according to YARA rules
- Creating a memory dump
- Creating a disk dump
- Installing and uninstalling Kaspersky Endpoint Agent
Managing Kaspersky Endpoint Agent for Windows
Kaspersky Endpoint Agent is an application that is installed on individual devices within an organization's IT infrastructure. The application constantly monitors the processes running on these devices, as well as open network connections and files modifications. Kaspersky Endpoint Agent interacts with other Kaspersky solutions to detect comprehensive threats (such as targeted attacks).
The application interacts with Kaspersky Anti Targeted Attack Platform using the KATA Central Node component. When integration of Kaspersky Endpoint Agent with KATA Central Node is configured, the application executes the tasks and applies the settings received from the KATA Central Node component, and sends telemetry data from the protected device to the server with the KATA Central Node component.
Installing and uninstalling Kaspersky Endpoint Agent
This section contains information on how to install Kaspersky Endpoint Agent on a device, how to update the application from a previous version, and how to remove the application from a device.
Preparing for Kaspersky Endpoint Agent installation
Before installing Kaspersky Endpoint Agent on a device or updating the application from a previous version, make sure that the following conditions are met:
- The device complies with the hardware and software requirements.
- You have the permissions required to install the application.
If any of these conditions is not met, the corresponding notification will be displayed.
Installing Kaspersky Endpoint Agent
Kaspersky Endpoint Agent installation can be performed:
- Locally using the Installation Wizard.
- Locally using the command line.
- Remotely using Kaspersky Security Center.
- Remotely using Microsoft Windows Group Policy Management Editor (for details, visit the Microsoft Technical Support website).
For remote installation, the settings can be passed using the
configuration file. Before you do so, first place the install_props.json file in the same folder as the endpointagent.msi file.
Installing and uninstalling Kaspersky Endpoint Agent locally
This section contains information on how to install Kaspersky Endpoint Agent locally on a device.
Installing Kaspersky Endpoint Agent using the Installation Wizard
The interface of the Installation Wizard application consists of a sequence of windows corresponding to the application installation steps.
To install the application or update it from a previous version using the application Installation Wizard,
copy the endpointagent.msi file that is included in the distribution kit to the user device and run it.
The application Installation Wizard starts.
After Kaspersky Endpoint Agent is installed on the device, the Installation Wizard can be launched on this device in one of the following modes:
- Restore damaged application modules.
- Uninstall the application from the device.
Removing Kaspersky Endpoint Agent using the Installation and Uninstallation Wizard
You can uninstall Kaspersky Endpoint Agent using standard Microsoft Windows installation and uninstallation tools. To uninstall the application, the wizard is launched. As a result of its operation, all application components will be removed from the device.
All data that is stored locally on the device, except for trace and dump files, is deleted from the device when the application is uninstalled.
Installing, restoring and uninstalling the application using the command line
Kaspersky Endpoint Agent can be installed and uninstalled using the msi package by setting the values of MSI properties in a standard way. For more information on using standard Windows Installer commands and keys, refer to the documentation provided by Microsoft.
Installing Kaspersky Endpoint Agent
An example of installing the application in quiet mode with default settings is shown below. After starting the application installation in quiet mode, your participation in the installation process is not required.
Installing Kaspersky Endpoint Agent in quiet mode requires acceptance of the terms and conditions of the End User License Agreement and Privacy Policy. Use the EULA=1
and PRIVACYPOLICY=1
parameters only if you have fully read, understood, and accept the terms of the End User License Agreement and Privacy Policy.
Example:
|
Command parameters for installing Kaspersky Endpoint Agent
Parameter |
Description |
---|---|
|
Required parameter. This parameter indicates whether the user consents to or declines the terms of the End User License Agreement. Values:
|
|
Required parameter. This parameter indicates whether the user consents or declines the terms of the Privacy Policy. Values:
|
|
This parameter sets the flag for using the hardware identifier in the form of the value of the Values:
|
Repairing Kaspersky Endpoint Agent
An example of restoring the application in quiet mode is shown below. After starting application restoration in quiet mode, your participation in the restoration process is not required.
Example:
|
Uninstalling Kaspersky Endpoint Agent
An example of uninstalling the application in quiet mode is shown below. After starting application uninstallation in quiet mode, your participation in the uninstallation process is not required.
Example:
If the application is password protected:
|
All data that is stored locally on the device, except for trace and dump files, is deleted from the device when the application is uninstalled.
Installing Kaspersky Endpoint Agent using Kaspersky Security Center
Kaspersky Endpoint Agent can be installed using a remote installation task in Kaspersky Security Center. Installation consists of the following steps:
Kaspersky Security Center also supports other methods of installing applications on groups of managed devices. For more information about installation using a remote installation task and other installation methods, refer to the Kaspersky Security Center Help.
When creating an installation package using Kaspersky Security Center 12 and later in order to install Kaspersky Endpoint Agent on devices running Windows XP, use the installation startup file (setup.exe) from the installation package created using Kaspersky Security Center 10.5.
Creating Kaspersky Endpoint Agent installation package
An installation package is a set of files generated for the remote installation of a Kaspersky application using Kaspersky Security Center. The installation package contains the required settings to install the application and ensure its operation immediately after installation. The installation package is created on the basis of the file with the KUD extension included in the application distribution package.
Creating an installation package in the Administration Console.
Creating an installation package in the Web Console and in the Cloud Console.
When creating an installation package using Kaspersky Security Center 12 and later in order to install Kaspersky Endpoint Agent on devices running Windows XP, use the installation startup file (setup.exe) from the installation package created using Kaspersky Security Center 10.5.
Page topCreating Kaspersky Endpoint Agent remote installation task
The Remote application installation task is intended for the remote installation of Kaspersky Endpoint Agent using Kaspersky Security Center. To install the application, the task uses the application installation package.
Creating a remote installation task in the Administration Console.
Creating a remote installation task in the Web Console and in the Cloud Console.
Page topInstalling Kaspersky Endpoint Agent administration tools
This section contains information on how to install Kaspersky Endpoint Agent Management plug-in for managing Kaspersky Endpoint Agent using Kaspersky Security Center Administration Console or Kaspersky Endpoint Agent Management web plug-in for managing Kaspersky Endpoint Agent using Kaspersky Security Center Web Console.
Installing and updating Kaspersky Endpoint Agent Management plug-in
The Kaspersky Endpoint Agent Management plug-in must be installed in order to manage Kaspersky Endpoint Agent using the Kaspersky Security Center Administration Console.
To install the Kaspersky Endpoint Agent Management plug-in,
copy the klcfginst.msi file from the distribution kit to the device on which Kaspersky Security Center Administration Console is installed and run the file.
The application Installation Wizard starts.
Updating a previously installed version of the Kaspersky Endpoint Agent Management plug-in
This update is only available for the Kaspersky Endpoint Agent Management plug-in versions 3.7 and later.
When installing a plug-in on a device with a previous plug-in version:
- All the setting values, including policies, group and local tasks, are migrated to the new plug-in version, and the previously installed plug-in version is automatically removed.
- The Kaspersky Endpoint Agent settings that were not available in the previous plug-in version are set to default values and can be configured.
To apply previously unavailable settings, after updating the plug-in, change the desired policy or task and save your changes.
- Policy templates created in the previous plug-in version are available in the new plug-in version.
You can use the new plug-in to manage previous Kaspersky Endpoint Agent versions. However, previous versions of Kaspersky Endpoint Agent do not support and do not apply the settings that have appeared in the new plug-in version.
Page topInstalling and updating Kaspersky Endpoint Agent Management web plug-in
Kaspersky Endpoint Agent Management web plug-in must be installed to manage Kaspersky Endpoint Agent using Kaspersky Security Center Web Console.
You can install the web plug-in in one of the following ways:
- Using the Initial Setup Wizard of the Kaspersky Security Center Web Console.
- From the list of available distribution packages in the Kaspersky Security Center Web Console.
For detailed information on installing management web plug-ins, refer to the Kaspersky Security Center Help.
- By downloading the distribution package to the Kaspersky Security Center Web Console from a third-party source.
To install the web plug-in, add a ZIP archive with the distribution package of the Kaspersky Endpoint Agent web plug-in to the Web Console interface (Console settings → Web plug-ins). You can download the web plug-in distribution kit, for example, from Kaspersky's website.
Updating a previously installed version of the Kaspersky Endpoint Agent Management web plug-in
When installing a plug-in on a device with a previous plug-in version:
- All the setting values, including policies, group and local tasks, are migrated to the new plug-in version, and the previously installed plug-in version is automatically removed.
- The Kaspersky Endpoint Agent settings that were not available in the previous plug-in version are set to default values and can be configured.
To apply previously unavailable settings, after updating the plug-in, change the desired policy or task and save your changes.
- Policy templates created in the previous plug-in version are available in the new plug-in version.
You can use the new plug-in to manage previous Kaspersky Endpoint Agent versions. However, previous versions of Kaspersky Endpoint Agent do not support and do not apply the settings that have appeared in the new plug-in version.
Page topUpdating Kaspersky Endpoint Agent from the previous version
Only Kaspersky Endpoint Agent version 3.8 and later can be updated. The update is possible for application versions installed both as part of the
application and independently. The update can be performed by installing the new version.When you update Kaspersky Endpoint Agent, the current license is automatically applied to Kaspersky Endpoint Agent. The license term will remain unchanged. When updating the application with an expired license, the new application version works in limited functionality mode after installation.
If the license for the updated version has expired, you can add the license key during the update. The key file can be passed using one of the specified methods.
When Kaspersky Endpoint Agent is installed on a device with a previous version of Kaspersky Endpoint Agent, first all
is saved and used, then the previous version of the application is automatically uninstalled.If Kaspersky Endpoint Agent is installed on a device with a previous version of Kaspersky Endpoint Agent, you will need to create an account to connect to Kaspersky Security Center and migrate data from the previous version. The account uses the default name: AutoIOC_Admin and a password specified by the user.
When updating a previous version of Kaspersky Endpoint Agent that is password protected, you must pass this password to the installer in one of the following ways:
- When installing the application locally using the installation wizard interface or interactively using the command line, specify the password at the appropriate step.
- When installing the application locally using the command line in quiet mode, specify the password as the value of the
UNLOCK_PASSWORD
key. - When installing the application remotely using Kaspersky Security Center, pass the current password in the installation package settings.
When updating Kaspersky Endpoint Agent as part of EPP, you can pass the password as the value of the UNLOCK_PASSWORD
key in the install_props.json configuration file.
The application password passed through the install_props.json configuration file is stored in the file in non-encrypted form. To reduce the probability of unauthorized access to this data, it is recommended to restrict access to the install_props.json file and delete it from the device after installing or updating the application.
Starting from version 3.10,
(also referred to as KMP) usage cannot be configured by means of Kaspersky Endpoint Agent. If usage of the KMP service was enabled in the previous Kaspersky Endpoint Agent version, the KMP service continues functioning after the application is updated to version 3.10 and later. After the application update, you can disable the KMP service only using Kaspersky Endpoint Agent Administration Plug-in or Kaspersky Endpoint Agent Web Plug-in of versions earlier then 3.10.When installing a plug-in on a device with a previous plug-in version:
- All the setting values, including policies, group and local tasks, are migrated to the new plug-in version, and the previously installed plug-in version is automatically removed.
- The Kaspersky Endpoint Agent settings that were not available in the previous plug-in version are set to default values and can be configured.
To apply previously unavailable settings, after updating the plug-in, change the desired policy or task and save your changes.
- Policy templates created in the previous plug-in version are available in the new plug-in version.
You can use the new plug-in to manage previous Kaspersky Endpoint Agent versions. However, previous versions of Kaspersky Endpoint Agent do not support and do not apply the settings that have appeared in the new plug-in version.
Repairing Kaspersky Endpoint Agent
If you launch Kaspersky Endpoint Agent installer in Repair mode, it will check and restore the integrity of all damaged application modules and system registry keys created during the application's installation.
You can run the installer in Repair mode in one of the following ways:
- Locally using Kaspersky Endpoint Agent Installation Wizard.
- Locally using the command line.
- Remotely using Kaspersky Security Center by performing one of the following actions (for details, refer to Kaspersky Security Center Help):
- By selecting the Repair application if it is already installed check box when creating the installation package.
- By specifying the
REINSTALL=ALL
parameter when creating a custom installation package.
If Kaspersky Endpoint Agent installer is launched in Repair mode and the application does not need to be repaired, the installer will not perform any changes on the device.
If Kaspersky Endpoint Agent installer is launched in Repair mode and the application is not installed on the device, the application installation will start.
If Kaspersky Endpoint Agent installer is launched in Repair mode locally using the command line or remotely using Kaspersky Security Center, and the settings of the installed application differ from the settings specified in the installer, the installer will be launched in the mode for changing the settings of the installed application.
Page topChanges in the system after Kaspersky Endpoint Agent installation
The Windows Installer service performs the following changes on the protected device during the installation of Kaspersky Endpoint Agent:
- Creates Kaspersky Endpoint Agent folders.
- Registers Kaspersky Endpoint Agent keys in the system registry.
- Registers Kaspersky Endpoint Agent services and drivers.
Kaspersky Endpoint Agent folders on the protected device
When Kaspersky Endpoint Agent is installed, the following folders are created on the device:
- The default Kaspersky Endpoint Agent installation folder that contains Kaspersky Endpoint Agent executable files:
- On a 32-bit version of Microsoft Windows: %ProgramFiles%\Kaspersky Lab\Endpoint Agent\
- On a 64-bit version of Microsoft Windows: %ProgramFiles (x86)%\Kaspersky Lab\Endpoint Agent\
- Folder containing Kaspersky Endpoint Agent (x86) drivers:
- On a 32-bit version of Microsoft Windows: %ProgramFiles%\Kaspersky Lab\Endpoint Agent\drivers\<OS version>\<driver name>
- On a 64-bit version of Microsoft Windows: %ProgramFiles (x86)%\Kaspersky Lab\Endpoint Agent\drivers\x64\<OS version>\<driver name>
- Folders containing IOC files:
- In 32-bit version of Microsoft Windows:
- %ProgramFiles%\Kaspersky Lab\Endpoint Agent\openioc
- %ProgramFiles%\Kaspersky Lab\Endpoint Agent\openioc\1.0
- %ProgramFiles%\Kaspersky Lab\Endpoint Agent\openioc\1.1
- In 64-bit version of Microsoft Windows:
- %ProgramFiles (x86)%\Kaspersky Lab\Endpoint Agent\openioc
- %ProgramFiles (x86)%\Kaspersky Lab\Endpoint Agent\openioc\1.0
- %ProgramFiles (x86)%\Kaspersky Lab\Endpoint Agent\openioc\1.1
- In 32-bit version of Microsoft Windows:
- Folders containing Kaspersky Endpoint Agent system files:
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Cache
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Cache\Images
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Cache\Queue
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Cache\Queue\Kata
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Cache\Queue\Kmp
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Cache\Queue\Syslog
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\Hunts
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Data\killchain
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Settings
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Tasks
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\DSKM
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Temp
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Temp\Tasks
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Bases
- Folder containing system files for Kaspersky Security Network's operation.
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Ksn
- Folder containing quarantined files:
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Quarantine
- Folder containing files restored from quarantine:
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Restored
- Folder containing Kaspersky Security Center policy configuration files:
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Policy
- Folders containing system files for Kaspersky Sandbox's operation:
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Sandbox
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Sandbox\Queue
- Folder containing files of updatable components:
- %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0\Update
- Folder containing shortcut files for the Start menu:
- %ALLUSERSPROFILE%\Microsoft\Windows\Start Menu\Programs\Kaspersky Endpoint Agent
Kaspersky Endpoint Agent services and drivers
The following Kaspersky Endpoint Agent services are registered and started under the system account (SYSTEM):
- SOYUZ.exe is the main Kaspersky Endpoint Agent service that manages its tasks and operation processes.
- VOSTOK.dll (executed in proton.exe) is a service that facilitates the interaction between Kaspersky Endpoint Agent and the Central Node component.
- ANGARA.dll (executed in proton.exe) is a service that facilitates the interaction between Kaspersky Endpoint Agent and EPP in scenarios of Kaspersky Sandbox integration.
The following Kaspersky Endpoint Agent drivers are registered on the device:
- klsnsr.sys is Event Tracing for Windows (ETW) driver.
- klncap.sys is ETW network packet analyzer.
When installed on a device running Microsoft Windows XP, the klncapxp.sys driver is registered instead of klncap.sys.
System registry keys
As a result of Kaspersky Endpoint Agent's installation, the following registry keys are created:
Registry keys are listed in the 32-bit application view.
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\Connectors\SOYUZ\4.0.0.0\ProdDisplayName]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\Connectors\SOYUZ\4.0.0.0\ProdVersion]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\Connectors\SOYUZ\4.0.0.0\ConnectorVersion]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\Connectors\SOYUZ\4.0.0.0\ConnectorFlags]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\Connectors\SOYUZ\4.0.0.0\NagentMinVer]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\Connectors\SOYUZ\4.0.0.0\ConnectorPath]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\SOYUZ\4.0.0.0\Installer\UninstallString3]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\SOYUZ\4.0.0.0\Installer\UninstallString3KPD]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\Components\34\SOYUZ\4.0.0.0\Installer\ProductCode]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\NoPPL]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\BFESDDL]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\CrashDump\Enable]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\CrashDump\Folder]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\CrashDump\Enable(Example)]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\CrashDump\Folder(Example)]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Environment\EnableKillChain]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Environment\SvmUpdateMode]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Environment\MsiPath]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Environment\AgentPath]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Environment\EventsExpirationTimeout]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Install\InstallID]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Install\InstallTime]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Install\InstallLCID]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Install\InstallLocalization]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Install\InstallPlatformType]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Install\Version]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Trace\Configuration]
- [HKEY_LOCAL_MACHINE\SOFTWARE\KasperskyLab\SOYUZ\4.0\Trace\Configuration(Example)]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\StartMenu]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\UninstallShortcut2]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\RelNotes]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\License]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\Ksn]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\Kmp]
- [HKEY_CURRENT_USER\Software\KasperskyLab\SOYUZ\ProductUrl]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\angara]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\klelaml]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\klncap]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\klncapxp]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\klsnsr]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\vostok]
- [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\soyuz]
Kaspersky Endpoint Agent activation
This section contains information about Kaspersky Endpoint Agent activation.
Managing Kaspersky Endpoint Agent activation
You can activate Kaspersky Endpoint Agent in one of the following ways:
- During installation:
- By specifying the key file at a certain step of the Installation Wizard.
- By placing the key file in the same folder as the endpointagent.msi file before starting the installation in quiet mode (including remote installation).
- By specifying the path to the key file using the
LICENSEKEYPATH
parameter when installing the application in quiet mode (including remote installation).If there are several key files in the folder, Kaspersky Endpoint Agent will be activated using the key file with the latest license expiration date.
If Kaspersky Endpoint Agent installer does not detect a key file suitable to activate Kaspersky Endpoint Agent, the application will be installed without being activated.
When you update Kaspersky Endpoint Agent, the current license is automatically applied to Kaspersky Endpoint Agent. The license term will remain unchanged. When updating the application with an expired license, the new application version works in limited functionality mode after installation.
If the license for the updated version has expired, you can add the license key during the update. The key file can be passed using one of the specified methods.
- After installation:
- Using the Application activation task in Kaspersky Security Center Administration Console or in Kaspersky Security Center Web Console.
- Using the command line locally on the device.
You can use Kaspersky Security Center as a proxy server to activate Kaspersky Endpoint Agent.
You can view information about the current Kaspersky Security Center license in the Kaspersky licenses section, in the device properties, or using the command line.
For detailed information on managing keys using Kaspersky Security Center, refer to Kaspersky Security Center Help.
After the license expires, the application will continue to work but with limited functionality.
Functional limitations after the license expiration
When the license expires, the following limitations will arise in the operation of Kaspersky Endpoint Agent functional components:
- Telemetry data is not collected.
- Network isolation cannot be enabled.
If network isolation was enabled when the license expired, the application will disable network isolation in accordance with the specified settings for automatic disabling of network isolation.
- Execution prevention cannot be enabled.
If Execution prevention was enabled when the license expired, the application will stop blocking objects that fall under the specified Execution prevention rules.
- The following tasks stop and cannot be started: Run process, Terminate process, Delete file.
- The Standard IOC Scan tasks will stop and cannot be started.
- KSN/KPSN usage terminates.
When you try to use the listed application functional components after the license expires, the application will create the critical LicenseViolation
event in the Windows event log and in the Kaspersky Security Center Administration Server log. When working using the command line, the application will return the code 8
(AccessDenied
).
Viewing information about the current license
You can view information about the current license in Kaspersky Security Center in the Kaspersky licenses section or in the device properties in the Keys section. For detailed information on managing keys using Kaspersky Security Center, refer to Kaspersky Security Center Help.
To view information about an active license in the Kaspersky Security Center Administration Console:
- In the Managed devices folder of the Administration Console tree, select the folder with the name of the administration group, which includes the required device.
- In the workspace, select the Devices tab.
- Select the device for which you want to configure Kaspersky Endpoint Agent settings.
- Select Properties in the device context menu.
The device properties window opens.
- Select the Applications section.
A list of Kaspersky applications installed on the device is displayed in the window.
- Select Kaspersky Endpoint Agent and open its properties window in one of the following ways:
- Double-click the application name.
- In the application context menu, select Properties.
- Click the Properties button under the list of Kaspersky applications.
- Select the Keys section.
Information about the current license will be displayed in the window.
To view information about an active license in the Kaspersky Security Center Web Console:
- On the Devices tab, select Managed devices.
- Click the name of the device you want.
- In the device properties window that opens, select the Applications tab.
- In the list of applications, select Kaspersky Endpoint Agent.
- In the application properties window that opens, select the General tab and open the License section.
The general information about active and backup license keys will be displayed.
Managing Kaspersky Endpoint Agent using Kaspersky Security Center Administration Console
Kaspersky Security Center provides a centralized solution for the main tasks of managing and maintaining an organization's network protection system. The application provides the administrator with access to detailed information about the security level of the organization's network and allows the administrator to configure all the components of protection built based on Kaspersky applications.
Kaspersky Security Center enables the remote installation, uninstallation, starting and stopping of Kaspersky Endpoint Agent, as well as configuration of the application settings, as well as the starting and stopping of application tasks. Kaspersky Security Center offers differentiation of access permissions to Kaspersky Endpoint Agent using the Role Based Access Control (RBAC) technology.
For detailed information on Kaspersky Security Center, refer to Kaspersky Security Center Help.
Kaspersky Security Center Administration Console (hereinafter also referred to as Administration Console) provides the user interface for working with Kaspersky Security Center. Administration Console is implemented as an extension component to the Microsoft Management Console (MMC).
Kaspersky Endpoint Agent can be managed in Kaspersky Security Center Administration Console using the Kaspersky Endpoint Agent Management plug-in.
This section contains the basic information about managing Kaspersky Endpoint Agent using Kaspersky Security Center Administration Console.
Managing Kaspersky Endpoint Agent policies
This section describes how to create Kaspersky Endpoint Agent policies and enable policy settings.
Creating Kaspersky Endpoint Agent policy
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To create a Kaspersky Endpoint Agent policy in Kaspersky Security Center:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Click Create a policy.
The policy creation wizard starts.
- In the Selecting an application for creating a group policy window, select Kaspersky Endpoint Agent.
- Click Next.
- In the Enter group policy name window, perform the following actions:
- Enter the name that will be used for the new policy in the policy list.
- If you want to import the settings of an existing Kaspersky Endpoint Agent policy to a new policy:
- Select the Use the policy settings for previous application version check box.
- Click Select and in the window that opens, select the policy whose settings you want to import.
- Click ОК.
- Click Next.
- In the New policy window, select one of the following options:
- Create a new policy and configure its settings.
- Create a new policy with default settings.
If you enabled the Use the policy settings for previous application version setting at the previous step, the Create a new policy and configure its settings option is selected by default, and the settings specified in the imported policy are displayed during the policy creation. In this case, the switch in the upper right corner of each section with the policy settings, which shows if the policy is applied, depends on the position of the switches
. - Click Next.
- In the Select policy type window, select the required Kaspersky Endpoint Agent deployment method:
- Integration with Kaspersky Sandbox
- Endpoint Detection and Response Expert (KATA EDR), Kaspersky Industrial CyberSecurity for Networks
- Click Next.
- If you select the Create a new policy and configure its settings option, perform one of the following actions in all sequentially displayed settings windows:
- To configure the application settings in the displayed sections during policy creation:
- Click Configure next to the name of the required section.
- In the window that opens, configure the required settings and click OK.
- Click Next.
- To configure the application settings in the displayed section later, click Next.
Configuration of the application settings consists of the following steps:
The composition of the steps depends on the type of policy selected during the previous step and may differ from the one described.
- Configuring integration between Kaspersky Endpoint Agent and Kaspersky Sandbox.
- Configuring integration of Kaspersky Endpoint Agent with Endpoint Detection and Response Expert (KATA EDR) and Kaspersky Industrial CyberSecurity for Networks (KICKS for Networks) components.
- Configuring threat response settings.
- Configuring application repositories.
- Configuring application security settings.
- Configuring general application settings.
- To configure the application settings in the displayed sections during policy creation:
- In the Target group window, select the Kaspersky Security Center administration group to which the created policy will be applied by performing the following steps:
- Click Browse.
The administration group selection window will open.
- Select the administration group from the list.
For example, you can select the Managed devices group.
- If you want to create a subgroup in the Managed devices group:
- Click New group.
- In the window that opens, enter the name of the device subgroup.
- Click OK.
- Click Next.
- Click Browse.
- In the Creating a group policy for the application window, select one of the following policy statuses:
- Active policy to activate the policy as soon as it is created.
- Inactive policy to activate the policy later.
- Out-of-office. The policy becomes active when the computer leaves the corporate network.
- Select the Open policy properties after creation check box if you want to perform additional configuration of the policy immediately after creating it.
- Click Finish.
The created policy will now appear in the policy list.
Enabling settings in Kaspersky Endpoint Agent policy
When you configure Kaspersky Endpoint Agent policy settings, by default these settings are saved, but are not applied until you enable them. The settings in the policy sections are divided into groups. You can enable either individual groups or all groups within one policy.
To enable the group of settings in Kaspersky Endpoint Agent policy:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- Select the policy for which you want to enable the settings.
- In the window that opens, select the section and group of settings to which the required setting belongs.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
All the settings of the group will be applied in the policy after the changes are saved.
Configuring Kaspersky Endpoint Agent settings
This section describes how to configure Kaspersky Endpoint Agent settings.
Opening Kaspersky Endpoint Agent settings window
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To open the Kaspersky Endpoint Agent settings window:
- Open Kaspersky Security Center Administration Console.
- Expand the Managed devices node in the Kaspersky Security Center Administration Console tree.
- Select the administration group for which you want to configure application settings.
- Perform one of the following actions in the details pane of the selected administration group:
- To configure the application settings for a group of devices, select the Policies tab and open the Properties: <Policy name> window by double-clicking the policy name or by selecting Properties in the context menu.
- To configure the application settings for a single device, select the Devices tab and perform the following actions:
- Open the Properties: <Device name> window by double-clicking the device name or by selecting Properties in the context menu.
- Select the Applications section.
- Open the Application settings window by double-clicking the application name or by clicking the Properties button under the list of applications.
If an active Kaspersky Security Center policy is applied to a device and blocks changes to the application settings, these settings cannot be edited in the Application settings window, except for the network isolation settings.
The settings of automatic network isolation can be configured in the policy properties, and the settings of network isolation on demand (manually enabled settings) can be configured in the properties of an individual device.
Configuring Kaspersky Endpoint Agent security settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To ensure maximum security of the IT infrastructure in your organization, you can configure access of users and third-party processes to Kaspersky Endpoint Agent.
Configuring user permissions
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can grant access to Kaspersky Endpoint Agent to individual users or groups of users. As a result, only specified users will be able to manage settings or services of the application.
To configure user permissions:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Application settings section select the Security settings subsection.
- In the User permissions group of settings, click the Configure button next to the name of the required setting.
The permissions window for Kaspersky Endpoint Agent group will open.
- In the upper block of settings for groups or users, select the group or user to which you want to grant permissions.
- In the lower block of permission settings for groups or users, select the check boxes for the items with the desired permissions.
- Click OK.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- In the policy properties window, click OK.
The user permissions for managing the application settings and services have now been configured and applied.
Enabling Password protection
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Unrestricted user access to the application and its settings can reduce the security level of the device. Password protection is a means to limit user access to the application.
To enable password protection:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Application settings section select the Security settings subsection.
- In the Password protection group of settings select the Apply password protection check box.
- Enter a password and confirm it.
It is recommended to select a password that satisfies the following requirements:
- It is at least 8 characters long.
- It does not contain the user account name.
- It does not match the name of the device on which Kaspersky Endpoint Agent is installed.
- It contains characters from at least three of the following groups:
- uppercase characters (A-Z);
- lowercase characters (a-z);
- numbers (0-9);
- special characters (!$#%).
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
Password protection is now enabled. If a user attempts to perform a password protected action, the application will prompt the user to enter the password.
The application does not check the strength of the specified password. We recommend that you use third-party tools to verify the strength of the password. The password is considered strong enough if verification results confirm that the password cannot be guessed for at least 6 months.
The application does not prohibit login attempts after many attempts of entering an incorrect password.
Enabling and disabling Self-Defense
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The Self-Defense mechanism of Kaspersky Endpoint Agent provides protection from malware that tries to lock or delete the application. The Self-Defense mechanism prevents the alteration or deletion of application files on the hard drive, memory processes, and entries in the system registry.
To enable or disable Self-Defense:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Application settings section select the Security settings subsection.
- In the Self-defense group of settings, enable or disable the Enable self-defense for application modules in memory setting.
The setting is enabled by default.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
The Self-Defense mechanism is now enabled or disabled.
Configuring Kaspersky Endpoint Agent connection settings to a proxy server
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Proxy server connection settings are used for updating databases, activating the application, and external services.
If you want to use a specified proxy server when connecting to KATA server, Kaspersky Sandbox server or Kaspersky Industrial CyberSecurity for Networks server, make sure that the Connect using the proxy server if specified in the general settings option is selected when configuring integration with KATA, Kaspersky Industrial CyberSecurity for Networks or Kaspersky Sandbox. This option is not selected by default.
To configure proxy server connection settings:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Application settings section select the General settings subsection.
- Select one of the following proxy service usage options:
- Do not use proxy server.
- Automatically detect proxy server address.
- Use proxy server with specified settings.
- If you select the Automatically detect proxy server address option, the proxy server for further telemetry transmission will be detected automatically.
- If you select the Use proxy server with specified settings option, specify the address and port of the proxy server you want to connect to in the Server name or IP address and Port fields.
The default port number is 8080.
- If you want to use NTLM authentication (NT LAN Manager Network Authentication Protocol) to connect to the proxy server:
- Select the Use NTLM authentication by user name and password check box.
- In the User name field, enter the name of the user, whose account will be used for proxy server authentication.
- In the Password field, enter the password for connecting to the proxy server.
You can make password characters visible by clicking Show to the right of the Password field.
- If you do not want to use the proxy server for internal addresses of your organization, select the Bypass proxy server for local addresses check box.
- Click the Apply button.
As a result, you will return to the policy properties window.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
Proxy server connection settings are now configured.
Configuring Kaspersky Security Center as a proxy server for Kaspersky Endpoint Agent activation
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To enable usage of Kaspersky Security Center as a proxy server for the application activation:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Application settings section select the General settings subsection.
- In the Licensing group of settings, select the Use Kaspersky Security Center as a proxy server when activating the application check box.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click ОК.
Kaspersky Security Center usage as a proxy server for Kaspersky Endpoint Agent activation is now enabled.
Page topConfiguring KSN usage in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To protect your computer more effectively, Kaspersky Endpoint Security uses data received from users around the globe. Kaspersky Security Network is designed to receive this data.
Kaspersky Security Network (KSN) is an infrastructure of cloud services that provide access to the online Kaspersky Knowledge Base that contains information about the reputations of files, web resources, and software. The use of data from Kaspersky Security Network ensures faster responses by the EPP application to objects that are not yet listed in anti-virus application databases, improves performance of some protection components, and reduces the likelihood of false positives.
Participation in Kaspersky Security Network allows Kaspersky to quickly acquire information about the types and sources of objects that are not yet listed in anti-virus application databases, develop methods for neutralizing such objects, and reduce the number of false positives.
When you use Kaspersky Security Network, certain statistical data collected while Kaspersky Endpoint Agent is running is automatically sent to Kaspersky. Files, or parts of files, that may be exploited by intruders to harm the computer or data can be also sent to Kaspersky to be further examined.
No personal data is collected, processed, or stored. The types of data that Kaspersky Endpoint Agent sends to Kaspersky Security Network are described in the KSN Statement.
Participation in Kaspersky Security Network is voluntary. KSN usage is disabled by default. After enabling KSN usage, you can disable this option at any time.
Starting from version 3.10, Kaspersky Managed Protection (also referred to as KMP) usage cannot be configured by means of Kaspersky Endpoint Agent. If usage of the KMP service was enabled in the previous Kaspersky Endpoint Agent version, the KMP service continues functioning after the application is updated to version 3.10 and later. After the application update, you can disable the KMP service only using Kaspersky Endpoint Agent Administration Plug-in or Kaspersky Endpoint Agent Web Plug-in of versions earlier then 3.10.
To enable KSN usage:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- Select the Kaspersky Security Network section.
- Review the KSN Statement.
- If you agree with terms and conditions of the Statement, select the I confirm that I have fully read, understood, and accept the terms and conditions of this Kaspersky Security Network Statement check box.
- Select the Enable Kaspersky Security Network usage check box.
- If you want to use Kaspersky Security Center for telemetry transmission, select the check box.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
KSN usage is enabled.
Configuring integration between Kaspersky Endpoint Agent and KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section contains information on how to configure integration between Kaspersky Endpoint Agent and the KATA Central Node component using the Kaspersky Security Center Administration Console.
Configuring data submission settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure data submission settings:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Telemetry collection servers section, select the General settings subsection.
- In the Data submission settings group, do the following:
- Specify the value in the Events transmission period (sec.) field.
The default value is 30 seconds.
- Specify the value in the Maximum number of events in a package field.
The default value is 1024 events in a package.
- Specify the value in the Events transmission period (sec.) field.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
Configuring request throttling settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The request throttling feature allows restricting the flow of events with low importance from Kaspersky Endpoint Agent to the Central Node component. Event importance is evaluated by the application.
To configure the request throttling settings:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Telemetry collection servers section, select the General settings subsection.
- In the Request throttling group of settings, you can perform the following actions:
- Enable or disable the Enable request throttling setting.
The setting is enabled by default.
- Specify the number of events in the Maximum number of events per hour field.
The application analyzes telemetry data flow and restricts transmission of events with low importance if the number of transmitted events tends to exceed the value specified in this field. The default value is 3000 events per hour.
- Specify the threshold for the flow of events of the same type with low importance in the Percentage of event limit excess field.
If the flow of events of the same type with low importance exceeds the threshold value specified in this field as a percentage of the total number of events, transmission of events of this type is restricted. You can specify a value from 5% to 100%. The default value is 15%.
- Enable or disable the Enable request throttling setting.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
The default switch position is Under policy.
- Click OK.
Enabling and disabling integration with KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
If you use Nginx as a proxy server between a device with Kaspersky Endpoint Agent installed and KATA server, configure the client_max_body_size
setting. The value of the client_max_body_size
setting must be equal to the maximum size of the object sent by Kaspersky Endpoint Agent to KATA for processing. Otherwise, Nginx will not send objects whose size exceeds the specified value. The default value is 1 MB.
To enable or disable integration with the KATA Central Node component:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Telemetry collection servers section, select the Integration with KATA subsection.
- In the Connection settings group, do one of the following:
- To enable integration with KATA Central Node:
- Select the Enable KATA integration check box.
- In the List of KATA servers settings group, for one or more KATA servers, specify the IP address or full domain name of the KATA server, as well as the port for connecting to the server.
Kaspersky Endpoint Agent connects to the first server in the list. If the connection does not succeed, Kaspersky Endpoint Agent connects to the second server and so on down the list.
- To disable integration with KATA Central Node, clear the Enable KATA integration check box.
- To enable integration with KATA Central Node:
- In the Connection settings group, enable or disable the Connect using the proxy server if specified in the general settings option.
This option is disabled by default. The application connects to the KATA server only directly and does not use the general proxy server connection settings. You can enable this option if you want the application to use the general proxy server connection settings when connecting to the KATA server.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
Integration with KATA Central Node is enabled or disabled.
Configuring trusted connection with KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure trusted connection between Kaspersky Endpoint Agent and KATA Central Node, perform the following actions on Kaspersky Endpoint Agent side:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Telemetry collection servers section, select the Integration with KATA subsection.
- In the Connection settings group, select the Use pinned certificate to protect connection check box.
- Click the Add new TLS certificate button.
The Adding new TLS certificate window opens.
- Perform one of the following actions to add a TLS certificate:
- Add a certificate file. Click Browse, and in the window that opens, select the certificate file and click Open.
- Copy and paste the contents of the certificate file to the Paste TLS certificate data field.
Kaspersky Endpoint Agent may have only one KATA server TLS certificate. If you have added a TLS certificate before and then add a TLS certificate once again, only the last added certificate is valid.
- Click the Add button.
Information about the added TLS certificate is shown in the TLS certificate data group of settings.
- If you want to configure additional connection protection by a user certificate, click the Add client certificate button.
- In the Add client certificate window that opens, do the following:
- Select the Secure connection with the client certificate check box.
- Click the Upload button and in the window that opens select the PFX archive and click Open.
- Enter the password for the PFX archive.
- Click OK.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
The trusted connection to KATA server is now configured.
Configuring synchronization settings between Kaspersky Endpoint Agent and KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure synchronization settings between Kaspersky Endpoint Agent and KATA Central Node:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Telemetry collection servers section, select the Integration with KATA subsection.
- In the Connection settings group, configure the following settings:
- Timeout (sec.). Specify the maximum KATA server response timeout. The default value is 10 seconds.
- Send synchronization request to KATA server every (min.). Specify the time interval for sending requests for synchronization Kaspersky Endpoint Agent settings and tasks with KATA Central Node. You can specify a value from 1 to 60 minutes. The default value is 5 minutes.
- Select or clear the Use TTL period when sending events check box. The check box is cleared by default.
If the check box is selected, Kaspersky Endpoint Agent does not send information about the processes that are started again to the KATA server. Kaspersky Endpoint Agent does not consider the launch of the process as repeated if the process is started after the end of the TTL period.
- If you select the Use TTL period when sending events check box, specify the time in the TTL period (min.) field. The default value is 1440 minutes.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click OK.
Configuring EDR telemetry settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section contains information on how to configure:
- for EDR about application processes, which Kaspersky Endpoint Agent processes and sends to a server with the KATA Central Node or Kaspersky Industrial CyberSecurity for Networks component.
- Optimization of the volume of EDR telemetry that Kaspersky Endpoint Agent processes and sends to a server with the Kaspersky Industrial CyberSecurity for Networks component.
- Exclusions for EDR telemetry about network communications, which Kaspersky Endpoint Agent processes and sends to a server with the Kaspersky Industrial CyberSecurity for Networks component.
Enabling and configuring exclusions for and optimization of sent EDR telemetry about application processes
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can configure exclusions for and optimization of the volume of EDR telemetry about application processes using Kaspersky Security Center Administration Console, in the properties of an individual device or in the policy settings for a group of devices.
Exclusions for EDR telemetry about application processes are available when Kaspersky Endpoint Agent is integrated with servers where KATA Central Node or Kaspersky Industrial CyberSecurity for Networks is installed.
Kaspersky Endpoint Agent does not analyze or send data on excluded application processes to the server with KATA Central Node or Kaspersky Industrial CyberSecurity for Networks installed.
Optimization of the volume of EDR telemetry about application processes can be managed (enabled / disabled) when Kaspersky Endpoint Agent is integrated with servers where Kaspersky Industrial CyberSecurity for Networks is installed.
If optimization of the volume of EDR telemtry is enabled, Kaspersky Endpoint Agent does not send events with 102 (basic communications) and 8 (network activity of a process) codes for the Microsoft SMB protocol and the Network Agent process klnagent.exe regarding processes of applications on a server where Kaspersky Industrial CyberSecurity for Networks is installed.
To enable and configure exclusions for and optimization of the volume of EDR telemetry on application processes:
- Do one of the following:
- Select the EDR telemetry → Excluded processes section.
- In the Exclusions settings group, enable the Use exclusions setting to enable use of EDR telemetry exclusions.
- Configure optimization of the volume of EDR telemetry:
When Kaspersky Endpoint Agent is integrated with servers where KATA Central Node is installed, optimization of the volume of EDR telemetry should always be enabled.
- Disable the Optimize the amount of telemetry setting if you want Kaspersky Endpoint Agent to send events with codes 102 (basic communications) and 8 (the process's network activity) for the Microsoft SMB protocol, WinRM service, and the Network Agent process klnagent.exe.
- Enable the Optimize the amount of telemetry setting if you want Kaspersky Endpoint Agent to not send events with codes 102 (basic communications) and 8 (the process’s network activity) for the Microsoft SMB protocol and the Network Agent process klnagent.exe.
If the Use exclusions setting is disabled, Kaspersky Endpoint Agent does not send events with codes 102 (basic communications) and 8 (the process's network activity) for the Microsoft SMB protocol and the Network Agent process klnagent.exe, regardless of the value of the Optimize the amount of telemetry setting.
- Create a list of exclusions:
- Click the Add button.
- In the Rule properties window that opens, configure the exclusion settings:
- Click OK to save the changes and close the Rule properties window.
The new exclusion is created and displayed in the list of exclusions.
- If you need to export the exclusion list to an XML file, click the Export button.
- If you need to import the exclusion list from an XML file, click the Import button.
- If you need to modify an exclusion, click the Modify button.
- If you need to delete an exclusion from the list, select the exclusion and click the Delete button.
- If you are configuring the policy settings, make sure that the switch in the upper right corner of the group of settings is turned on. It is the default position of the switch.
- Click OK to save the changes.
Enabling and configuring exclusions for sent EDR telemetry about network communications
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can configure exclusions for EDR telemetry using Kaspersky Security Center Administration Console, in the properties of an individual device or in the policy settings for a group of devices.
Exclusions for EDR telemetry about network communications are applied when Kaspersky Endpoint Agent is integrated with servers where Kaspersky Industrial CyberSecurity for Networks is installed.
Kaspersky Endpoint Agent does not analyze or send data matching exclusion settings to the server with KATA Central Node or Kaspersky Industrial CyberSecurity for Networks installed.
To enable and configure EDR telemetry about network communications:
- Do one of the following:
- Select the EDR telemetry → Excluded network communications section.
- In the Exclusions settings group, enable the Use exclusions setting to enable use of EDR telemetry exclusions.
- Create a list of exclusions:
- Click the Add button.
- In the Rule properties window that opens, configure the exclusion settings.
- If you need to modify an exclusion, click the Modify button.
- If you need to delete an exclusion, select the exclusion and click the Delete button.
- If you are configuring the policy settings, make sure that the switch in the upper right corner of the group of settings is turned on. It is the default position of the switch.
- Click OK to save the changes.
Configuring storage settings in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section describes how to configure the quarantine settings and data synchronization settings with the Administration Server by means of Kaspersky Endpoint Agent Management plug-in.
About Kaspersky Endpoint Agent quarantine
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Quarantine is a special local repository on the device. The user can put files considered dangerous to the computer into quarantine. Quarantined files are stored in an encrypted form and therefore do not compromise your device's security.
By default, the local quarantine is located in the %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\<application version>\Quarantine
folder. By default, the objects restored from quarantine are stored in the %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\<application version>\Restored
folder.
Kaspersky Security Center generates a common list of quarantined objects on devices with Kaspersky Endpoint Agent installed. Network Agents on the devices submit information about quarantined files to the Administration Server.
Kaspersky Security Center Network Agent does not copy files from quarantine to the Administration Server. All objects are stored on protected devices with Kaspersky Endpoint Agent installed. Objects are restored from the quarantine also on the protected devices.
About quarantine management in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can use Kaspersky Security Center to configure quarantine settings, view the properties of the quarantined objects on the protected devices, delete quarantined objects, and restore objects from Quarantine. For detailed information on managing the quarantined objects using Kaspersky Security Center, refer to Kaspersky Security Center documentation.
In order for Kaspersky Endpoint Agent to send data about quarantined objects to Kaspersky Security Center Administration Server, the corresponding option must be enabled in the quarantine settings in Kaspersky Endpoint Agent policy. This option is enabled by default.
Using the command line interface on the device, you can view information about quarantine settings and properties of the quarantined objects.
Kaspersky Endpoint Agent quarantines object under the system account (SYSTEM).
Quarantined objects can be removed using the command line interface only with the permissions of the local account of the protected device user.
Configuring quarantine settings and restoration of objects from quarantine
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure quarantine settings:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Repositories section select the Quarantine subsection.
- In the Quarantine settings section configure the quarantine settings:
- In the Quarantine folder field, enter the path to where you want to create the Quarantine folder on the devices or click Browse and select the path.
The default path is
%SOYUZAPPDATA%\Quarantine\
. The Quarantine folder is created on all devices with Kaspersky Endpoint Agent at the following path:%ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0
.The value of the
%ALLUSERSPROFILE%
variable depends on the operating system of the device where Kaspersky Endpoint Agent is installed. For example, if Kaspersky Endpoint Agent is installed on drive C, the path to the Quarantine folder will be C:\ProgramData\Kaspersky Lab\Endpoint Agent\4.0\Quarantine. - To configure the maximum quarantine size, select the Maximum Quarantine size (MB) check box and type the maximum size of quarantine in MB or select it from the list.
For example, you can set the maximum quarantine size to 200 MB.
When the maximum quarantine size is reached, Kaspersky Endpoint Agent will publish the corresponding event on Kaspersky Security Center server and in the Windows Event Log, but will not stop quarantining new objects.
- To specify the quarantine threshold (the space in quarantine remaining until the maximum quarantine size is reached), select the Threshold value for space available (MB) check box.
For example, you can set the quarantine threshold value to 50 MB.
When the quarantine threshold is reached, Kaspersky Endpoint Agent will publish the corresponding event on Kaspersky Security Center server and in the Windows Event Log, but will not stop quarantining new objects.
- In the Quarantine folder field, enter the path to where you want to create the Quarantine folder on the devices or click Browse and select the path.
- In the Restoring objects from Quarantine section, in the Target folder for restored objects field, specify the path to create the folder for objects restored from quarantine.
The default path is
%SOYUZAPPDATA%\Restored\
. The Restored folder is created on all devices with Kaspersky Endpoint Agent at the following path:%ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0
.The value of the
%ALLUSERSPROFILE%
variable depends on the operating system of the device where Kaspersky Endpoint Agent is installed. For example, if Kaspersky Endpoint Agent is installed on drive C, the path to the folder with the objects restored from quarantine will be C:\ProgramData\Kaspersky Lab\Endpoint Agent\4.0\Restored. - In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click the Apply button and then click OK.
The quarantine settings and the folder for restoring objects from quarantine have been configured.
Configuring data synchronization with the Administration Server
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can configure synchronization of data on quarantined objects on managed devices with Kaspersky Security Center Administration Server. Data synchronization is required to manage quarantine using Kaspersky Security Center.
To configure data synchronization with the Administration Server:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- In the Repositories section select the Synchronization with Administration Server subsection.
- In the Settings section in the Send the following data to the Administration Server subsection, select the Data about objects, quarantined on managed devices check box.
- In the upper right corner of the settings group, change the switch from Unaffected by policy to Under policy.
- Click the Apply button and then click OK.
Data synchronization with the Administration Server is configured.
Configuring integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Before performing the following steps, get the MDR configuration file. It contains a configuration file (BLOB) required for integration.
If you want Kaspersky Endpoint Agent to process data about events generated by Kaspersky Industrial CyberSecurity for Networks and send this data to Kaspersky Managed Detection and Response, configure interaction with Kaspersky Security Center in the settings of Kaspersky Industrial CyberSecurity for Networks. For detailed information on configuring interaction between the applications, refer to the Kaspersky Industrial CyberSecurity for Networks Help.
Integration with Kaspersky Managed Detection and Response is only available for Kaspersky Endpoint Agent Management plug-in versions 3.9.2 and later.
In order to configure integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response using the Kaspersky Security Center Administration Console:
- Open Kaspersky Security Center Administration Console.
- In the console tree, open the Policies folder.
- Select Kaspersky Endpoint Agent policy and open its properties window in one of the following ways:
- Double-click the policy name.
- Select Properties in the policy context menu.
- Select the Configure policy settings item in the right part of the window.
- Select the Managed Detection and Response section.
- In the Managed Detection and Response settings group, do the following:
- Select the Enable Managed Detection and Response check box.
- Click the Upload configuration file (BLOB) button and select the BLOB configuration file to load.
By downloading the Managed Detection and Response configuration file, you agree to automatically send the specified data from the device with Kaspersky Endpoint Agent installed to Kaspersky for processing. Do not download the configuration file if you do not want the specified information to be processed.
- In the User identifier field, enter an arbitrary value.
- In the policy properties window, click OK.
Integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response is configured.
MDR operation when using Kaspersky Endpoint Agent simultaneously with Kaspersky Endpoint Security
Kaspersky Endpoint Security 11 or later with the current database version supports interaction with MDR. In Kaspersky Endpoint Security 11.6.0 or later, interaction with MDR is available immediately after installation.
If you use Kaspersky Endpoint Agent to work with MDR and install Kaspersky Endpoint Security of the version that supports interaction with MDR or update Kaspersky Endpoint Security 11 or later databases to the current version, MDR stops working with Kaspersky Endpoint Agent and becomes available for work with Kaspersky Endpoint Security. At that:
- Switching between Kaspersky Endpoint Agent and Kaspersky Endpoint Security is performed in quiet mode.
- Kaspersky Endpoint Agent allows for configuring settings for interaction with MDR, but these settings are not applied on the device.
- If Kaspersky Endpoint Security is not available (for example, you uninstalled the application), MDR can start working with Kaspersky Endpoint Agent if you restart the Kaspersky Endpoint Agent service.
- The Managed Detection and Response component remains in the Running status in Kaspersky Endpoint Agent settings on the device, since Kaspersky Endpoint Agent continues to communicate with MDR (for example, to resume working with the solution if necessary).
Configuring failure diagnosis
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Kaspersky Endpoint Agent does not automatically create a folder for storing trace or dump files on the device. Specify a folder that is already available on the device.
To configure failure diagnosis:
- Open the application properties window for an individual device.
- In the Application settings section select the Failure diagnosis subsection.
- To enable logging of debug information to the trace files:
- Enable the Write debug information to trace files option.
- In the Trace files folder field, specify the path to the folder on the device where the application saves the trace files.
Make sure that the specified folder is available on the managed device. Otherwise, the debug information will not be saved.
- In the Maximum trace file size (MB) field, specify the file size in megabytes.
The default value is 50 MB. When the specified file size is reached, the application continues writing to a new file.
- If you want the application to overwrite old trace files:
- Enable the Overwrite old trace files option.
- Enter the desired value in the Maximum number of files per trace log field.
The default value is 1 file. When the specified number of files is reached, the application overwrites old files, starting with the oldest one. The specified limit is applied separately for each Kaspersky Endpoint Agent process being debugged, so the total number of files for all processes may exceed the specified value.
- To enable logging of dump files:
- Enable the Create dump files option.
- In the Dump files folder field, specify the folder to save the dump files.
Make sure that the specified folder is available on the managed device. Otherwise, the debug information will not be saved.
- Click OK.
Failure diagnostics is configured and enabled for all Kaspersky Endpoint Agent processes that are currently running. Failure diagnostics files will be generated in the folders you specified.
Managing Kaspersky Endpoint Agent tasks
This section describes how to manage Kaspersky Endpoint Agent tasks.
Creating a local task
Local tasks are run on a specific device. For more information on tasks, refer to Kaspersky Security Center documentation.
To create a local task:
- Open Kaspersky Security Center Administration Console.
- In the Kaspersky Security Center Administration Console tree, open the Managed devices folder.
- In the Managed devices folder, select the folder with the name of the administration group that includes the desired device.
- In the workspace, select the Devices tab.
- Select the device for which you want to create a local task.
- Do one of the following:
- In the context menu of the device, select All tasks → Create a task.
- In the context menu of the device, select Properties and in the Properties: <Device name> window that opens on the Tasks tab, click Add.
- In the Perform action drop-down list, select the Create a task item.
The task creation wizard will start.
- Select the required task and click Next.
- Follow the instructions of the task creation wizard.
Creating a group task
Group tasks are performed on the devices of the selected administration group. For more information on tasks, refer to Kaspersky Security Center documentation.
To create a group task:
- Open Kaspersky Security Center Administration Console.
- Do one of the following:
- In the Administration Console tree, select the Managed devices folder to create a group task for all devices managed using Kaspersky Security Center.
- In the Managed devices folder of the Administration Console tree, select the folder with the name of the administration group, which includes the required devices.
- In the workspace, select the Tasks tab.
- Click Create a task.
The task creation wizard will start.
- Select the required task and click Next.
- Follow the instructions of the task creation wizard.
Viewing the table of tasks
To view the list of tasks on Kaspersky Security Center server:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
A list of tasks appears.
Deleting a task from the list
To remove tasks from the list of tasks on Kaspersky Security Center server:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
- In the task list, select the tasks that you want to delete and right-click them to open the context menu.
A list of the actions you can perform on the tasks will be displayed.
- Select the Delete action.
The action confirmation window opens.
- Click Yes.
The selected tasks will be deleted from the list.
Starting tasks manually
You can start the created tasks manually. For example, you can manually start the tasks for which scheduled start is not configured.
To start a task manually:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
A list of tasks appears.
- In the context menu of the desired task, select the Run action.
The task will run.
Starting tasks by schedule
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure the scheduled task start:
- In the Task schedule section, select the Run by schedule check box.
- In the Frequency list select one of the following options to run the tasks: At specified time, Every hour, Every day, Every week, On application launch or After the application database update.
- If you select the At specified time option, specify the day and time to start the task in the Run by schedule section.
- If you select one of the following options: Every hour, Every day or Every week, configure the following settings in the Run by schedule section:
- In the Every list, select the task run frequency. For example, once a day, or twice a week on Tuesdays and Thursdays.
- In the Time and Date lists, select the date and time from which the schedule applies.
- To configure advanced schedule settings, click the Advanced button and configure the following settings in the Advanced window:
- Click OK.
Scheduled task start has now been configured and applied on devices.
Page topViewing task execution results
You can view the task execution results during their storage period. You can also change the storage period for the task execution results.
It is not recommended to shorten the storage period for IOC Scan task execution results.
To view the task execution result:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
A list of tasks appears.
- Select the task in the list and right-click it to open the task actions menu.
- Select the Results menu item.
The Task execution results window will open.
Configuring the storage time for the task execution results on the Administration Server
By default, task execution results are stored on the Administration Server for seven days.
To change the storage time for the task execution results on the Administration Server:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
A list of tasks appears.
- Select the task in the list and right-click it to open the task actions menu.
- Select the Properties menu item.
The task properties window opens.
- In the left part of the window, select the Notification section.
- Make sure that the On the Administration Server for (days) check box is selected in the Save information about results section and specify for how many days you want the task execution results to be stored.
- Click the Apply button and then click OK.
It is not recommended to shorten the storage period for IOC Scan task execution results.
Creating Kaspersky Endpoint Agent activation task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can activate Kaspersky Endpoint Agent using a key or activation code.
When activating the application using an activation code, data is sent to the activation server to verify the entered code.
To activate the application using the activation code, the protected device must be connected to the Internet.
To create Kaspersky Endpoint Agent activation task:
- Run the Application activation task creation wizard for the desired scope in one of the following ways:
- If you want to activate the application using an activation code, perform the following actions in the Activation settings window:
- Select the Activate with an activation code option and click Select.
- In the window that opens, enter the activation code and click OK.
- If you want to activate the application using a key file or a key from Kaspersky Security Center key storage, perform the following actions in the Activation settings window:
- Select the Activate with a key file or key option and click Select.
- In the drop-down list, select the key distribution method.
- If you select the Key file from folder option, in the window that opens, specify the location of the key file and click Open.
- If you select the Key from Kaspersky Security Center storage option, in the window that opens, select the key and click OK.
For detailed information on Kaspersky Security Center key storage, refer to Kaspersky Security Center documentation.
- If you want to add this license key as an additional one to automatically renew the license, select the Use as additional key check box.
- Click Next.
- In the Schedule window, configure the task schedule settings and click Next.
For detailed information on configuring the settings in this window, refer to Kaspersky Security Center documentation.
- In the Selecting an account to run a task window, specify the account to be used to run the task, and click Next.
For detailed information on configuring the settings in this window, refer to Kaspersky Security Center documentation.
- In the Define the task name window, enter the name of the task and click Next.
- If you want to run the task immediately after creation, select the Run task after wizard finishes check box.
- Click Finish.
The application activation task for the selected device or device group has been created.
Managing Kaspersky Endpoint Agent database and module update tasks
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section provides instructions on how to create and configure the Database and application module update task.
Creating Database and application module update task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To create the Database and application module update task for Kaspersky Endpoint Agent in Kaspersky Security Center:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
- Click Create a task.
The task creation wizard will start.
- Select the Kaspersky Endpoint Agent application to create the task, and the Database and application module update task type.
- Click Next.
The Database Update task creation wizard will start.
The Database Update task creation wizard consists of the following steps:
- Selecting a database update source
- Configuring the application modules update settings
- Configuring the database update schedule
- Selecting the devices on which the task will be performed
- Selecting the Kaspersky Security Center user account to run the task
- Defining the task name
- Running the task immediately after it is created
Configuring Database and application module update task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
After creating the Database and application module update task, you can configure the settings for this task.
To modify the task settings:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
A list of tasks appears.
- In the Database and application module update section, select the task in the list and right-click it to open the task action menu.
- Select the Properties menu item.
The task properties window opens.
- In the left part of the window, select the group of settings that you want to configure.
- In the right part of the window, make the necessary modifications and click Apply and OK.
You can configure the following task settings:
- Task name
- Devices on which the task will be performed
- Database update source
- Configuring additional database update settings
- Database update schedule
- Kaspersky Security Center user account used to run the task
- Storage time for the task execution results on the Administration Server
Managing IOC Scan tasks in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section describes how to manage IOC Scan tasks in Kaspersky Endpoint Agent using Kaspersky Endpoint Agent Management plugin.
About IOC Scan tasks in Kaspersky Endpoint Agent
When executing IOC Scan tasks, Kaspersky Endpoint Agent uses
( files of the open description standard) to search for these indicators on devices.Kaspersky Endpoint Agent supports the following types of IOC Scan tasks:
- Standard IOC Scan tasks are group or local tasks that are created and configured manually in Kaspersky Security Center or through the command line interface. IOC files prepared by the user are used to run the tasks.
- IOC scan by IOC files downloaded manually via Kaspersky Anti Targeted Attack Platform web interface allows application users to use IOC files to search for signs of targeted attacks, as well as infected and probably infected objects in the event and detection database, and also to scan computers on which Kaspersky Endpoint Agent is installed.
Different tasks are managed in different ways and have different configurable settings and task scopes. A description of each type of IOC Scan task is provided in the table below.
IOC Scan task types
Task type |
Task description |
Task scope |
---|---|---|
Standard IOC Scan tasks |
These tasks are created and configured manually in Kaspersky Security Center or using the command line interface, without integration with third-party systems. IOC files prepared by the user are used to run the tasks. The task settings do not depend on the policy settings. The mode is available for tasks. You can specify the following actions as responses to detected IOCs (not available when running the tasks from the command line):
|
Local or group |
IOC Scan by IOC files downloaded manually via Kaspersky Anti Targeted Attack Platform web interface |
IOC files are downloaded manually via Kaspersky Anti Targeted Attack Platform web interface. It is also possible to configure the IOC scan schedule for computers with Kaspersky Endpoint Agent in the web interface of Kaspersky Anti Targeted Attack Platform. Task management using Kaspersky Security Center or using the command line is not supported. No actions are automatically performed when an IOC is detected. Task settings do not depend on Kaspersky Endpoint Agent policies. |
Not applicable |
The results of group IOC Scan tasks execution can be viewed in Kaspersky Security Center for 7 days after the task is executed, or until the task is removed.
Page topManaging IOC Scan tasks in Kaspersky Endpoint Agent
You can manage IOC Scan tasks using Kaspersky Security Center or using the Kaspersky Endpoint Agent command line interface, and you can also download IOC files and configure the IOC scan schedule in the Kaspersky Anti Targeted Attack Platform web interface. The description of each IOC Scan task type and information on the available management capabilities for IOC Scan tasks are shown in the table below.
Managing IOC Scan tasks.
Task type |
Using Kaspersky Security Center |
Using the Central Node component |
Using the command line interface |
Standard IOC Scan task |
|
Task management is not applicable. |
|
IOC Scan task created by Central Node |
Task management is not applicable. |
Downloading IOC files, configuring IOC scan schedule. |
Task management is not applicable. |
Managing Standard IOC Scan tasks
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Standard IOC Scan tasks are group or local tasks that are created and configured manually in Kaspersky Security Center or through the command line interface. IOC files prepared by the user are used to run the tasks.
Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
This section provides instructions on how to manage Standard IOC Scan tasks.
Requirements for IOC files
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
When creating IOC Scan tasks, consider the following requirements and limitations related to IOC files:
- Kaspersky Endpoint Agent supports IOC files with the ioc and xml extensions. These files use open standard for IOC description – OpenIOC versions 1.0 and 1.1.
- Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
- If, when creating the IOC Scan task, you upload some IOC files that are not supported by Kaspersky Endpoint Agent then when the task starts, the application will use only supported IOC files.
- If, when creating the IOC Scan task, none of the downloaded IOC files is supported by Kaspersky Endpoint Agent, the task can be started, but as a result of the task execution, no indicators of compromise will be detected.
- Semantic errors and IOC terms and tags in IOC files that are not supported by the application do not cause the task execution errors. The application just does not detect matches in such sections of IOC files.
- that are used in the same IOC Scan task must be unique. The presence of IOC files with the same identifier can affect the correctness of the task execution results.
- The size of a single IOC file must not exceed 3 MB. Using larger files results in the failure of IOC Scan tasks. In this case, the total size of all added files in the IOC collection can exceed 3 MB.
- It is recommended to create one IOC file per each threat. This makes it easier to read the results of the IOC Scan task.
The table below shows the features and limitations of the OpenIOC standard supported by the application.
Features and limitations of the OpenIOC standard versions 1.0 and 1.1
Supported conditions |
OpenIOC 1.0:
OpenIOC 1.1:
|
Supported condition attributes |
OpenIOC 1.1:
|
Supported operators |
|
Supported data types |
|
Data types interpretation details |
The following data types are interpreted as string: The application supports interpretation of the OpenIOC 1.0: Using the
OpenIOC 1.1: Using the Using the The application supports interpretation of the |
Supported IOC terms |
The full list of supported IOC terms is provided in a separate table. |
Supported IOC terms
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The file that can be downloaded by the following link contains a table with a full list of supported IOC terms of the OpenIOC standard.
Creating and configuring Standard IOC Scan task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
To create and configure a Standard IOC Scan task,
depending on the required task scope, perform one of the following actions:
The task creation wizard allows you to configure the following settings:
- IOC collection
- Data types (IOC documents) to be analyzed during IOC scan
- Retrospective IOC scan
- Application actions on IOC detection
- Task start schedule
- Running the task from a Kaspersky Security Center user account
- Task name
Identifiers of all IOC files that are used in the same IOC Scan task must be unique. The presence of IOC files with the same identifier can affect the correctness of the task execution results.
If, when creating the IOC Scan task, you upload some IOC files that are not supported by Kaspersky Endpoint Agent then when the task starts, the application will use only supported IOC files.
Semantic errors and IOC terms and tags in IOC files that are not supported by the application do not cause the task execution errors. The application just does not detect matches in such sections of IOC files.
Configuring Standard IOC Scan task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
To configure the Standard IOC Scan task settings:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
The list of tasks is displayed in the workspace.
- Open the settings of the required task in one of the following ways:
- Double-click the task name.
- Open the policy context menu and select Properties.
- Select a task and click Configure task in the right part of the window.
The Properties: <Task name> window will open.
- In the left part of the window, select the group of settings that you want to configure.
- In the right part of the window, make the necessary changes and click Apply, and then click OK.
Configuration of the Standard IOC Scan task settings is now finished.
You can configure the following task settings:
- Task name
- Storage time for the task execution results on the Administration Server
- IOC collection
- Retrospective IOC scan
- Application actions on IOC detection
- Data types (IOC documents) to be analyzed during IOC scan
- IOC Scan task schedule
- Kaspersky Security Center user account to run the task
- Excluding groups of devices from the task scope
IOC collection export
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To export an IOC collection:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
A list of tasks appears.
- In the Run IOC Scan section, select the task in the list and right-click it to open the task action menu.
- Select the Properties menu item.
The task properties window opens.
- Select the IOC Scan settings section.
- In the IOC collection section click Export.
- In the window that opens, specify the name of the file and select the folder where you want to save it.
- Click the Save button.
The application creates a ZIP file in the folder you specified.
Viewing IOC Scan task execution results
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To view the IOC Scan task execution results:
- Open Kaspersky Security Center Administration Console.
- In Kaspersky Security Center Administration Console tree, open the Tasks folder.
The list of tasks is displayed in the workspace.
- Open the settings of the required task in one of the following ways:
- Double-click the task name.
- Open the policy context menu and select Properties.
- Select a task and click Configure task in the right part of the window.
The Properties: <Task name> window opens.
- Select the Results section.
- In the Show task results for the device list, select the devices for which you want to view the results of IOC Scan tasks.
- To view detailed information about a particular task, double-click it.
- To view detailed information about the detected indicator of compromise, click the Show card button.
Detected IOC card contains information about objects that match the conditions of the processed IOC file, as well as the text of the matched branches or individual conditions from this IOC file.
Viewing the Detected IOC card is not available for IOC files, for which no indicators of compromise were detected during scan.
Managing Kaspersky Endpoint Agent using Kaspersky Security Center Web Console
You can centrally manage several protected devices with Kaspersky Endpoint Agent installed, that are included in the administration group, by means of Kaspersky Endpoint Agent Management web plug-in. Kaspersky Security Center Web Console also lets you separately configure the operation settings of each protected device in the administration group.
An administration group is created manually in Kaspersky Security Center Web Console and includes several devices with Kaspersky Endpoint Agent installed, for which the same control and protection settings can be configured. For details on using administration groups, see Kaspersky Security Center Help.
Application settings for an individual protected device cannot be configured if Kaspersky Endpoint Agent operation on this protected device is controlled by an active Kaspersky Security Center policy.
Kaspersky Endpoint Agent can be managed from Kaspersky Security Center Web Console in the following ways:
- Using Kaspersky Security Center policies. Kaspersky Security Center policies can be used to remotely configure the same protection settings for a group of devices. Task settings specified in the active policy have priority over task settings configured locally in the Application Console or remotely in the device properties window of Kaspersky Security Center Web Console.
- You can use policies to configure general application settings, Real-Time Protection task settings, Local Activity Control tasks settings, and scheduled system task start settings.
- Using Kaspersky Security Center group tasks. Kaspersky Security Center group tasks allow remote configuration of common settings of tasks with a limited execution period for a group of devices.
- You can use group tasks to activate the application, configure On-Demand Scan task settings, update task settings, and Rule Generator for Applications Launch Control task settings.
- Using tasks for a set of devices. Tasks for a set of devices allow remote configuration of common settings of tasks with a limited execution period for protected devices that do not belong to any administration group.
- Using the properties window of a single device. In the device properties window, you can remotely configure the task settings for a single protected device included in the administration group. You can configure both general application settings and the settings of all Kaspersky Endpoint Agent tasks if the selected protected device is not controlled by an active Kaspersky Security Center policy.
Kaspersky Security Center Web Console makes it possible to configure application settings and advanced features, and lets you work with logs and notifications. You can configure these settings for a group of protected devices as well as for an individual protected device.
Google Chrome for Windows is required to manage Kaspersky Endpoint Agent using Kaspersky Security Center Web Console.
Managing Kaspersky Endpoint Agent policies
This section describes how to create Kaspersky Endpoint Agent policies and enable policy settings.
Creating Kaspersky Endpoint Agent policy
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To create a Kaspersky Endpoint Agent policy in the Kaspersky Security Center Web Console:
- In the main window, select Devices → Policies and profiles.
- Click the Add button.
The policy creation wizard starts.
- Select the Kaspersky Endpoint Agent application and click Next.
- Select the required Kaspersky Endpoint Agent deployment method by selecting the appropriate check boxes:
- Integration with Kaspersky Sandbox
- Endpoint Detection and Response Optimum
- Endpoint Detection and Response Expert (KATA EDR), Kaspersky Industrial CyberSecurity for Networks.
Policy type and integration with Kaspersky Sandbox and KATA EDR cannot be selected in Kaspersky Security Center Cloud Console.
- Click Next.
- On the General tab, you can perform the following actions:
- Change the policy name.
- Select policy status:
- Active. After the next synchronization, the policy will be active on the computer.
- Inactive. Backup policy. An inactive policy can be made active, if required.
- Out-of-office. The policy will become active when the computer leaves the corporate network.
- Configure the policy settings inheritance:
- Inherit settings from parent policy. If this option is enabled, the policy settings will be inherited from the upper-level policy. The policy settings cannot be modified if the Force inheritance of settings in child policies option is enabled in the parent policy.
- Force inheritance of settings in child policies. If this option is enabled, the parent policy settings will be applied to child policies. In the properties window of the child policy, the Inherit settings from parent policy option is automatically enabled and cannot be disabled.
- On the Application settings tab, you can configure Kaspersky Endpoint Agent policy settings.
- Click the Save button.
Enabling settings in Kaspersky Endpoint Agent policy
When you configure Kaspersky Endpoint Agent policy settings, by default these settings are saved, but are not applied until you enable them.
You can enable settings for the groups where these settings are located. You can enable either individual groups of settings or all groups of settings within one policy.
To enable the group of settings in Kaspersky Endpoint Agent policy:
- Open the policy properties window.
- Select the section and group of settings to which the required setting belongs.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
All the settings of the group will be applied in the policy.
Configuring Kaspersky Endpoint Agent settings
This section describes how to configure Kaspersky Endpoint Agent settings.
Opening Kaspersky Endpoint Agent settings window
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To open the Kaspersky Endpoint Agent policy settings window:
- In the main Kaspersky Security Center Web Console window select Devices → Policies and profiles.
- Select the policy you want to configure.
- In the <Policy name> window that opens, select the Application settings tab.
To open the Kaspersky Endpoint Agent settings window for an individual device:
- In the main Kaspersky Security Center Web Console window select Devices → Managed devices.
- Select the device.
- In the <Device name> window that opens, select the Applications tab.
- Select Kaspersky Endpoint Agent.
- In the window that opens, select the Application settings tab.
If an active Kaspersky Security Center policy is applied to a device and blocks changes to the application settings, these settings cannot be edited in the Application settings window, except for the network isolation settings.
The settings of automatic network isolation can be configured in the policy properties, and the settings of network isolation on demand (manually enabled settings) can be configured in the properties of an individual device.
Configuring Kaspersky Endpoint Agent security settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To ensure maximum security of the IT infrastructure in your organization, you can configure access of users and third-party processes to Kaspersky Endpoint Agent. To do so, you can:
- Restrict user permissions to manage the application settings and services.
- Password protect actions in the application.
- Enable the application self-defense mechanism.
Configuring user permissions
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can grant access to Kaspersky Endpoint Agent to individual users or groups of users. As a result, only specified users will be able to manage settings or services of the application.
To configure user permissions:
- Do one of the following:
- In the Application settings section select the Security settings subsection.
- In the User permissions for application service management group of settings, click the Configure button next to the name of the required setting (User permissions for application management or Configure user permissions for application management).
To add users and user groups, specify the security descriptor strings using the
. - If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click OK.
- Click the Save button.
Enabling Password protection
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Unrestricted user access to the application and its settings can reduce the security level of the device. Password protection is a means to limit user access to the application.
To enable password protection:
- Do one of the following:
- In the Application settings section select the Security settings subsection.
- In the Password protection group of settings select the Apply password protection check box.
- Enter a password and confirm it.
It is recommended to select a password that meets the following requirements:
- The password must be at least 8 characters long.
- The password must not contain the user's account name.
- The password must not match the name of the device on which Kaspersky Endpoint Agent is installed.
- The password must contain characters from at least three of the following groups:
- uppercase characters (A-Z);
- lowercase characters (a-z);
- numbers (0-9);
- special characters (!$#%).
- If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click OK.
- Click the Save button.
Password protection is now enabled. If a user attempts to perform a password protected action, the application will prompt the user to enter the password.
The application does not check the strength of the specified password. We recommend that you use third-party tools to verify the strength of the password. The password is considered strong enough if verification results confirm that the password cannot be guessed for at least 6 months.
The application does not prohibit login attempts after many attempts of entering an incorrect password.
Enabling and disabling Self-Defense
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The Self-Defense mechanism of Kaspersky Endpoint Agent provides protection from malware that tries to lock or delete the application. The Self-Defense mechanism prevents the alteration or deletion of application files on the hard drive, memory processes, and entries in the system registry.
To enable or disable Self-Defense:
- Do one of the following:
- In the Application settings section select the Security settings subsection.
- In the Self-defense group of settings, enable or disable the Enable self-defense for application modules in memory setting.
- If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click OK.
- Click the Save button.
The Self-Defense mechanism is now enabled or disabled.
Configuring Kaspersky Endpoint Agent connection settings to a proxy server
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Proxy server connection settings are used for updating databases, activating the application, and external services.
If you want to Use proxy server with the specified settings when connecting to KATA, Kaspersky Industrial CyberSecurity for Networks or Kaspersky Sandbox server, make sure that the Connect using the proxy server if specified in the general settings option is selected when configuring integration with KATA, Kaspersky Industrial CyberSecurity for Networks or Kaspersky Sandbox. This option is not selected by default.
To configure proxy server connection settings:
- Do one of the following:
- In the Application settings section select the Security settings subsection.
- Select one of the following proxy service usage options:
- Do not use proxy server.
- Automatically detect proxy server address.
- Use proxy server with specified settings.
- If you select the Automatically detect proxy server address option, the proxy server for further telemetry transmission will be detected automatically.
- If you select the Use proxy server with specified settings option, specify the address and port of the proxy server you want to connect to in the Server name or IP address and Port fields.
The default port number is 8080.
- If you want to use NTLM authentication to connect to the proxy server:
- Select the Use NTLM authentication by user name and password check box.
- In the User name field, enter the name of the user, whose account will be used for proxy server authentication.
- In the Password field, enter the password for connecting to the proxy server.
You can make password characters visible by clicking Show to the right of the Password field.
- If you do not want to use the proxy server for internal addresses of your organization, select the Bypass proxy server for local addresses check box.
- If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click OK.
- In the policy properties window, click Save.
Proxy server connection settings are now configured.
Configuring Kaspersky Security Center as a proxy server for Kaspersky Endpoint Agent activation
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To enable usage of Kaspersky Security Center as a proxy server for the application activation:
- Do one of the following:
- In the Application settings section select the Security settings subsection.
- In the Licensing group of settings, select the Use Kaspersky Security Center as a proxy server when activating the application check box.
- If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click OK.
- In the policy properties window, click Save.
Kaspersky Security Center usage as a proxy server for Kaspersky Endpoint Agent activation is now enabled.
Configuring Kaspersky Endpoint Agent policy type
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Selecting Kaspersky Endpoint Agent's policy type is necessary in order for the list of settings displayed in the policy to correspond to the selected Kaspersky Endpoint Agent deployment method.
To configure the policy type:
- Open the policy properties window.
- In the Application settings section select the Management and interface subsection.
- In the window that opens, select the required Kaspersky Endpoint Agent deployment method by selecting the appropriate check boxes:
- Integration with Kaspersky Sandbox
- Endpoint Detection and Response Optimum
- Endpoint Detection and Response Expert (KATA EDR), Kaspersky Industrial CyberSecurity for Networks
Policy type and integration with Kaspersky Sandbox and KATA EDR cannot be selected in Kaspersky Security Center Cloud Console.
- Click ОК.
The policy type has been changed. The policy contains the settings for the selected Kaspersky Endpoint Agent deployment method.
Page topConfiguring KSN usage in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To protect your computer more effectively, Kaspersky Endpoint Security uses data received from users around the globe. Kaspersky Security Network is designed to receive this data.
Kaspersky Security Network (KSN) is an infrastructure of cloud services that provide access to the online Kaspersky Knowledge Base that contains information about the reputations of files, web resources, and software. The use of data from Kaspersky Security Network ensures faster responses by the EPP application to objects that are not yet listed in anti-virus application databases, improves performance of some protection components, and reduces the likelihood of false positives.
Participation in Kaspersky Security Network allows Kaspersky to quickly acquire information about the types and sources of objects that are not yet listed in anti-virus application databases, develop methods for neutralizing such objects, and reduce the number of false positives.
When you use Kaspersky Security Network, certain statistical data collected while Kaspersky Endpoint Agent is running is automatically sent to Kaspersky. Files, or parts of files, that may be exploited by intruders to harm the computer or data can be also sent to Kaspersky to be further examined.
No personal data is collected, processed, or stored. The types of data that Kaspersky Endpoint Agent sends to Kaspersky Security Network are described in the KSN Statement.
Participation in Kaspersky Security Network is voluntary. KSN usage is disabled by default. After enabling KSN usage, you can disable this option at any time.
Starting from version 3.10, Kaspersky Managed Protection (also referred to as KMP) usage cannot be configured by means of Kaspersky Endpoint Agent. If usage of the KMP service was enabled in the previous Kaspersky Endpoint Agent version, the KMP service continues functioning after the application is updated to version 3.10 and later. After the application update, you can disable the KMP service only using Kaspersky Endpoint Agent Administration Plug-in or Kaspersky Endpoint Agent Web Plug-in of versions earlier then 3.10.
To enable KSN usage:
- Do one of the following:
- In the Kaspersky Security Network section, click the Read terms and conditions of the KSN Statement link and perform the following actions:
- In the right part of the window, review the terms and conditions of the KSN Statement.
- If you agree with terms and conditions of the Statement, select the I confirm that I have fully read, understood, and accept the terms and conditions of this Kaspersky Security Network Statement check box.
- Click OK.
- Select the Enable Kaspersky Security Network usage check box.
- If you want to use Kaspersky Security Center for telemetry transmission, select the Use Kaspersky Security Center as a KSN proxy server check box.
- If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click OK.
- In the policy properties window, click Save.
KSN usage is enabled.
Configuring integration between Kaspersky Endpoint Agent and KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section contains information on how to configure integration between Kaspersky Endpoint Agent and the KATA Central Node component using the Kaspersky Security Center Web Console.
Configuring data submission settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure data submission settings:
- Open the policy properties window.
- In the Telemetry collection servers section, select the General settings subsection.
The General settings window opens.
- In the Data submission settings group, do the following:
- Specify the value in the Events transmission period (sec.) field.
- Specify the value in the Maximum number of events in a package field.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
The default switch position is Enforce.
- Click OK.
Configuring request throttling settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The request throttling feature allows restricting the flow of events with low importance from Kaspersky Endpoint Agent to the Central Node component.
To configure the request throttling settings:
- Open the policy properties window.
- In the Telemetry collection servers section, select the General settings subsection.
The General settings window opens.
- In the Request throttling group of settings, you can perform the following actions:
- Select or clear the Enable request throttling check box to enable or disable the feature.
This feature is enabled by default.
- Specify the value in the Maximum number of events per hour field.
The application analyzes telemetry data flow and restricts transmission of events with low importance if the number of transmitted events tends to exceed the value specified in this field. The default value is 3000 events per hour.
- Specify the value in the Percentage of event limit excess field.
If the flow of events of the same type with low importance exceeds the threshold value specified in this field as a percentage of the total number of events, transmission of events of this type is restricted. You can specify a value from 5% to 100%. The default value is 15%.
- Select or clear the Enable request throttling check box to enable or disable the feature.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
The default switch position is Enforce.
- Click OK.
Enabling and disabling integration with KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
If you use Nginx as a proxy server between a device with Kaspersky Endpoint Agent installed and KATA server, configure the client_max_body_size
setting. The value of the client_max_body_size
setting must be equal to the maximum size of the object sent by Kaspersky Endpoint Agent to KATA for processing. Otherwise, Nginx will not send objects whose size exceeds the specified value. The default value is 1 MB.
To enable or disable integration with the KATA Central Node component:
- Open the policy properties window.
- In the Telemetry collection servers section, select the Integration with KATA subsection.
The KATA integration window opens.
- In the Connection settings group, do one of the following:
- To enable integration with KATA Central Node:
- Select the Enable KATA integration check box.
- In the List of KATA servers settings group, for one or more KATA servers, specify the IP address or full domain name of the KATA server, as well as the port for connecting to the server.
Kaspersky Endpoint Agent connects to the first server in the list. If the connection does not succeed, Kaspersky Endpoint Agent connects to the second server and so on down the list.
- To disable integration with KATA Central Node, clear the Enable KATA integration check box.
- To enable integration with KATA Central Node:
- Enable or disable the Connect using the proxy server if specified in the general settings option.
This option is disabled by default. The application connects to the KATA server only directly and does not use the general proxy server connection settings. You can enable this option if you want the application to use the general proxy server connection settings when connecting to the KATA server.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
The default switch position is Enforce.
- Click OK.
Integration with KATA Central Node is enabled or disabled.
Configuring trusted connection with KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure trusted connection between Kaspersky Endpoint Agent and KATA Central Node, perform the following actions on Kaspersky Endpoint Agent side:
- Open the policy properties window.
- In the Telemetry collection servers section, select the Integration with KATA subsection.
The KATA integration window opens.
- In the Connection settings group, select the Use pinned certificate to protect connection check box.
- Click the Add new TLS certificate button.
The window for adding a new TLS certificate opens.
- Perform one of the following actions to add a TLS certificate:
- Add a certificate file. Click Upload, and in the window that opens, select the certificate file and click Open.
- Copy and paste the contents of the certificate file to the TLS certificate data field.
Kaspersky Endpoint Agent may have only one KATA server TLS certificate. If you have added a TLS certificate before and then add a TLS certificate once again, only the last added certificate is valid.
- Click OK.
Information about the added TLS certificate is shown in the TLS certificate data group of settings.
- If you want to configure additional connection protection by a user certificate, do the following:
- Select the Secure connection with the client certificate check box.
- Click the Load Crypto-container button.
- In the window that opens select the PFX archive and click Open.
- In the Crypto-container password field, enter the password for the PFX archive.
- Click OK.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
The default switch position is Enforce.
- Click OK.
A Trusted connection to the KATA server is now configured.
The TLS certificate file must satisfy the following requirements:
- The file must contain the certificate itself and a private encryption key for the connection.
- The file must be in PEM or DER format.
- The private key length must be 2048 bits or longer.
For more details about preparing TLS certificates for import, refer to OpenSSL documentation.
Configuring synchronization settings between Kaspersky Endpoint Agent and KATA Central Node
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure synchronization settings between Kaspersky Endpoint Agent and KATA Central Node:
- Open the policy properties window.
- In the Telemetry collection servers section, select the Integration with KATA subsection.
The KATA integration window opens.
- In the Additional settings group, configure the following settings:
- Timeout (sec.). Specify the maximum KATA server response timeout. The default value is 10 seconds.
- Send synchronization request to KATA server every (min.). Specify the time interval for sending requests for synchronization Kaspersky Endpoint Agent settings and tasks with KATA Central Node. You can specify a value from 1 to 60 minutes. The default value is 5 minutes.
- Select or clear the Use TTL period when sending events check box. The check box is cleared by default.
If the check box is selected, Kaspersky Endpoint Agent does not send information about the processes that are started again to the KATA server. Kaspersky Endpoint Agent does not consider the launch of the process as repeated if the process is started after the end of the TTL period.
- If you select the Use TTL period when sending events check box, specify the time in the TTL period (min.) field. The default value is 1440 minutes.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
The default switch position is Enforce.
- Click OK.
Configuring EDR telemetry settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section contains information on how to configure:
- Exclusions for EDR telemetry about application processes, which Kaspersky Endpoint Agent processes and sends to a server with the KATA Central Node or Kaspersky Industrial CyberSecurity for Networks component.
- Optimization of the volume of EDR telemetry that Kaspersky Endpoint Agent processes and sends to a server with the Kaspersky Industrial CyberSecurity for Networks component.
- Exclusions for EDR telemetry about network communications, which Kaspersky Endpoint Agent processes and sends to a server with the Kaspersky Industrial CyberSecurity for Networks component.
Enabling and configuring exclusions for and optimization of sent EDR telemetry about application processes
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can enable and configure exclusions for and optimization of EDR telemetry about application processes using Kaspersky Security Center Web Console, in the properties of an individual device or in the policy settings for a group of devices.
Exclusions for EDR telemetry about application processes are available when Kaspersky Endpoint Agent is integrated with servers where KATA Central Node or Kaspersky Industrial CyberSecurity for Networks is installed.
Kaspersky Endpoint Agent does not analyze or send data on excluded application processes to the server with KATA Central Node or Kaspersky Industrial CyberSecurity for Networks installed.
Optimization of the volume of EDR telemetry about application processes can be managed (enabled / disabled) when Kaspersky Endpoint Agent is integrated with servers where Kaspersky Industrial CyberSecurity for Networks is installed.
If optimization of the volume of EDR telemtry is enabled, Kaspersky Endpoint Agent does not send events with 102 (basic communications) and 8 (network activity of a process) codes for the Microsoft SMB protocol and the Network Agent process klnagent.exe regarding processes of applications on a server where KATA Central Node or Kaspersky Industrial CyberSecurity for Networks is installed.
To enable and configure exclusions for and optimization of the volume of EDR telemetry on application processes:
- Do one of the following:
- In the EDR telemetry section, select Excluded processes.
The Excluded processes window opens.
- In the Exclusions settings group, enable the Use exclusions setting to enable use of EDR telemetry exclusions.
- Configure optimization of the volume of EDR telemetry:
When Kaspersky Endpoint Agent is integrated with servers where KATA Central Node is installed, optimization of the volume of EDR telemetry should always be enabled.
- Disable the Optimize the amount of telemetry setting if you want Kaspersky Endpoint Agent to send events with codes 102 (basic communications) and 8 (the process's network activity) for the Microsoft SMB protocol, WinRM service, and the Network Agent process klnagent.exe.
- Enable the Optimize the amount of telemetry setting if you want Kaspersky Endpoint Agent to not send events with codes 102 (basic communications) and 8 (the process’s network activity) for the Microsoft SMB protocol and the Network Agent process klnagent.exe.
If the Use exclusions setting is disabled, Kaspersky Endpoint Agent does not send events with codes 102 (basic communications) and 8 (the process's network activity) for the Microsoft SMB protocol and the Network Agent process klnagent.exe, regardless of the value of the Optimize the amount of telemetry setting.
- Create a list of exclusions:
- Click the Add button.
- In the Rule properties window that opens, configure the exclusion settings:
- Click OK to save the changes and close the Rule properties window.
The new exclusion is created and displayed in the list of exclusions.
- If you need to export the exclusion list to an XML file, click the Export button.
- If you need to import the exclusion list from an XML file, click the Import button.
- If you need to modify an exclusion, click the Modify button.
- If you need to delete an exclusion from the list, select the exclusion and click the Delete button.
- If you are configuring the policy settings, make sure that the switch in the upper right corner of the group of settings is turned on. It is the default position of the switch.
- Click OK to save the changes.
Enabling and configuring exclusions for sent EDR telemetry about network communications
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can configure exclusions for EDR telemetry about network communications using Kaspersky Security Center Web Console, in the properties of an individual device or in the policy settings for a group of devices.
Exclusions for EDR telemetry about network communications are applied when Kaspersky Endpoint Agent is integrated with servers where Kaspersky Industrial CyberSecurity for Networks is installed.
Kaspersky Endpoint Agent does not analyze or send data matching exclusion settings to the server with KATA Central Node or Kaspersky Industrial CyberSecurity for Networks installed.
To enable and configure EDR telemetry about network communications:
- Do one of the following:
- In the EDR telemetry section, select Excluded network communications.
The Excluded network communications of the process window opens.
- In the Exclusions settings group, enable the Use exclusions setting to enable use of EDR telemetry exclusions.
- Create a list of exclusions:
- Click the Add button.
- In the Rule properties window that opens, configure the exclusion settings.
- If you need to modify an exclusion, click the Modify button.
- If you need to delete an exclusion, select the exclusion and click the Delete button.
- If you are configuring the policy settings, make sure that the switch in the upper right corner of the group of settings is turned on. It is the default position of the switch.
- Click OK to save the changes.
Configuring integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Before performing the following steps, get the MDR configuration file. It contains a configuration file (BLOB) required for integration.
By downloading the Kaspersky Managed Detection and Response configuration file, you agree to automatically send the data from the device with Kaspersky Endpoint Security installed to Kaspersky for processing. Do not download the configuration file if you do not want the transmitted data to be processed.
If you want Kaspersky Endpoint Agent to process data about events generated by Kaspersky Industrial CyberSecurity for Networks and send this data to Kaspersky Managed Detection and Response, configure interaction with Kaspersky Security Center in the settings of Kaspersky Industrial CyberSecurity for Networks. For detailed information on configuring interaction between the applications, refer to the Kaspersky Industrial CyberSecurity for Networks documentation.
To configure integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response using the Kaspersky Security Center Web Console:
- Open the Kaspersky Security Center Web Console.
- Open the Devices → Policies and profiles tab.
- In the list of policies, select the name of Kaspersky Endpoint Agent policy that you want to configure.
This opens the policy settings window.
- Enable KSN Usage.
Open the main window of the Kaspersky Security Center Web Console.
- In the Administration Console tree, configure the Private KSN settings (for information on configuring Kaspersky Security Network proxy server settings, refer to Kaspersky Security Center Help).
Download the Kaspersky Managed Detection and Response configuration file with the pkcs7 extension that is included in the mdr_config.zip archive.
- To continue configuring integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response, open the main window of the Kaspersky Security Center Web Console.
- Open the Devices → Policies and profiles tab.
- In the list of policies, select the name of Kaspersky Endpoint Agent policy that you want to configure.
This opens the policy settings window.
- On the Application settings tab, select Managed Detection and Response.
- In the Managed Detection and Response settings group, do the following:
- Switch the toggle button to Managed Detection and Response enabled.
- Click the Upload configuration file (BLOB) button and select the BLOB configuration file to load.
- In the User identifier field, enter an arbitrary value.
- In the upper right corner of the settings group, change the switch from Undefined to Enforce.
- Click Save to save the changes.
Integration between Kaspersky Endpoint Agent and Kaspersky Managed Detection and Response is configured.
MDR operation when using Kaspersky Endpoint Agent simultaneously with Kaspersky Endpoint Security
Kaspersky Endpoint Security 11 or later with the current database version supports interaction with MDR. In Kaspersky Endpoint Security 11.6.0 or later, interaction with MDR is available immediately after installation.
If you use Kaspersky Endpoint Agent to work with MDR and install Kaspersky Endpoint Security of the version that supports interaction with MDR or update Kaspersky Endpoint Security 11 or later databases to the current version, MDR stops working with Kaspersky Endpoint Agent and becomes available for work with Kaspersky Endpoint Security. At that:
- Switching between Kaspersky Endpoint Agent and Kaspersky Endpoint Security is performed in quiet mode.
- Kaspersky Endpoint Agent allows for configuring settings for interaction with MDR, but these settings are not applied on the device.
- If Kaspersky Endpoint Security is not available (for example, you uninstalled the application), MDR can start working with Kaspersky Endpoint Agent if you restart the Kaspersky Endpoint Agent service.
- The Managed Detection and Response component remains in the Running status in Kaspersky Endpoint Agent settings on the device, since Kaspersky Endpoint Agent continues to communicate with MDR (for example, to resume working with the solution if necessary).
Configuring storage settings in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
This section describes how to configure the quarantine settings and data synchronization settings with the Administration Server by means of Kaspersky Endpoint Agent Management plug-in.
About Kaspersky Endpoint Agent quarantine
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Quarantine is a special local repository on the device. The user can put files considered dangerous to the computer into quarantine. Quarantined files are stored in an encrypted form and therefore do not compromise your device's security.
By default, the local quarantine is located in the %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\<application version>\Quarantine
folder. By default, the objects restored from quarantine are stored in the %ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\<application version>\Restored
folder.
Kaspersky Security Center generates a common list of quarantined objects on devices with Kaspersky Endpoint Agent installed. Network Agents on the devices submit information about quarantined files to the Administration Server.
Kaspersky Security Center Network Agent does not copy files from quarantine to the Administration Server. All objects are stored on protected devices with Kaspersky Endpoint Agent installed. Objects are restored from the quarantine also on the protected devices.
About quarantine management in Kaspersky Endpoint Agent
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can use Kaspersky Security Center to configure quarantine settings, view the properties of the quarantined objects on the protected devices, delete quarantined objects, and restore objects from Quarantine. For detailed information on managing the quarantined objects using Kaspersky Security Center, refer to Kaspersky Security Center documentation.
In order for Kaspersky Endpoint Agent to send data about quarantined objects to Kaspersky Security Center Administration Server, the corresponding option must be enabled in the quarantine settings in Kaspersky Endpoint Agent policy. This option is enabled by default.
Using the command line interface on the device, you can view information about quarantine settings and properties of the quarantined objects.
Kaspersky Endpoint Agent quarantines object under the system account (SYSTEM).
Quarantined objects can be removed using the command line interface only with the permissions of the local account of the protected device user.
Configuring quarantine settings and restoration of objects from quarantine
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure quarantine settings:
- In the main Kaspersky Security Center Web Console window select Devices → Policies and profiles.
- Select the policy you want to configure.
- In the <Policy name> window that opens, select the Application settings tab.
- In the Repositories section select the Quarantine subsection.
- In the Quarantine settings section configure the quarantine settings:
- In the Quarantine folder field, enter the path to where you want to create the Quarantine folder on the devices or click Browse and select the path.
The default path is
%SOYUZAPPDATA%\Quarantine\
. The Quarantine folder is created on all devices with Kaspersky Endpoint Agent at the following path:%ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0
.The value of the
%ALLUSERSPROFILE%
variable depends on the operating system of the device where Kaspersky Endpoint Agent is installed.Example:
If the device has the Windows 7 operating system installed and Kaspersky Endpoint Agent is installed on drive C, the path to the Quarantine folder will be:
C:\ProgramData\Kaspersky Lab\Endpoint Agent\4.0\Quarantine
- To configure the maximum quarantine size, select the Maximum Quarantine size (MB) check box and specify the maximum size of quarantine in megabytes or select it from the list.
For example, you can set the maximum quarantine size to 200 MB.
When the maximum quarantine size is reached, Kaspersky Endpoint Agent will publish the corresponding event on Kaspersky Security Center server and in the Windows Event Log, but will not stop quarantining new objects.
- To specify the quarantine threshold (the space in quarantine remaining until the maximum quarantine size is reached), select the Threshold value for space available (MB) check box.
For example, you can set the quarantine threshold value to 50 MB.
When the quarantine threshold is reached, Kaspersky Endpoint Agent will publish the corresponding event on the Kaspersky Security Center server and in the Windows Event Log, but will not stop quarantining new objects.
- In the Quarantine folder field, enter the path to where you want to create the Quarantine folder on the devices or click Browse and select the path.
- In the Restoring objects from Quarantine section, in the Target folder for restored objects field, specify the path to create the folder for objects restored from quarantine.
The default path is
%SOYUZAPPDATA%\Restored\
. The Restored folder is created on all devices with Kaspersky Endpoint Agent at the following path:%ALLUSERSPROFILE%\Kaspersky Lab\Endpoint Agent\4.0
.The value of the
%ALLUSERSPROFILE%
variable depends on the operating system of the device where Kaspersky Endpoint Agent is installed.Example:
If the device has the Windows 7 operating system installed and Kaspersky Endpoint Agent is installed on drive C, the path to the folder with the objects restored from quarantine will be:
C:\ProgramData\Kaspersky Lab\Endpoint Agent\4.0\Restored
- If you configure the policy settings, in the upper right corner of the group of settings, change the switch from Undefined to Enforce.
- Click Apply and OK.
The quarantine settings and the folder for restoring objects from quarantine have been configured.
Configuring data synchronization with the Administration Server
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can configure synchronization of data on quarantined objects on managed devices with Kaspersky Security Center Administration Server.
To configure data synchronization with the Administration Server:
- Do one of the following:
- In the Repositories section select the Synchronization with Administration Server subsection.
- Select the Data about quarantined objects on managed devices.
- Click OK.
- Click the Save button.
Data synchronization with the Administration Server is configured.
Configuring failure diagnosis
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Kaspersky Endpoint Agent does not automatically create a folder for storing trace or dump files on the device. Specify a folder that is already available on the device.
To configure failure diagnosis:
- Open the application properties window for an individual device.
- In the Application settings section select the Failure diagnosis subsection.
- To enable logging of debug information to the trace files:
- Enable the Write debug information to trace files option.
- In the Trace files folder field, specify the path to the folder on the device where the application saves the trace files.
Make sure that the specified folder is available on the managed device. Otherwise, the debug information will not be saved.
- In the Maximum trace file size (MB) field, specify the file size in megabytes.
The default value is 50 MB. When the specified file size is reached, the application continues writing to a new file.
- If you want the application to overwrite old trace files:
- Enable the Overwrite old trace files option.
- Enter the desired value in the Maximum number of files per trace log field.
The default value is 1 file. When the specified number of files is reached, the application overwrites old files, starting with the oldest one. The specified limit is applied separately for each Kaspersky Endpoint Agent process being debugged, so the total number of files for all processes may exceed the specified value.
- To enable logging of dump files:
- Enable the Create dump files option.
- In the Dump files folder field, specify the folder to save the dump files.
Make sure that the specified folder is available on the managed device. Otherwise, the debug information will not be saved.
- Click OK.
Failure diagnostics is configured and enabled for all Kaspersky Endpoint Agent processes that are currently running. Failure diagnostics files will be generated in the folders you specified.
Managing Kaspersky Endpoint Agent tasks
This section describes how to manage Kaspersky Endpoint Agent tasks.
Creating tasks
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To create a task:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- Click the Add button.
The task creation wizard will start.
- In the Application drop-down list, select Kaspersky Endpoint Agent.
- In the Task type drop-down list, select the required task type and follow the wizard instructions.
- To change the default values of the task settings immediately after its creation, select the Open task details when creation is complete check box on the Finish task creation page.
If you do not select this check box, the task will be created with the default settings. You can subsequently change these settings at any time for the following task types:
- Click Finish.
The task will be created and displayed in the list of tasks.
You can start the created task manually or configure a scheduled task start.
Viewing the table of tasks
To view the list of tasks,
select Devices → Tasks in the main Web Console window.
A list of tasks appears. The tasks are grouped by the names of the applications for which they are created.
Deleting a task from the list
To remove tasks from the list of tasks on Kaspersky Security Center server:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
A list of tasks appears.
- In the list of tasks, select the check boxes next to the tasks that you want to delete.
- Click the Delete button.
The action confirmation window opens.
- Click Yes.
The selected tasks will be deleted from the list.
Configuring task schedule settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure the scheduled task start:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- On the Schedule tab in the General section, change the toggle button from Schedule disabled to Run by schedule.
- In the Frequency drop-down list select one of the following options: At specified time, Every hour, Every day, Every week or On application launch.
- If you select the At specified time option, specify the day and time to start the task.
- If you select one of the following options: Every hour, Every day or Every week, configure the following settings:
- In the Every field, specify the task run frequency. For example, once a day or twice a week on Tuesdays and Thursdays.
- In the Start time and Start date fields, select the date and time from which the schedule applies.
- To configure advanced schedule settings, select the Advanced section and perform the following steps:
- If you want to set maximum timeout for the task execution, select the Quit task, running longer than check box and specify the number of hours and minutes after which the task will automatically terminate.
- If you want the task schedule to be valid until a certain date, select the Cancel schedule from check box and specify the expiration date for the schedule.
- If you want the application to start the tasks that were not completed on time as soon as possible, select the Run missed tasks check box.
- If you want to avoid simultaneous access of a large number of devices to the Administration Server as well as to run the task on workstations not precisely according to the schedule, but randomly within a certain time interval, select the Randomize the task start time within the interval check box and specify the start interval in minutes.
- Click the Save button.
Starting tasks manually
The application starts tasks according to the schedule specified in the properties of each task. You can start the task manually at any time.
To start a task manually:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- In the list of tasks, select the check box next to the task that you want to start.
- Click Start.
The task will be started. You can check the task status in the Status column or by clicking the Result button.
Creating Kaspersky Endpoint Agent activation tasks
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can activate Kaspersky Endpoint Agent using a license key from the Kaspersky Security Center key store. For detailed information on managing license keys using Kaspersky Security Center, refer to the Kaspersky Security Center Help.
To create Kaspersky Endpoint Agent activation task:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- Click the Add button.
The task creation wizard will start.
- In the Application drop-down list, select Kaspersky Endpoint Agent.
- In the Task type drop-down list, select Application activation.
- In the Task name field, specify the display name of the task.
- To create a task for devices of a specific Administration Server group, perform the following actions:
- In the Selecting devices to which the task is assigned group of settings, select the Group of devices option and click Next.
- Select the desired Administration Server group and click Next.
- To create a task for specific devices using a range of IP addresses, NetBIOS names, DNS names, or to select devices from the list of devices detected in the network by the Administration Server, perform the following actions:
- In the Selecting devices to which the task is assigned group of settings, select the Selected or imported from the list option and click Next.
- Add devices to the list by the required criteria and click Next.
- To create a task for devices of a specific selection, perform the following actions:
- In the Selecting devices to which the task is assigned group of settings, select the Selection option and click Next.
- Select the desired selection from the list and click Next.
- In the Select a license key window, select the required license key from the list of Kaspersky Security Center keys available in the key storage.
- If you want to add this license key as an additional one to automatically renew the license, select the Use as additional key check box.
- Click Next.
- In the Selecting an account to run a task window, select the desired account and click Next.
- To change the default values of the task settings immediately after its creation, select the Open task details when creation is complete check box on the Finish task creation page.
- Click Finish.
The task will be created and displayed in the list of tasks.
You can start the created task manually or configure a scheduled task start.
Configuring Database and application module update task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Task creation is performed before, as an individual step.
If you selected the Open task details when creation is complete check box on the Finish task creation page during the task creation, proceed to step 4 of the following instruction.
To configure the Database and application module update task settings:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- Select the Connection settings section.
- If you use Kaspersky Security Center, in the Update source group of settings, select one of the following options:
- Kaspersky Security Center Administration Server.
- Kaspersky update servers.
- Custom HTTP or FTP servers or network folders.
- If you use Kaspersky Security Center Cloud Console, in the Update source group of settings, select one of the following options:
- Distribution points. Devices with Network Agent installed are used as the update source.
Detailed information on using the distribution points is available in the Kaspersky Security Center Cloud Console Help.
- Kaspersky update servers. Kaspersky update servers are used as the update source.
- Distribution points. Devices with Network Agent installed are used as the update source.
- If required, select the Use Kaspersky update servers if specified servers are not available check box.
Not available in Kaspersky Security Center Cloud Console.
- If you select Custom HTTP or FTP servers or network folders as database update source, do the following:
Not available in Kaspersky Security Center Cloud Console.
- Click the Settings link to open the Custom update sources window.
- Add the update sources to the list by following these steps:
- Click the Add button.
- In the dialog box that opens, in the Web address field, enter the address of the update server (HTTP or FTP), or the path to the network folder or local folder containing the update files, and click OK.
- If you want to use the database update source, switch the toggle button next to its address to Enable.
Follow the same steps to add each update source.
- Click OK.
The Custom update sources window closes.
- Select the Update settings section.
- In the Update settings section, select the conditions for the application to check for the availability of application module updates:
- Do not check for updates. Kaspersky Endpoint Agent will not check the availability of application module updates.
- Only check for availability of critical software modules updates. Kaspersky Endpoint Agent will check the availability only for important application module updates.
- Download and install critical software modules updates. Kaspersky Endpoint Agent will check the availability of application module updates and download and install critical application module updates.
- If you want the application to display a notification about all scheduled application modules updates available in the update source, select the Receive information about available scheduled application module updates check box.
- Click the Save button.
You can start the created task manually or configure a scheduled task start.
Managing Standard IOC Scan tasks
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Standard IOC Scan tasks are group or local tasks that are created and configured manually in Kaspersky Security Center or through the command line interface. IOC files prepared by the user are used to run the tasks.
Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
This section provides instructions on how to manage Standard IOC Scan tasks.
Requirements for IOC files
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
When creating IOC Scan tasks, consider the following requirements and limitations related to IOC files:
- Kaspersky Endpoint Agent supports IOC files with the ioc and xml extensions. These files use open standard for IOC description – OpenIOC versions 1.0 and 1.1.
- Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
- If, when creating the IOC Scan task, you upload some IOC files that are not supported by Kaspersky Endpoint Agent then when the task starts, the application will use only supported IOC files.
- If, when creating the IOC Scan task, none of the downloaded IOC files is supported by Kaspersky Endpoint Agent, the task can be started, but as a result of the task execution, no indicators of compromise will be detected.
- Semantic errors and IOC terms and tags in IOC files that are not supported by the application do not cause the task execution errors. The application just does not detect matches in such sections of IOC files.
- Identifiers of all IOC files that are used in the same IOC Scan task must be unique. The presence of IOC files with the same identifier can affect the correctness of the task execution results.
- The size of a single IOC file must not exceed 3 MB. Using larger files results in the failure of IOC Scan tasks. In this case, the total size of all added files in the IOC collection can exceed 3 MB.
- It is recommended to create one IOC file per each threat. This makes it easier to read the results of the IOC Scan task.
The table below shows the features and limitations of the OpenIOC standard supported by the application.
Features and limitations of the OpenIOC standard versions 1.0 and 1.1
Supported conditions |
OpenIOC 1.0:
OpenIOC 1.1:
|
Supported condition attributes |
OpenIOC 1.1:
|
Supported operators |
|
Supported data types |
|
Data types interpretation details |
The following data types are interpreted as string: The application supports interpretation of the OpenIOC 1.0: Using the
OpenIOC 1.1: Using the Using the The application supports interpretation of the |
Supported IOC terms |
The full list of supported IOC terms is provided in a separate table. |
Supported IOC terms
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The file that can be downloaded by the following link contains a table with a full list of supported IOC terms of the OpenIOC standard.
Configuring Standard IOC Scan task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Task creation is performed before, as an individual step.
If you selected the Open task details when creation is complete check box on the Finish task creation page during the task creation, proceed to step 4 of the following instruction.
Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
To configure the Standard IOC Scan task settings:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- In the IOC scan settings section, configure the IOC collection by following these steps:
- In the IOC collection group of settings click the Redefine IOC files button.
- In the dialog that opens, click the Add IOC files button and specify the IOC files that you want to use for the task.
You can select multiple IOC files for a single IOC Scan task.
- Click OK to close the dialog box.
If, when creating the IOC Scan task, you upload some IOC files that are not supported by Kaspersky Endpoint Agent then when the task starts, the application will use only supported IOC files.
- To view the list of all IOC files that are included in the IOC collection, as well as to obtain information about each IOC file, do the following:
- Click the link with the names of all downloaded IOC files in the IOC files group of settings.
The IOC contents window opens.
- To view detailed information about an individual IOC file, click the name of the required IOC file in the list of files on the IOC collection tab.
In the window that opens, information about the selected IOC file will be displayed.
- To close the window with information about the selected IOC file, click OK or Cancel.
- To view information about all downloaded IOC files at once, open the IOC data tab.
Information about each downloaded IOC file will be displayed in the workspace of the window.
- If you do not want to use a specific IOC file when the IOC Scan task is executed, on the IOC collection tab, switch the toggle button next to the IOC file name from Include to Exclude.
- Click OK to save the changes and close the IOC contents window.
- Click the link with the names of all downloaded IOC files in the IOC files group of settings.
- To export the created IOC collection, click the Export IOC collection button.
In the window that opens, specify the name of the file and select the folder where you want to save it.
- Click the Save button.
The application creates a ZIP file in the specified folder.
- In the Retrospective IOC scan group of settings configure the settings for Retrospective IOC scan mode:
- In the Retrospective IOC Scan group of settings enable the Perform Retrospective IOC Scan within the interval option.
- Specify the time interval.
During the task execution, the application analyzes data collected during the specified time interval, including the boundaries of the specified interval (from 00:00 on the start date until 23:59 on the end date). The default interval starts at 00:00 on the day preceding the task creation day and ends at 23:59 on the day when the task was created.
If during execution of the IOC Scan task with the Perform Retrospective IOC Scan within the interval option enabled the application does not find any data for the specified time interval to be analyzed, it does not inform about this. In this case, the application shows no indicators of compromise in the task completion report.
- In the Actions group of settings, configure the response actions on detecting the indicator of compromise:
- Select the Take response actions after an indicator of compromise is found check box.
- Select the Isolate device from the network check box to enable network isolation of the device on which indicator of compromise is detected by Kaspersky Endpoint Agent.
- Select the Quarantine and delete check box to quarantine the detected object and remove it from the device.
- Select the Run critical areas scan on the device check box so that Kaspersky Endpoint Agent sends a command to EPP application to scan critical areas on all the devices of the administration group on which indicators of compromise are detected.
If the Quarantine and delete or Run critical areas scan option is enabled, Kaspersky Endpoint Agent may recognize the detected files as infected and delete them from the device in response.
- In the Protection of critical system files group of settings, select the Do not perform actions on critical system files check box if you want to protect critical system files from being quarantined or deleted when an indicator of compromise is detected.
The option is available only if the Quarantine and delete option is selected in the Actions group of settings.
If this option is selected and an object is a critical system file, the application does not perform any actions on this object. This information is logged in the task execution report.
- In the Advanced section, select data types (IOC documents) that you want to analyze during the task execution and configure the additional scan settings:
- In the Select data types (IOC documents) to analyze during IOC scanning group of settings, select the check boxes next to the required IOC documents.
Depending on the loaded IOC files, some check boxes may be disabled.
Kaspersky Endpoint Agent automatically selects data types (IOC documents) for the IOC Scan task in accordance to the contents of the downloaded IOC files. It is not recommended to unselect data types manually.
- If the Analyze file data (FileItem) check box is selected, click the Advanced (FileItem) link and in the FileItem document scan settings window that opens, select the scan areas on the protected device drives where to look for indicators of compromise.
You can select one of the predefined areas, or specify the paths to the desired areas manually.
- Click OK to save the changes and close the FileItem document scan settings window.
- If the Analyze WEL data (EventLogItem) check box is selected, click the Advanced (EventLogItem) link and in the EventLogItem document scan settings window that opens, configure additional event analysis settings:
- Scan only events that are logged within the specified period.
If the check box is selected, only the events that were logged during the specified period will be taken into account during the task's execution.
- Scan events that belong to the following channels.
List of channels to be analyzed during the task's execution.
- Scan only events that are logged within the specified period.
- Click OK to save the changes and close the FileItem document scan settings window.
- In the Select data types (IOC documents) to analyze during IOC scanning group of settings, select the check boxes next to the required IOC documents.
- Click the Save button.
You can start the created task manually or configure a scheduled task start.
Viewing IOC Scan task execution results
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To view the IOC Scan task execution results:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- Select the IOC Scan results section.
- In the Device drop-down list, select the devices, for which you want to view the results of IOC Scan task.
A summary table with the task execution results on the selected devices will be displayed.
If compromise indicators are detected on devices, the Results column displays the compromise indicators detected link.
- If you want to view detailed information on the detected compromise indicators on a specific device, do the following:
- Click the compromise indicators detected link in the row with the name of the desired device.
The IOC Scan results window opens that contains a list of all IOC files used in the task. If there is an object on the selected device that matches a certain compromise indicator, the Status column displays the Match value.
- Click the Match link in the row with the name of the desired IOC file.
The IOC incident card window opens.
The IOC incident card contains information about objects on the device that match the conditions of the processed IOC file, as well as the text of the matched branches or individual conditions from this IOC file.
Viewing the IOC incident card is not available for IOC files for which no matches were detected on the device during scanning.
- Click the compromise indicators detected link in the row with the name of the desired device.
Configuring the Quarantine file task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
If you suspect that an infected or probably infected file is on the computer, you can isolate it by moving it to quarantine.
Task creation is performed before, as an individual step.
If you selected the Open task details when creation is complete check box on the Finish task creation page during the task creation, proceed to step 4 of the following instruction.
To configure the Quarantine file task settings:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- In the Specify the file to be Quarantined drop-down list, select one of the following values: Specify the file by full path or Specify the file by folder path and checksum.
- If you select the Specify the file by its full path option, specify the value in the File full path field.
- If you select the Specify the file by folder path and checksum option, configure the following settings:
- In the Checksum type drop-down list, select one of the following values: MD5 or SHA256.
- Specify the value in the File checksum field.
- Specify the value in the File folder path field.
- In the Actions after quarantining file group of settings, select whether the file must be deleted from the protected device after quarantining.
If the file is locked by another process, the file will only be deleted after the device has been rebooted.
- In the Protection of critical system files group of settings, select the Do not perform actions on critical system files check box if you want to exclude critical system files from the task scope.
If this option is selected and an object is a critical system file, the application does not perform any actions on this object. This information is logged in the task execution report.
- Click the Save button.
You can start the created task manually or configure a scheduled task start.
If the file is locked by another process, the task will be displayed with the Completed status, but the file itself will only be quarantined after the device has been restarted. It is recommended to check whether the task was completed successfully after the device has been restarted.
The Quarantine file task may fail with the Access denied error if you try to quarantine an executable file that is currently running. To solve this problem, create the Terminate process task for this file and try to create a Quarantine file task again.
Configuring the Delete file task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Task creation is performed before, as an individual step.
If you selected the Open task details when creation is complete check box on the Finish task creation page during the task creation, proceed to step 4 of the following instruction.
To configure the Delete file task settings:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- In the File to delete list, click the Add button.
- The File to delete dialog box opens.
- In the Specify the file to delete drop-down list, select one of the following values: Specify the file by its full path or Specify the file by its folder path and checksum.
- If you select the Specify the file by its full path option, specify the value in the File full path field.
- If you select the Specify the file by folder path and checksum option, configure the following settings:
- In the Checksum type drop-down list, select one of the following values: MD5 or SHA256.
- Specify the value in the File checksum field.
- Specify the value in the File folder path field.
- Select the Including subfolders check box for the application to delete all occurrences of the object not only in the specified folder, but also in all its subfolders.
- Click OK to add the specified object to the File to be removed list.
You can specify several objects for deletion in one Delete file task.
- In the Protection of critical system files group of settings, select the Do not perform actions on critical system files check box if you want to exclude critical system files from the task scope.
If this option is selected and an object is a critical system file, the application does not perform any actions on this object. This information is logged in the task execution report.
- Click the Save button.
You can start the created task manually or configure a scheduled task start.
If the file is locked by another process, the task will be displayed with the Completed status, but the file itself will only be deleted after the device has been restarted. It is recommended to check whether the file was deleted successfully after the device has been restarted.
Deleting a file from a connected network drive is not supported.
Configuring the Run process task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Using the Run process task, you can run the required application or command on the device.
Task creation is performed before, as an individual step.
If you selected the Open task details when creation is complete check box on the Finish task creation page during the task creation, proceed to step 4 of the following instruction.
To configure the Run process task settings:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- To run the application using the command line (cmd.exe) or execute a command, type the required command in the Executable command field.
- If you want to run the application directly, do the following:
- Specify the path to the application executable file in the Working folder field.
- Specify the keys for running the application in the Arguments field.
- Click the Save button.
You can start the created task manually or configure a scheduled task start.
Configuring the Terminate process task
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
If you believe that a process running on the device could threaten the security of the device or the corporate LAN, you can terminate the process.
Task creation is performed before, as an individual step.
If you selected the Open task details when creation is complete check box on the Finish task creation page during the task creation, proceed to step 4 of the following instruction.
To configure the Terminate process task settings:
- In the main Kaspersky Security Center Web Console window select Devices → Tasks.
- To open the task settings window, click the task name.
- Select the Application settings tab.
- In the File full path field specify the path to the file of the process that you want to terminate.
- In the Checksum type drop-down list, select one of the following values: Not specified, MD5 or SHA256.
- If you select MD5 or SHA256, specify the value in the Checksum field.
- If you want the application to consider the character case in the path to the process file, select the Path is case sensitive check box.
- In the Protection of critical system files group of settings, select the Do not perform actions on critical system files check box if you want to exclude critical system files from the task scope.
If this option is selected and an object is a critical system file, the application does not perform any actions on this object. This information is logged in the task execution report.
- Click the Save button.
You can start the created task manually or configure a scheduled task start.
Managing Kaspersky Endpoint Agent using the command line interface
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Kaspersky Endpoint Agent can be managed using the command line interface. The functionality of the command line interface is provided by the Agent.exe utility. The Agent.exe utility is included in the Kaspersky Endpoint Agent distribution kit and is installed on each device together with Kaspersky Endpoint Agent. It is installed in the %ProgramFiles%\Kaspersky Lab\Endpoint Agent
folder (if a 32-bit operating system is used on the device) or in the % ProgramFiles(x86)%\Kaspersky Lab\Endpoint Agent
folder (if 64-bit operating system is used on the device).
Example: If the device has the x64 Windows operating system installed and you select the C Drive as the installation location for Kaspersky Endpoint Agent, the Agent.exe utility will be placed in the following folder:
|
To manage Kaspersky Endpoint Agent using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Type the following command:
agent.exe --<application setting you want to configure>=<action on the setting you want to execute>
and press ENTER.The command execution result (return code) will be displayed.
To display help on all the application settings and their possible values,
run the following command: agent.exe --help
Managing Kaspersky Endpoint Agent activation
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To manage application activation through the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter one of the following commands and press ENTER:
- To activate the application using the activation code or key file:
agent.exe --license=add <activation code or path to the key file>
To activate the application using the activation code, the protected device must be connected to the Internet.
- To specify an additional key to automatically renew the license:
agent.exe --license=reserve <activation code or path to the key file>
- To remove an added primary or additional key:
agent.exe --license=delete <key serial number>
- To view the status of added keys:
agent.exe --license=show
- To activate the application using the activation code or key file:
Return codes of the --license
command:
-305
– the added key has expired.2
– undefined application error.-302
– the added key is in the deny list.-301
– the added key is not suitable to activate Kaspersky Endpoint Agent.-303
– key file is damaged.4
– syntax errors.-304
– invalid path to the key file has been specified.
Managing Kaspersky Endpoint Agent authentication
This Help provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To manage application authentication using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, you can type the following command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press Enter.
- Run the following command and press Enter:
agent.exe --proxy={enable|disable|show} --mode={auto|custom} --server=<
proxy server address
> --port=<
port number
> --use-auth={yes|no} --proxy-user=<
user name
> --proxy-password=<
user password
> --bypass-local={yes|no}
The authentication parameters are described in the following table.
Authentication parameters
Parameters |
Description |
|
Required parameter. This parameter controls the connection to the proxy server.
The specified proxy server will be used to work with Kaspersky Security Network and to update databases. The settings of the specified proxy server can be used for integration with other statistics collection systems. The use of the specified proxy server must be separately enabled in the integration settings. |
|
Required parameter. This parameter sets the proxy server configuration mode.
|
|
Required parameter. |
|
Required parameter. |
|
Optional parameter.
|
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter.
|
Configuring tracing
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Kaspersky Endpoint Agent does not automatically create a folder for storing trace or dump files on the device. Specify a folder that is already available on the device.
To configure tracing in Kaspersky Endpoint Agent using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter one of the following commands and press ENTER:
agent.exe --trace=enable --folder <path to the folder where the trace files are to be saved>
to enable tracing.Tracing will be enabled for all Kaspersky Endpoint Agent processes that are currently running. Trace files will be created in the folder you specified.
Make sure that the specified folder is available on the managed device. Otherwise, trace files will not be created.
agent.exe --trace=enable --folder <path to the folder where the trace files are to be saved> --rotation=yes --rotate-file-size=<maximum file size, MB> --rotate-files-count=<maximum number of files>
, enables tracing with overwriting old trace files when the values specified for the size and number of the trace files are reached.The specified limit on the number of files is applied separately for each Kaspersky Endpoint Agent process being debugged, so the total number of files for all processes may exceed the specified value. If you do not specify the
--rotate-file-size
or--rotate-files-count
parameters (one or both) with the--rotation=yes
parameter, the application uses the default values. The default value is 1 file of 50 MB.agent.exe --trace=disable
disables tracing.Tracing will be disabled for all Kaspersky Endpoint Agent processes that are currently running.
agent.exe --trace=show
shows the current tracing status and the path to the folder to save the trace files.The values of the
trace.enable
(true
, if tracing is enabled orfalse
, is tracing is disabled) andtrace.folder
(path to the folder) settings will be displayed.
Return codes of the --trace
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
- 5 – object not found (the specified path to the tracing logs folder is not found).
- 9 – invalid operation (for example, an attempt to execute the
--trace=disable
command, if tracing is already disabled).
Configuring creating a dump of Kaspersky Endpoint Agent processes
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To configure the creation of dump files of Kaspersky Endpoint Agent processes using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter one of the following commands and press ENTER:
agent.exe --dump=enable --folder <path to the folder where you want to create dump files>
enables the creation of dump files of Kaspersky Endpoint Agent processes.Creation of dump files will be enabled for all Kaspersky Endpoint Agent processes that are currently running. Dump files will be created in the folder you specified.
Make sure that the specified folder is available on the managed device. Otherwise, dump files will not be created.
agent.exe --dump=disable
disables dump creation.Creation of dump files will be disabled for all Kaspersky Endpoint Agent processes that are currently running.
agent.exe --dump=show
shows the current dump creation status and the path to the folder with the dump files.The values of the
dump.enable
(true
, if creation of dump files is enabled, orfalse
, if creation of dump files is disabled) anddump.folder
(path to the folder) settings will be displayed.
Return codes of the --dump
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
- 5 – object not found (unable to find the specified path to the dump files folder).
- 9 – invalid operation (for example, an attempt to execute the
--dump=disable
command, if the creation of dumps is already disabled).
Viewing information about quarantine settings and quarantined objects
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To view information about the quarantine settings and quarantined objects using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter one of the following commands and press ENTER:
agent.exe --quarantine=show [--pwd=<current user password>]
shows a list of quarantined objects.
The following information will be displayed for all objects in the Quarantine folder on devices (the Quarantine folder is specified when quarantine settings are configured):
- Identifiers of objects quarantined so far (
ouid
parameter). - Names of quarantined objects (name + extension).
- Date and time when the object was quarantined (UTC).
- Original path to the quarantined file and default path for restoring the quarantined file (without file name).
- Size of quarantined file (in bytes).
- Account of the user whose permissions were used to run the task to quarantine the file.
- Object status:
DETECT
if the file was quarantined by EPP or while performing actions in response to a threat detected by Kaspersky Sandbox. For example, as a result of the Quarantine and delete local action or the Quarantine and delete when IOC is found global action.CUSTOM
if the file was quarantined manually as a result of execution of the--quarantine=add
command.
- The way the file was quarantined:
AUTOMATIC_<name of the application that detected a threat in the quarantined file>
, if the file was quarantined by EPP or as part of the response to a threat detected by Kaspersky Sandbox. For example, as a result of the Quarantine and delete local action or the Quarantine and delete when IOC is found global action.BY USER
if the file was quarantined manually as a result of execution of the--quarantine=add
command.
agent.exe --quarantine=limits
, to view the current values of the Maximum Quarantine size (MB) and Threshold value for space available (MB) settings, as well as the statuses of applying these settings (check box statuses) specified when configuring the quarantine.
Return codes of the --quarantine
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
Actions on quarantined objects
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To perform actions on quarantined objects in Kaspersky Endpoint Agent using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Do the following and press ENTER:
- To permanently delete quarantined objects, execute the following command:
agent.exe --quarantine=delete --ouid=<
comma-separated quarantined object identifiers. Required parameter>
[--pwd=<
current user password>]
.Objects with the specified identifiers will be deleted from the Quarantine folder specified when quarantine settings are configured.
- To restore objects from quarantine, execute the following command:
agent.exe --quarantine=restore --ouid=<
comma-separated quarantined object identifiers. Required parameter> [--path-type=<
one of the destination folder options to restore the objects from quarantine:original
|custom
|settings
. Optional parameter> --path=<
path to the destination folder for restored objects. Required parameter if the--path-type
parameter is passed and theoriginal>] value is specified [--action=<
one of the actions on the object:replace|rename
. Optional parameter>] [--pwd=<
current user password>]
. - To quarantine an object, execute one of the following commands:
agent.exe --quarantine=add [--file=<
full path to the object you want to quarantine>] [--pwd=<
current user password>]
.agent.exe --quarantine=add [--hash=<
hash of the object you want to quarantine. Required parameter. If you do not specify the full path to the object and pass the--hashalg
parameter>]--hashalg=<
one of the hash types:md5|sha256
. Required parameter. If you do not specify the full path to the object> [--file=<
path to the folder with the object that you want to quarantine>] [--pwd=<
current user password>]
.
Command parameters when performing actions on quarantined objects
Parameter
Description
--ouid
Required parameter. The parameter passes a unique numeric (int64) identifier of the quarantined object.
Displayed when viewing information about quarantined objects (command
--quarantine=show
).--path-type=<original
|custom
|settings>
The parameter describes the logic for destination folder selection when restoring objects from quarantine.
- If the parameter is not passed, the object will be restored to the original folder – the folder where the object was located before being quarantined. If the source folder is not available, the object will be restored to the folder specified when configuring quarantine settings.
- If the parameter is passed with the
<original>
value, the object will be restored to the original folder – the folder where the object was located before being quarantined. If the source folder is not available, the object will be restored to the folder specified when configuring quarantine settings. - If the parameter is passed with the
<settings>
value, the object will be restored to the folder specified when quarantine settings were configured. If the folder is not available, the task fails. - If the parameter is passed with the
<custom>
value, the object will be restored to the folder whose path is specified as the value of the--path
parameter. If the folder is not available, the task fails.
--path=<
path to the destination folder for restored objects>
Required parameter if the
--path-type
parameter is passed with the<custom>
value.This parameter defines the path to a folder for objects restored from quarantine if you do not want to use the folder where the object was located before being quarantined or the folder specified when quarantine settings were configured.
--action=<replace|rename>
This parameter defines the action that you want to perform on the object if the destination folder for restored objects already contains a file with the same name as the file you are restoring from quarantine.
- If the parameter is not passed, the restored object will be renamed: the
_restored
suffix will be added to the original object name. - If the parameter is passed with the
<rename>
value, the restored object will be renamed: the_restored
suffix will be added to the original object name. - If the parameter is passed with the
<replace>
value, the original object will be replaced with the restored object.
--file=<
full path to the object you want to quarantine>
A required parameter if the
–-hashalg
parameter is not passed.This parameter defines the full path to the object that you want to quarantine.
--hashalg=<md5|sha256>
A required parameter if the
–-file
parameter is not passed and the full path to the object you want to quarantine is not specified.The parameter defines the hashing algorithm to calculate the checksum of the object you want to quarantine.
The parameter can be passed with one of the following values:
<md5>
or<sha256>
.--hash=<file checksum>
Required parameter if the
–-hashalg
parameter is passed.The parameter defines the checksum of the object you want to quarantine.
--file=<folder that contains the file>
Required parameter if the
–-hashalg
parameter is passed.This parameter specifies the path to the folder that contains the object that you want to quarantine and whose hash is specified as the value of the
–-hash
parameter.--pwd=<
current user password>
Allows you to specify the password of the user whose account is used to execute the command.
- To permanently delete quarantined objects, execute the following command:
Return codes of the --quarantine
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
Managing integration settings with KATA Central Node component
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To manage the integration settings of Kaspersky Endpoint Agent with the KATA Central Node component using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press ENTER:
agent.exe --message-broker=<enable|disable|show> --type=<kata> --use-proxy={yes|no} --compression=<yes|no> --partitioning-strategy=<automatic|user> [--message-key=<
message key> --topic=<
topic> --partition=<user specific partition>] --tls=<yes|no> --servers=<
address>:<
port>[;<
address>:<
port>[; …]] [--timeout=<
maximum response timeout of KATA server] [--pinned-certificate=<
full path to the TLS certificate file>] [--client-certificate=<
full path to the certificate file>] --client-password=<
password for the PFX archive> --sync-period=<
interval for sending synchronization requests>
The
--message-broker
command parameters when managing the integration settings between Kaspersky Endpoint Agent and the KATA Central Node componentParameter
Description
--message-broker=<enable|disable|show>
Required parameter.
Allows you to enable, disable, and view the status of the integration between Kaspersky Endpoint Agent and the KATA Central Node component.
--message-broker=<enable>
– enables integration.--message-broker=<disable>
– disables integration.--message-broker=<show>
– displays the integration status of Kaspersky Endpoint Agent with the KATA Central Node component.
--type=<kata>
Required parameter.
Allows you to specify the KATA Central Node component in order to manage the integration settings of Kaspersky Endpoint Agent with said component.
--use-proxy={yes|no}
Required parameter.
Allows you to enable or disable proxy server usage in the message broker to send messages to KATA.
--compression=<yes|no>
Optional parameter.
Allows you to enable or disable the compression of data transferred between Kaspersky Endpoint Agent and KATA Central Node.
Enabled by default.
---tls=<yes|no>
Optional parameter.
Allows you to enable or disable a trusted connection between Kaspersky Endpoint Agent and the KATA Central Node component.
--tls=<yes>
– enables trusted connection.--tls=<no>
– disables trusted connection.
--servers=<
address>:<
port>[;<
address>:<
port>[; …]]
Required parameter.
Allows the addition of one or more KATA servers.
Kaspersky Endpoint Agent connects to the first server in the list. If the connection does not succeed, Kaspersky Endpoint Agent connects to the second server and so on down the list.
--timeout=<
maximum response timeout of KATA server>
Optional parameter.
Allows you to set the maximum response timeout of the KATA server in milliseconds.
--pinned-certificate=<
full path to the TLS certificate file>
Required parameter, if the
--tls
parameter is passed with the<yes>
value.Allows you to add a TLS certificate for connecting Kaspersky Endpoint Agent to the KATA server.
--client-certificate=<
full path to the certificate file>
Allows you to add a user certificate for connecting Kaspersky Endpoint Agent to the KATA server.
--client-password=
<password for the PFX archive>Allows you to enter a password for the PFX archive that contains the user certificate for connecting Kaspersky Endpoint Agent to the KATA server.
--sync-period=<
interval for sending synchronization requests>
Allows you to specify the time interval for sending synchronization requests for Kaspersky Endpoint Agent settings and tasks with the KATA Central Node.
--throttling=
<yes|no>Allows you to enable or disable request throttling. The request throttling feature allows restricting the flow of events with low importance from Kaspersky Endpoint Agent to the Central Node component.
--event-limit=
<number of events per hour>Allows you to specify the maximum number of events per hour. The application analyzes telemetry data flow and restricts transmission of events with low importance if the number of transmitted events tends to exceed the specified value.
--exceed-limit=
<threshold value>Allows you to specify the threshold for exceeding the limit of events. If the flow of events with low importance of the same type exceeds the threshold percentage of the total number of events, the transmission of events of this type will be restricted. You can specify a value from 5 to 100 (without the
%
character).
Running Kaspersky Endpoint Agent database and module update
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To update the Kaspersky Endpoint Agent application database and modules using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press ENTER:
agent.exe --update=bases|modules [--source=<addresses of custom database update sources separated by semicolons without spaces>|kl|ksc]
Command parameters when running Kaspersky Endpoint Agent database update
Parameter
Description
--update=bases|modules
Required parameter.
Allows you to specify the type of update:
--update=bases
starts the application database update.--update=modules
starts the application module update.
--source=<addresses of custom database update sources>|kl|ksc]
Optional parameter.
Allows you to select a database update source.
--source=<addresses of custom database update sources>
allows you to select the Custom HTTP or FTP servers or network folders option as database update source and specify the path to the network folder or IP, FTP or HTTP-address of the server from which the application downloads database updates.You can specify several addresses of custom database update sources, separated by semicolons without spaces (";"). The application will download updates from the first available database update source. If no addresses are available, the task will fail.
--source=kl
allows you to select the Kaspersky update servers option as database update source.If the servers are not available, the task will fail.
--source=ksc
allows you to select the Kaspersky Security Center Administration Server option as database update source.If the Administration Server is not available, the task will fail.
Return codes of the --update=bases
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
- 8 – permission error.
- 200 – all objects are valid.
- -206 – update files are not available in the specified database update source or have an unknown format.
- -209 – error connecting to the database update source.
- -232 – error connecting to the proxy server.
- -234 – error connecting to Kaspersky Security Center.
- -236 – application databases are corrupted.
Starting, stopping and viewing the current application status
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To start, stop, or view the current Kaspersky Endpoint Agent status using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press ENTER:
agent.exe --product=<start|stop|state> [--pwd=<current user password>]
Command parameters when starting, stopping, and viewing the current state of Kaspersky Endpoint Agent
Parameter
Description
--product=<start|stop|state>
Allows you to start, stop, or view the current application status.
--product=<start>
– starts the application.--product=<stop>
– stops the application.If password protection is configured for the application, a password is required to execute the
--product=<stop>
command.--product=<state>
– displays the current state of the application: started or stopped.
--pwd=<current user password>
Allows you to specify the password of the user whose account is used to execute the command.
Return codes of the --product=<start|stop|state>
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
- 8 – permission error.
- 9 – invalid operation (for example, an attempt to execute the
--product=start
command if the application is already running).
Protecting the application with password
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To restrict Kaspersky Endpoint Agent's operations that might result in a decrease in the protection level of the user's computer and the data processed on that computer, as well as a decrease in the application's self-defense level, it is necessary to password protect the application.
The password is required to execute the following commands in Kaspersky Endpoint Agent command line interface:
--sandbox=disable
--sandbox=show
--sandbox=enable --tls=no
--sandbox=enable --pinned-certificate=<full path to the TLS certificate file for connecting Kaspersky Endpoint Agent to Kaspersky Sandbox>
--quarantine=delete –ouid
--quarantine=show
--quarantine=restore
--quarantine=add
--product=stop
--password=reset
--isolation=disable
--prevention=disable
--selfdefense
--license=delete
--message-broker --type=kata <settings>
--event --action=enable
--event --action=disable
To enter the password, use the --pwd=<current user password>
parameter.
The password is also required when performing the following actions on the application:
- Application uninstallation and remote application uninstallation using Kaspersky Security Center
- Application update (
upgrade
) - Application repair (
repair
) - Operations in the application installation wizard
- Operations in the command line interface
After enabling password protection and applying the Kaspersky Security Center policy, the same password is applied to all devices in the Kaspersky Endpoint Agent managed group.
After disabling password protection in the policy, the password protection settings are retained for the local device and can be edited.
The password is stored in the application settings in encrypted form (as a checksum).
To enter the password, use the --pwd=<current user password>
parameter.
To configure Kaspersky Endpoint Agent password protection using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter one of the following commands and press ENTER:
agent.exe --password=state
to view the current password protection status of the application.agent.exe --password=set --pwd=<current user password> --new=<new user password>
to set a new user password.agent.exe --password=reset --pwd=<current user password>
to reset the user password.
Protecting application services with PPL technology
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
The protection of application services using the Protected Process Light (PPL) technology is implemented in Kaspersky Endpoint Agent.
The protection of application services using the Protected Process Light (PPL) technology is only available on the following operating systems:
- For workstations: Windows 10 version 1703 RS2 and above
- For servers: Windows Server 2016 version 1709 and above
Processes that are running with the PPL flag cannot be stopped or changed by other processes without the PPL flag.
Usage of the PPL flag for the application services allows you to protect the services from malicious external influences and attempts to compromise the application.
To configure protection of application services by the PPL technology using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter one of the following commands and press ENTER:
agent.exe --ppl=show [--pwd=<current user password>]
shows the current status of application services protection by the PPL technology.agent.exe --ppl=disable [--pwd=<current user password>]
disables application services protection by the PPL technology.
Return codes of the --ppl
command:
- 0 – command successfully executed.
- 2 – general error.
- 4 – syntax error.
- 8 – permission error.
Managing self-defense settings
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To manage self-defense settings using the Kaspersky Endpoint Agent command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press ENTER:
agent.exe --selfdefense=<enable|disable>
Managing event filtering
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
To manage event filtering using the Kaspersky Endpoint Agent command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press ENTER:
agent.exe --event =<createprocess|loadimage|registry|network|eventlog|filechange|accountloggon|codeinjection|wmiactivity> --action=<enable|disable|show>
Managing Standard IOC Scan tasks
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
Standard IOC Scan tasks are group or local tasks that are created and configured manually in Kaspersky Security Center or through the command line interface. IOC files prepared by the user are used to run the tasks.
Only the files with IOC rules can be specified for the IOC Scan task. Files with other types of rules are not supported for the IOC Scan task.
To create and configure a Standard IOC Scan task using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Run the following command and press Enter:
agent.exe --scan-ioc {[--path=<
path to the folder with IOC files
>] | [<
full path to the IOC file
>]} [--process=no] [--hint=<
full path to the process executable file
|
full path to the file
>] [--registry=no] [--dnsentry=no] [--arpentry=no] [--ports=no] [–services=no] [--system=no] [--users=no] [--volumes=no] [--eventlog=no] [--datetime=<
event publication date
>] [--channels=<
list of channels
>] [--files=no] [--network=no] [--url=no] [--drives=<all|system|critical|custom>] [--excludes=<
list of exclusions
>][--scope=<
configurable list of folders
>] [--retro]
If the
--scan-ioc
command is passed with only the required parameters, Kaspersky Endpoint Agent will perform the scan with the default settings.If the
--scan-ioc
command is passed together with the two required parameters (--path=<
path to the folder with IOC files
>
and<
full path to the IOC file
>
), Kaspersky Endpoint Agent scans the submitted IOC files.Command parameters for running and configuring Standard IOC Scan tasks
Parameters
Description
--scan-ioc
Required parameter.
Starts the Standard IOC Scan tasks on the device.
--path=<
path to the folder with IOC files
>
Path to the folder with the IOC files that you want to scan.
Required parameter if the
<
full path to the IOC file
>
parameter is not specified.<
full path to the IOC file>
Full path to the IOC file, with ioc or xml extension, that you want to scan.
A required parameter if the
--path=<
path to the folder with IOC files
>
parameter is not specified.Passed without the
--path
argument.--process=<no>
Optional parameter.
This parameter disables the analysis of process data during scans.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent does not consider the processes running on the device during scanning. If the IOC file contains IOC terms of the ProcessItem IOC document, they are ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scan the process data if the ProcessItem IOC document is described in the IOC file submitted for scanning.
--hint=<
full path to the process executable file
|
full path to the file
>
Optional parameter.
This parameter allows you to narrow the scope of data analyzed while checking the ProcessItem and FileItem IOC documents by specifying a particular file.
The parameter value can be set as:
<
full path to the executable file of the process
>
– ProcessItem<
full path to the file
>
– FileItemThis parameter can only be passed together with the
--process=yes
and--files=yes
arguments.
--dnsentry=no
Optional parameter.
This parameter disables the analysis of data on records in the local DNS cache (DnsEntryItem IOC document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not scan the local DNS cache. If the IOC file contains the terms of the DnsEntryItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scan the local DNS cache if the DnsEntryItem IOC document is described in the IOC file submitted for scanning.
--arpentry=no
Optional parameter.
This parameter disables the analysis of data in ARP table (ArpEntryItem document) records during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not scan the ARP table. If the IOC file contains the terms of the ArpEntryItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scan the ARP table if the ArpEntryItem IOC document is described in the IOC file submitted for scan.
--ports=no
Optional parameter.
This parameter disables the analysis of data on ports that are open for listening (PortItem document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not scan the table of active connections on the device. If the IOC file contains the terms of the PortItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scan the table of active connections if the PortItem IOC document is described in the IOC file submitted for scanning.
--services=no
Optional parameter.
This parameter disables the analysis of data on services installed on the device (ServiceItem document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not scan data on services installed on the device. If the IOC file contains the terms of the ServiceItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scans the data on services if the ServiceItem IOC document is described in the IOC file submitted for scanning.
--volumes=no
Optional parameter.
This parameter disables the analysis of volume data (VolumeItem document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not scan volume data on the device. If the IOC file contains the terms of the VolumeItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scan the data on volumes if the VolumeItem IOC document is described in the IOC file submitted for scanning.
--eventlog=no
Optional parameter.
This parameter disables the analysis of data about Windows Event Log entries (EventLogItem document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not scan Windows Event Log entries. If the IOC file contains the terms of the EventLogItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only scan Windows Event Log entries if the EventLogItem IOC document is described in the IOC file submitted for scanning.
--datetime=<
event publication date
>
Optional parameter.
This parameter allows you to enable or disable accounting for the date and time when the event was registered in the Windows Event Log when determining the IOC scan area for the corresponding IOC document.
During IOC scanning, Kaspersky Endpoint Agent will only process events that were registered within the time interval between the specified date and time and the task execution time.
Kaspersky Endpoint Agent allows you to specify the event registration date as the parameter value. Scans will be performed only for events registered in the Windows Event Log between the specified date and the time when the IOC scan is performed.
If the parameter is not passed, Kaspersky Endpoint Agent will scan events with any registration date. The TaskSettings::BaseSettings::EventLogItem::datetime parameter cannot be changed.
This parameter is only used if the EventLogItem IOC document is described in the IOC file submitted for scanning.
--channel=<
list of channels
>
Optional parameter.
This parameter allows you to pass a list of the names of channels (logs) for which IOC scanning is required.
If this parameter is passed, Kaspersky Endpoint Agent will only consider events published in the specified logs when performing the IOC Scan task.
The name of the log is specified as a string based on the name of the log (channel) specified in the properties of this log (the Full Name parameter) or in the properties of the event (the <Channel></Channel> parameter in the xml-scheme of the event).
By default (including in the case that the parameter is not passed), IOC scanning is performed for the Application, System, and Security channels.
Several values, separated by spaces, can be passed to the parameter.
This parameter is only used if the EventLogItem IOC document is described in the IOC submitted for scanning.
--system=no
Optional parameter.
This parameter disables the analysis of environmental data (SystemInfoItem IOC document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not analyze environmental data. If the IOC file contains the terms of the SystemInfoItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only analyze environmental data if the SystemInfoItem IOC document is described in the IOC file submitted for scanning.
--users=no
Optional parameter.
This parameter disables the analysis of user data (UserItem IOC document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not analyze the data on users created in the system. If the IOC file contains the terms of the UserItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only analyze data on users created in the system if the UserItem IOC document is described in the IOC file submitted for scanning.
--files=no
Optional parameter.
This parameter disables the analysis of data on files (FileItem IOC document) during IOC scanning.
If the parameter is passed with the
<no>
value, Kaspersky Endpoint Agent will not analyze data on files. If the IOC file contains the terms of the FileItem IOC document, they will be ignored (defined as no match).If the parameter is not passed, Kaspersky Endpoint Agent will only analyze data on files if the FileItem IOC document is described in the IOC file submitted for scanning.
--network=no
Optional parameter.
This parameter enables threat lookup based on the Network IOC document during IOC scanning.
If the <no> value is set for the parameter, Kaspersky Endpoint Agent does not perform threat lookup based on the Network IOC document. If the IOC file contains the terms of the Network IOC document, they will be ignored (defined as no match).
If the parameter is not passed, Kaspersky Endpoint Agent only enables threat lookup based on the Network IOC document if the Network IOC document is described in the IOC file submitted for scanning.
--url=no
Optional parameter.
This parameter enables threat lookup based on the UrlHistoryItem IOC document during IOC Scanning.
If the <no> value is set for the parameter, Kaspersky Endpoint Agent will not perform threat lookup based on the UrlHistoryItem IOC document. If the IOC file contains the terms of the UrlHistoryItem IOC document, they will be ignored (defined as no match).
If the parameter is not passed, Kaspersky Endpoint Agent will only enable threat lookup based on the UrlHistoryItem IOC document if the UrlHistoryItem IOC document is described in the IOC file submitted for scanning.
--drives=<all|system|critical|custom>
Optional parameter.
This parameter allows you to specify the scope of the IOC scan when analyzing data for the FileItem IOC document.
This parameter can have one of the following values:
<all>
– the application scans all available file areas.<system>
– the application only scans files that are located in the folders where the operating system is installed.<critical>
– the application only scans temporary files that are located in user and system folders.<custom>
– the application only scans files that are located in the areas specified by the user.If the parameter is not passed, critical areas will be scanned.
--Excludes=<
list of exclusions
>
Optional parameter.
This parameter allows you to specify exclusion scopes when analyzing data for the FileItem IOC document. Several values separated by space can be passed by the parameter.
If the parameter is not passed, all folders will be scanned, with no exclusions.
--scope=<
configurable list of folders
>
Optional parameter.
This parameter becomes required if the
--drives=custom
parameter is passed.This parameter allows you to specify a list of scan areas. Several values separated by space can be passed by the parameter.
--retro
Optional parameter.
The parameter is used to start the task in the Retrospective IOC scan mode.
In addition to this parameter, you can specify the time interval within which the application will perform a retrospective IOC scan using the following parameters:
--start-time=<
interval start date and time
>
--end-time=<
interval end date and time
>
Example:
agent.exe --scan-ioc --path=<path to the folder with IOC files> --retro --start-time=2021-05-21T10:30:00Z --end-time=2021-05-24T10:30:00Z
If the time interval is not specified, the default interval will be used, starting one day before the task was started and ending at the moment the task was launched.
Return codes of the --scan-ioc
command:
-1
– command is not supported by Kaspersky Endpoint Agent version installed on the device.0
– command successfully executed.1
– required argument is not passed to the command.2
– general error.4
– syntax error.
If the command was executed successfully (code 0
) and indicators of compromise were detected during the command execution, Kaspersky Endpoint Agent displays the following data on the task execution results in the command line:
Data displayed by the application in the command line when an IOC is detected
|
IOC file identifier from the header of the IOC file structure ( |
|
IOC file description from the header of the IOC file structure ( |
|
The list of identifiers of all triggered indicators. |
|
Data on each IOC document where a match was detected. |
|
Creation date of the file where indicators of compromise were detected. |
|
Only for FileItem. Creation time of the object where indicators of compromise were detected. |
|
Identifier of the process for which indicators of compromise were detected. |
|
Unique identifier of the process for which indicators of compromise were detected. |
|
Identifier of the parent object that contains the process for which indicators of compromise were detected. |
|
Name of the user who made changes to the object being scanned. |
|
Start time of the process for which indicators of compromise were detected. |
Managing scanning of files and processes according to YARA rules
This Help provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
YARA scanning is a process that you can create and configure manually using the command line interface.
are used to run the scan.Only the files with YARA rules can be specified for the YARA Scan task. Files with other types of rules are not supported for the YARA Scan task.
To run a YARA scan using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the cd command, navigate to the folder where the Agent.exe file is located.
For example, you can type the following command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press Enter. - Run the following command and press Enter:
agent.exe --scan-yara [<
path to the YARA file
>] [--path=<
path to the folder with YARA rules
>] [--fast-scan] [--tag-hint=<
tag rule
>] [--id-hint=<
rule ID
>] [--max-rules=<
maximum number of scan rules
>] [--timeout=<
stop scan after the specified time in seconds
>] [--recursive] [--scan_folders [<
list of folders to be scanned
>] [--scan-memory] [--scan-process <
process name
>][--max-size=<
file size in bytes
>] [--excludes <
list of objects to be scanned
>] [--includes <
list of objects to be scanned
>]
If the
--scan-yara
command is passed with only the required parameters, Kaspersky Endpoint Agent will perform the scan with the default settings.
The scan parameters are described in the following table.
Command parameters when starting and configuring YARA scan
Parameters |
Description |
|
Required parameter. Starts a YARA scan on the device. The scan is performed according to the rules in the YARA files with the yara or yar extension. |
|
Path to the folder with the YARA files that you want to scan. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
Optional parameter. |
|
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
Optional parameter.
|
|
Optional parameter.
|
Return codes of the --scan-yara
command:
-1
– command is not supported by Kaspersky Endpoint Agent version installed on the device.0
– command successfully executed.1
– required argument is not passed to the command.2
– general error.4
– syntax error.5
– one or more files with YARA rules specified as the parameter value not found.
If the command execution completed successfully (code 0
) and indicators of compromise were detected during the command execution, Kaspersky Endpoint Agent displays the scan results in the command line. The scan results are described in the following table:
Data displayed by the application in the command line when YARA signatures are detected.
|
Offset in the object scanned by Kaspersky Endpoint Agent. |
|
Signatures searched by Kaspersky Endpoint Agent during scanning. |
|
The name of the scanned object. |
|
The name of the rule used during scan. |
Managing scanning of autorun point objects according to YARA rules
This Help provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
YARA scanning of the
is a process that you can create and configure manually using the command line interface. YARA files are used to run the scan.Only files with YARA rules can be specified in the YARA Scan task for autorun point objects. Files with other types of rules are not supported for the YARA Scan task.
By default, scanning of objects according to YARA rules is performed for the following types of autorun points:
- Logon
- Run
- Explorer
- Shell
- Office
- Internet Explorer
- Tasks
- Services
- Drivers
- Telephony
- Cryptography
- Debuggers
- COM
- Session Manager
- Network
- LSA
- Applications
- Codecs
- Shellex
- Unspecified
To run a YARA scan of autorun points using the command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, you can type the following command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press Enter. - Run the following command and press Enter:
agent.exe --scan-yara [<
path to the YARA file
>] [--path=<
path to the file with the YARA rules
>] --scan-autoruns=yes [--fast-scan] [--tag-hint=<
rule tag
>] [--id-hint=<
rule ID
>] [--max-rules=<
maximum number of scan rules
>] [--timeout=<
stop scan after the specified time in seconds
>] [--max-size=<
file size in bytes
>] [--exclude-autoruns=COM]
If the
--scan-yara
--scan-autoruns
command is passed with only the required parameters, Kaspersky Endpoint Agent performs a scan with the default settings.
The scan parameters are described in the following table.
Command parameters when starting and configuring YARA scan
Parameters |
Description |
|
Required parameter. Starts a YARA scan for the autorun point files on the device. The scan is performed according to the rules in YARA files with the yara or yar extension. |
|
Path to the folder with the YARA files that you want to use to search for autorun point files. |
|
Required parameter. This parameter accesses autorun points and scans objects for all types of autorun points according to the specified YARA rules. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. |
|
Optional parameter. The resulting lists of autorun points for COM objects may not contain component builds developed using .NET due to the special aspects of their registration in the system. |
Return codes of the --scan-yara
command:
-1
– command is not supported by Kaspersky Endpoint Agent version installed on the device.0
– command successfully executed.1
– required argument is not passed to the command.2
– general error.4
– syntax error.5
– one or more files with YARA rules specified as the parameter value not found.
If the command execution completed successfully (code 0
) and indicators of compromise were detected during the command execution, Kaspersky Endpoint Agent displays the scan results in the command line. The scan results are described in the following table:
Data displayed by the application in the command line when YARA signatures are detected.
|
Offset in the object scanned by Kaspersky Endpoint Agent. |
|
Signatures searched by Kaspersky Endpoint Agent during scanning. |
|
The name of the scanned object. |
|
The name of the rule used during scan. |
Creating a memory dump
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can create a memory dump for the computer on which Kaspersky Endpoint Agent is installed.
Before creating the memory dump, we recommend terminating processes of critical applications. After creating the memory dump, we recommend restarting the computer for which the memory dump was created.
To create a memory dump using the Kaspersky Endpoint Agent command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER. - Enter the command:
agent.exe --memory-dump --path=<
path to local or network folder where you want to save the memory dump
> [--user=<
user name
> --pwd=<
password
>]
.The user name and password are required if a folder for storing the memory dump is password protected.
Be sure that write access is granted for the folder where the memory dump will be stored. Otherwise, dump file will not be created.
- Press ENTER.
In the specified folder, Kaspersky Endpoint Agent creates a memory dump with the name MemoryDump_<host name>_<date and time when the file began to be written>.dmp.
Command parameters for creating a memory dump
Parameter
Description
--path
Required parameter. This parameter passes the full path to the local or network folder where the application will store the memory dump.
The name of a network folder must be in UNC format.
--user
This parameter passes the user name for accessing the folder specified by the
--path
parameter.If this parameter is missing, the SYSTEM account must have access to the folder.
--pwd
This parameter passes the password for accessing the folder specified by the
--path
parameter.If this parameter is missing, the SYSTEM account must have access to the folder.
Return codes of the --memory-dump
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
Kaspersky Endpoint Agent does not encrypt or compress the memory dump file. If necessary, you can use third-party tools to encrypt and compress of the folder where the memory dump is stored.
The SMB 3 (or higher) protocol must be configured in order for Kaspersky Endpoint Agent to save the memory dump file to the folder in encrypted form.
Page topCreating a disk dump
This section provides information related to Kaspersky Endpoint Agent for Windows. This information may be partially or completely inapplicable to Kaspersky Endpoint Agent for Linux. For complete information about Kaspersky Endpoint Agent for Linux, please refer to the Help of the solution that includes the application: Kaspersky Anti Targeted Attack Platform or Kaspersky Managed Detection and Response.
You can create a dump of a physical or logical disk of the computer on which Kaspersky Endpoint Agent is installed.
To create a disk dump using the Kaspersky Endpoint Agent command line interface:
- On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
- Using the
cd
command, navigate to the folder where the Agent.exe file is located.For example, enter the command
cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER.Enter the command:
agent.exe --disk-image --volume=<
disk name
> [--format=<
file format, RAW or EWF
>] [--max-size=<
size in bytes
>] [--segment-size=<
size in bytes
>] --path=<
path to a local or network folder where you want to save the disk dump
> [--user=<
user name
> --pwd=<
password
>]
The user name and password are required if the folder for storing the disk dump is password protected.
Be sure that write access is granted for the folder where the disk dump will be stored. Otherwise, dump file will not be created.
- Press ENTER.
In the specified folder, Kaspersky Endpoint Agent creates a disk dump file with a name in the format <disk name>_<date and time when the file started to be written>.<extension>.
The disk dump file extension may be the following:
- If the RAW format was specified in the command to create the disk dump (
--format=RAW
):- if the disk dump is not split (the
--segment-size
parameter is omitted), then the disk dump file has the raw extension; - If the disk dump is split (the
--segment-size
parameter is specified), then the parts of the dump have the extensions 001, 002, 003, etc. up to 999.
- if the disk dump is not split (the
- If the EWF format was specified in the command to create the disk dump (
--format=EWF
):- If the disk dump is not split (the
--segment-size
parameter is omitted), then the disk dump file has the extension E01; - If the disk dump is split (the
--segment-size
parameter is specified), then the parts of the dump have the extension E01, E02, ..., E99; EAA, EAB, ..., EAZ; FAA, FAB, ..., FZZ, <...>; ZAA, ZAB, ..., ZZZ.
- If the disk dump is not split (the
Command parameters for creating a disk dump
Parameter
Description
--volume
Required parameter. This parameter passes the number of a physical disk or the name of a logical disk, where the dump will be created.
The format for the physical disk number is: \??\PHYSICALDRIVEN or PHYSICALDRIVEN, where N is the disk number. For example: \??\PHYSICALDRIVE0, PHYSICALDRIVE1.
Format of the name of the logical disk: N:, where N is the letter designation of the logical disk. For example, С:.
If you create a dump file for a logical disk used to boot the operating system, use the %SystemDrive% variable as the disk name.
--format
This parameter passes the format for the file with the disk dump. Possible values: RAW or EWF.
If the parameter is omitted, the application creates a disk dump in the RAW format.
--max-size
This parameter passes the maximum allowed size of the disk dump in bytes.
If this parameter is omitted, the application creates a disk dump with a maximum size of 1,099,511,627,776 bytes.
--segment-size
This parameter passes the maximum size of part of the disk dump in bytes. Additionally, the minimum size of part of the dump must be larger than 33,554,432 bytes.
If the parameter is specified, the application splits the disk dump into parts of the specified size and adds them to an archive. The size of the archived dump parts is less than the value specified using the parameter.
If the parameter is omitted, the application does not split the disk dump into parts.
--path
Required parameter. This parameter passes the full path to the local or network folder where the application stores the disk dump.
The name of a network folder must be in UNC format.
--user
This parameter passes the user name for accessing the folder specified by the
--path
parameter.If the parameter is omitted, the SYSTEM access must have access to the folder where the disk dump will be stored.
--pwd
This parameter passes the password for accessing the folder specified by the
--path
parameter.If the parameter is omitted, the SYSTEM access must have access to the folder where the disk dump will be stored.
- If the RAW format was specified in the command to create the disk dump (
Return codes of the --memory-dump
command:
- -1 – command is not supported.
- 0 – command successfully executed.
- 1 – required argument is not passed to the command.
- 2 – general error.
- 4 – syntax error.
Kaspersky Endpoint Agent does not encrypt or compress the memory dump file. If necessary, you can use third-party tools to encrypt and compress of the folder where the memory dump is stored.
The SMB 3 (or higher) protocol must be configured in order for Kaspersky Endpoint Agent to save the memory dump file to the folder in encrypted form.
Page top