Managing the Kaspersky Endpoint Agent application using the command line interface

You can manage Kaspersky Endpoint Agent using the command line interface. The command line interface functionality is provided by the agent.exe utility. The agent.exe utility is part of the Kaspersky Endpoint Agent distribution kit and is installed onto each workstation with Kaspersky Endpoint Agent in the %ProgramFiles%\Kaspersky Lab\Endpoint Agent directory (if a 32-bit operating system is installed on the workstation) or %ProgramFiles (x86)%\Kaspersky Lab\Endpoint Agent (if a 64-bit operating system is installed on the workstation).

Example: If the workstation has the 64-bit Windows 7 operating system installed and the Kaspersky Endpoint Agent application is installed on drive C, the agent.exe is located in the following directory: C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\

To manage Kaspersky Endpoint Agent using the command line interface:

1. On the workstation, run the command line interpreter (for example, Command Prompt cmd.exe) under the local administrator user account.
2. Use the cd command to change to the directory where the agent.exe file is located.

   For example, you can type cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\" and press ENTER.

3. Type the command: agent.exe --<application option that you want to configure>=<action on the option that you want to perform> and press ENTER.

   The execution result (return code) of the command is displayed.

You can manage the following options of Kaspersky Endpoint Agent:

• help

  Displays help information about all options of the application and possible values.

• trace

  Allows configuring trace in the Kaspersky Endpoint Agent application.

  Available actions: enable, disable, show.

• dump

  Allows configuring dump creation in the Kaspersky Endpoint Agent application.

  Available actions: enable, disable, show.

• quarantine

  Allows to work with the Quarantine of Kaspersky Endpoint Agent.

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

• sandbox

  Allows managing the integration of Kaspersky Endpoint Agent with Kaspersky Sandbox.

  Available actions: enable, disable, show.

• update

  Allows managing Kaspersky Endpoint Agent database updates.

  Available actions: bases, modules.

• ppl

  Allows managing processes of Kaspersky Endpoint Agent that are run with the PPL flag (processes are protected by the Protected Process Light (PPL) technology).

  Processes that are run with the PPL flag cannot be stopped or modified by other processes that do not have the PPL attribute.

  Using the PPL flag for application services lets us secure the services from outside malicious activity or attempts to compromise the application.

  Available actions: enable, disable, show.

• password

  Allows managing the password protection of the Kaspersky Endpoint Agent application.

  Available actions: set, reset, state.

• product

  Allows managing the Kaspersky Endpoint Agent application.

  Available actions: start, stop, state.

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

See also Installing Kaspersky Endpoint Agent Installing the Kaspersky Endpoint Agent management plug-in Creating a Kaspersky Endpoint Agent policy Enabling settings in the Kaspersky Endpoint Agent policy Configuring Kaspersky Endpoint Agent security settings Configuring proxy server connection settings Configuring the usage of Kaspersky Security Network Configuring the integration of Kaspersky Endpoint Agent with Kaspersky Sandbox Configuring Threat Response actions of Kaspersky Endpoint Agent to respond to threats detected by Kaspersky Sandbox Configuring Quarantine settings and restoration of objects from Quarantine Configuring data synchronization with the Administration Server Managing Kaspersky Endpoint Agent tasks

In this Help section Configuring tracing Configuring dump creation Viewing information about Quarantine options and quarantined objects Actions with quarantined objects Managing Kaspersky Sandbox integration options Running Kaspersky Endpoint Agent database update Running, stopping, and viewing the current state of the application Password protecting the application Securing services of the application using the PPL technology

Page top