Managing Kaspersky Endpoint Agent through command line interface

Kaspersky Endpoint Agent can be managed through 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 Kaspersky Endpoint Agent distribution kit and is installed on each device together with Kaspersky Endpoint Agent. It is installed to the %ProgramFiles%\Kaspersky Lab\Endpoint Agent folder (if 32-bit operating system is used on the device) or to the % ProgramFiles(x86)%\Kaspersky Lab\Endpoint Agent folder (if 64-bit operating system is used on the device).

Example: If the device has x64 Windows operating system installed and you select to install Kaspersky Endpoint Agent on drive C, the Agent.exe utility is placed to the following folder: C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\

To manage Kaspersky Endpoint Agent through 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, you can type the following 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) is displayed.

You can manage the following Kaspersky Endpoint Agent settings:

• help

  Displays help information on the application settings and their possible values.

• trace

  Allows you to configure tracing in Kaspersky Endpoint Agent.

  Available actions: enable, disable, show.

• dump

  Allows you to configure creation of dump files in Kaspersky Endpoint Agent.

  Available actions: enable, disable, show.

• quarantine

  Allows you to work with quarantine in Kaspersky Endpoint Agent.

  Available actions: add, delete, restore, show, limits.

• sandbox

  Allows you to manage Kaspersky Endpoint Agent integration with Kaspersky Sandbox.

  Available actions: enable, disable, show.

• update

  Allows you to manage Kaspersky Endpoint Agent database updates.

  Available actions: bases, modules.

• ppl

  Allows you to manage Kaspersky Endpoint Agent processes that are run with the PPL flag (these processes are protected by the Protected Process Light technology).

  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.

  Available actions: enable, disable, show.

• password

  Allows you to manage password protection of Kaspersky Endpoint Agent.

  Available actions: set, reset, state.

• product

  Allows you to manage Kaspersky Endpoint Agent.

  Available actions: start, stop, state.

  Example: To display help on all the application settings and their possible values, run the following command: agent.exe --help To enable integration with Kaspersky Sandbox, run the following command: agent.exe --sandbox=enable

See also Installing and uninstalling Kaspersky Endpoint Agent Kaspersky Endpoint Agent activation Managing Kaspersky Endpoint Agent using Kaspersky Security Center Administration Console

In this Help section Managing Kaspersky Endpoint Agent activation Configuring tracing Configuring creation of dump files Viewing information about quarantine settings and quarantined objects Actions on quarantined objects Managing Kaspersky Sandbox integration settings 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 network isolation Managing Standard IOC Scan tasks

Page top