Kaspersky Endpoint Security 12 for Linux

Commands for managing task settings

July 22, 2024

ID 264318

kesl-control --get-settings

This command outputs the current settings for a specified task to the console or a configuration file.

Command syntax

kesl-control [-T] --get-settings <task ID/name> [--file <configuration file path>] [--json]

Arguments and keys

<task ID/name> is the ID assigned to the task at the time of its creation, or the name of the task in the command line.

--file <configuration file path> – path to the configuration file into which the task settings will be written. If you do not specify the --file option, settings will be output to the console.

If you specify the name of a file without its path, the file will be created in the current directory. If a file already exists in the specified path, it will be overwritten. If the specified directory does not exist, no configuration file will be generated.

--json is specified to output the settings in JSON format. If the --json key is not specified, the settings will be imported in the INI format.

kesl-control --set-settings

This command defines the settings for a specified task via command options or by importing settings from a configuration file.

Command syntax

Define settings via command options:

kesl-control [-T] --set-settings <task name/ID> <option name>=<option value> [<option name>=<option value>] [--add-path <path>] [--del-path <path>] [--add-exclusion <path>] [--del-exclusion <path>]

Define settings via a configuration file:

kesl-control [-T] --set-settings <task name/ID> --file <configuration file path> [--json]

Arguments and keys

<task ID/name> is the ID assigned to the task at the time of its creation, or the name of the task in the command line.

<setting name>=<setting value> is the name and value of one of the task settings.

--add-path <path> adds the path to the directory with the objects to be scanned.

--del-path <path> deletes the path to the directory with the objects to be scanned.

--add-exclusion <path>: add the path to the directory with objects to exclude from scanning.

--del-exclusion <path> deletes the path to the directory with the objects to be excluded.

--file <configuration file path> – full path to the configuration file from which the task settings will be imported.

--json is specified to import the settings from the configuration file in JSON format. If the --json key is not specified, the application attempts to import from an INI file. If the import fails, an error is displayed.

kesl-control --set-to-default

The command restores the default settings for the specified task.

Command syntax

kesl-control [-T] --set-settings <task ID/name> --set-to-default

Arguments and keys

<task ID/name> is the ID assigned to the task at the time of its creation, or the name of the task in the command line.

The kesl-control --get-schedule command

The command outputs the current schedule of the specified task to the console or a configuration file.

Command syntax

kesl-control [-T] --get-schedule <task ID/name> [--file <configuration file path>] [--json]

Arguments and keys

<task ID/name> is the ID assigned to the task at the time of its creation, or the name of the task in the command line.

--file <path to configuration file> is the path to the configuration file in which the settings for the task run schedule will be output. If you do not specify the --file option, settings will be output to the console.

If you specify the name of a file without its path, the file will be created in the current directory. If a file already exists in the specified path, it will be overwritten. If the specified directory does not exist, no configuration file will be generated.

--json is specified to output the settings in JSON format. If the --json key is not specified, the settings will be imported in the INI format.

The kesl-control --set-schedule command

The command defines a schedule for the specified task via command options or by importing settings from a configuration file.

Command syntax

Define settings via command options:

kesl-control [-T] --set-schedule <task ID/name> <option name>=<option value> [<option name>=<option value>]

Define settings via a configuration file:

kesl-control [-T] --set-schedule <task ID/name> --file <configuration file path> [--json]

Arguments and keys

<task ID/name> is the ID assigned to the task at the time of its creation, or the name of the task in the command line.

<setting name>=<setting value> is the name and value of one of the settings for the task schedule.

--file <configuration file path> – full path to the configuration file from which the task schedule settings will be imported.

--json is specified to import the settings from the configuration file in JSON format. If the --json key is not specified, the application attempts to import from an INI file. If the import fails, an error is displayed.

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.