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:

C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\

To manage Kaspersky Endpoint Agent using the command line interface:

  1. On the device, run a command line interpreter (for example, Command Prompt cmd.exe) with the permissions of the local administrator.
  2. 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.

  3. 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

In this Help section

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

Page top