Task management in the command line

The following application tasks are provided for managing Kaspersky Embedded Systems Security using the command line:

• File Threat Protection. This task allows you to enable or disable File Threat Protection in real time and defines the settings for the File Threat Protection component. The task starts automatically when the application starts.
• Malware Scan. This task allows you to scan file system objects for malware on demand and defines the settings for the scan. You can use this task to perform a full or custom scan of the device.
• Critical Areas Scan. This task allows you to run a critical areas scan of the operating system on demand and defines the settings for the scan.
• Custom file scan. This task is designed for configuring and storing settings that are used when scanning the specified files and directories using the kess-control --scan-file command. As a result of the command execution, the application creates and starts a temporary file scan task.
• Removable Drives Scan. This task allows you to monitor the connection of removable media to the device in real time and defines the settings of the Removable Drives Scan and the scan of its boot sectors for malware.
• Web Threat Protection. This task allows you to enable or disable Web Threat Protection and defines the settings for the Web Threat Protection component.
• Network Threat Protection. This task allows you to enable or disable Network Threat Protection and defines the settings for the Network Threat Protection component.
• Anti-Cryptor. This task allows you to enable or disable the protection of files from remote malicious encryption and defines the settings for the Anti-Cryptor component.
• Firewall Management. This task allows you to enable or disable firewall management and defines the network connection control settings on the device.
• Application Control. This task allows you to enable or disable Application Control and defines the settings of the Application Control component.
• Inventory. The task allows you to obtain information about all the application executable files stored on the device.
• Device Control. This task allows you to enable or disable Device Control and defines the settings for the Device Control component. The task starts automatically when Kaspersky Embedded Systems Security starts.
• Behavior Detection. This task allows you to monitor malicious activity of applications in the operating system. The task starts automatically when Kaspersky Embedded Systems Security starts.
• System Integrity Monitoring. This task allows you to perform real-time monitoring of the actions performed with objects from the monitoring scope specified in the System Integrity Monitoring component settings.
• System Integrity Check. This task allows you to check for changes in files and directories that you have included in the monitoring scope, by comparing the current state of the monitored object with a previously recorded state.
• Licensing. This task provides the capability to activate an application installed on the device. The task starts automatically when the application starts, and it resides in the device operating memory. The task has no settings; license keys are managed using special management commands. The task cannot be started, stopped, or deleted.
• Update. You can use this task to perform scheduled and on-demand application database and module updates and edit update settings.
• Rollback. You can use this task to roll back the last update of application databases and modules.

Each application task has a name used on the command line, an ID, and a type (see the table below).

IDs are unique for all tasks, including deleted tasks. The application does not reuse the identifiers of the deleted tasks. The identifier of a new task is the next successive number to the identifier of the latest created task.

Task names are not case-sensitive.

During installation of the application, predefined tasks are created. These tasks cannot be deleted. Each predefined task has a name and ID.

Tasks that you create while working with the application are called user tasks. When you create the task, you specify the name for it. IDs for user tasks are defined and assigned by the application when the task is created. IDs for user tasks are starting from 100.

During operation, the application creates temporary scan tasks. Temporary task names and IDs are assigned by the application. Temporary tasks are automatically deleted when completed.

Application tasks

You can perform the following actions with tasks:

• Start and stop all predefined and user tasks except the License task.
• Suspend and resume ODS, ODFIM, and InventoryScan tasks.
• Create and delete user tasks. You can create the following types of tasks: ODS, Update, Rollback, ODFIM and InventoryScan.
• Change the settings for all user tasks and all predefined tasks, except for Rollback and License tasks.
• Configure the task start schedule.

Viewing a list of tasks in the command line

To view the list of application tasks, execute the following command:

kess-control --get-task-list [--json]

where:

--json – output format for the list of application tasks. If a file format is not specified, the output will be an INI file.

The list of Kaspersky Embedded Systems Security tasks will be displayed.

The following information will be displayed for each task:

• Name: the task name
• ID: the task ID
• Type: the task type
• State: the current state of the task

If the Kaspersky Security Center policy prohibits users from viewing and editing local tasks, information about the Scan_My_Computer, Critical_Areas_Scan, Inventory_Scan, Update, and Rollback tasks is not available.

Page top

Viewing the status of a task in the command line

To view a task state, execute the following command:

kess-control --get-task-state <task ID/name> [--json]

where:

• <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.
• --json is specified to output the settings in JSON format.

Application tasks can take the following main states:

• Started—Task is running.
• Starting—Task is being launched.
• Stopped—Task has been stopped.
• Stopping—Task is stopping.

The ODS, ODFIM, and InventoryScan tasks can also have one of the following states:

• Pausing — Task is pausing.
• Suspended — Task is suspended.
• Resuming — Task is resuming.

Page top

Creating a task in the command line

You can create the following types of tasks: ODS, Update, Rollback, ODFIM, and InventoryScan.

You can create tasks with default settings or with settings specified in a configuration file.

To create a task with default settings, execute the following command:

kess-control -create-task <task name> --type <task name>

where:

• <task name> is the name that you specify for the new task.
• <task type> is the identifier for the type of the created task.

To create a task with the settings specified in the configuration file, execute the following command:

kess-control --create-task <task name> --type <task type> --file <configuration file path> [--json]

where:

• <task name> is the name that you specify for the new task.
• <task type> is the identifier for the type of the created task.
• <path to file> is the full path to the configuration file with the settings that will be used for creating the task.
• --json is specified to import the settings from the configuration file in JSON format. If the --json option is not specified, the application attempts to import from an INI file. If the import fails, an error is displayed.

Page top

Starting, stopping, pausing, and resuming tasks in the command line

You can start and stop predefined and user tasks, except for tasks of the License type.

You can suspend and resume tasks of ODS, ODFIM, and InventoryScan types.

To start a task, execute the following command:

kess-control --start-task <task ID/name> [-W] [--progress]

where:

• <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.
• [-W] is a command used in conjunction with the task start command to enable the display of current events associated with this task.
• Specify the [--progress] option if you want to display the progress of the task.

  Example: Start the task with ID 1 and enable the display of current events associated with the task: kess-control --start-task 1 -W

If an error occurs when starting a task and the task does not start, then after the application is restarted, an attempt is made to start the task again.

To stop a task, execute the following command:

kess-control --stop-task <task ID/name> [-W]

where:

• <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.
• [-W] is a command used in conjunction with the stop task command to enable the display of current events associated with this task.

To suspend a task, execute the following command:

kess-control --suspend-task <task ID/name>

To resume a task, execute the following command:

kess-control --resume-task <task ID/name>

Page top

Deleting a task in the command line

You can delete only user tasks. Predefined tasks cannot be deleted.

To delete a task, execute the following command:

kess-control --delete-task <task ID/name>

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