File Threat Protection task settings
The File Threat Protection task is running by default with the settings listed in Appendix 3. You can stop or start the task at any time. You can also modify task settings.
You must modify the settings of a task before starting the task.
To configure the task schedule using a configuration file:
- Output the task settings to the configuration file:
kfl-control --get-schedule - Edit the values of the necessary settings in the configuration file and save the changes.
- Execute the command:
kfl-control --set-schedule 1 --file <configuration file path> [--json]
All values of the settings for the task run schedule defined in the file will be imported into the application.
To modify individual task schedule settings on the command line:
kfl-control --set-schedule 1 <setting name>=<setting value> [<setting name>=<setting value>]
The values of the specified settings for the task run schedule are modified.
To stop the File Threat Protection task and enable the output of current events related to this task, run the following command:
kfl-control --stop-task 1 -W
To start the File Threat Protection task, enable the output of current events related to this task, and display the progress of the task, run the following command:
kfl-control --start-task 1 [-W] [--progress]
The File Threat Protection task is started with default settings.
You can display the current values of the task settings in one of the following ways:
- To the console using the task settings output command:
kfl-control --get-settings 1 [--json] - To a configuration file using the task settings output command:
kfl-control --get-settings 1 --file <path to configuration file> [--json]
If you need to modify the settings of the File Threat Protection task, you can:
- Modify all task settings using the configuration file. To do so:
- Output the task settings to the configuration file:
kfl-control --get-settings 1 [--json]A configuration file with the current task settings is generated.
- Edit task settings in the generated configuration file by choosing values from the following table.
- If necessary, add a scan scope to the configuration file or remove scan scopes that you want to skip from the configuration file.
To add a scan scope, add a
[ScanScope.item_#]section to the configuration file and specify the values of its settings by choosing them from the table below.To delete a scan scope, delete the
[ScanScope.item_#]section corresponding to the unwanted scan scope along with its settings from the configuration file. - If necessary, add an exclusion scope to the configuration file.
To add an exclusion scope, add an
[ExcludedFromScanScope.item_#]section to exclude files and directories or an[ExcludedForProgram.item_#]section to exclude processes and specify its settings by choosing them from the table below. - Save the configuration file.
- Run the following command:
kfl-control --set-settings 1 --file <configuration file path> [--json]
- Output the task settings to the configuration file:
- Modify individual task settings using command line options. To do so:
- Modify settings:
kfl-control --set-settings 1 <setting name>=<setting value> [<setting name>=<setting value>] - If necessary, add a scan scope using the
kfl-control --set-settings 1 --add-path <path to directory with objects to scan>command or delete a scan scope using thekfl-control --set-settings 1 --del-path <path to directory with objects to scan>command. - If necessary, add an exclusion scope using the
kfl-control --set-settings 1 --add-exclusion <path to directory with objects to exclude>command or delete an exclusion scope using thekfl-control --set-settings 1 --del-exclusion <path to directory with objects to exclude>command.
- Modify settings:
- Restore default task settings:
kfl-control --set-settings 1 --set-to-default
For detailed instructions on how to modify the settings of application tasks, see the How to manage task settings on the command line section.
The following table describes all the settings of the File Threat Protection task and their values.
File Threat Protection task settings
Setting |
Description |
Values |
|
|---|---|---|---|
|
Enables scanning of archives (including SFX self-extracting archives). The application scans the following archives: .zip; .7z*; .7-z; .rar; .iso; .cab; .jar; .bz; .bz2; .tbz; .tbz2; .gz; .tgz; .arj. The list of supported archive formats depends on the application databases being used. |
|
|
|
Enables scanning of self-extracting archives only (archives that contain an executable extraction module). |
|
|
|
Enables scanning email databases of Microsoft Outlook, Outlook Express, The Bat, and other mail clients. |
|
|
|
Enables scanning of plain text email messages. |
|
|
|
Temporary exclusion of files in text format from scans. If the value of this setting is |
|
|
|
Maximum size of an object to be scanned (in megabytes). If the object to be scanned is larger than the specified value, the application skips this object. |
0–999999 0 — The application scans objects of any size. Default value: 0. |
|
|
Maximum object scan duration (in seconds). The application stops scanning the object if it takes longer than the time specified by this setting. |
0–9999 0 — The object scan time is unlimited. Default value: 60. |
|
|
Selection of the first action to be performed by the application on the infected objects. |
Default value: |
|
|
Selection of the second action to be performed by the application on the infected objects. The application performs the second action if the first action fails. |
The possible values of the If Default value: |
|
|
Enables exclusion of the objects specified by the |
|
|
|
Excludes objects from being scanned by name or mask. You can use this setting to exclude an individual file from the specified scan scope by name or exclude several files at once using masks in SHELL format. |
The default value is not defined.
|
|
|
Enables exclusion of objects containing the threats specified by the |
|
|
|
Excludes objects from scans by the name of the threats detected in them. Before specifying a value for this setting, make sure that the In order to exclude an object from scans, specify the full name of the threat detected in this object – the string containing the application's decision that the object is infected. For example, you may be using a utility to collect information about your network. To keep the application from blocking it, add the full name of the threat contained in it to the list of threats excluded from scans. You can find the full name of the threat detected in an object in the application log or on the website https://threats.kaspersky.com. |
The setting value is case-sensitive. The default value is not defined.
|
|
|
Enables logging of information about scanned objects that the application reports as not being infected. You can enable this setting, for example, to make sure that a particular object was scanned by the application. |
|
|
|
Enables logging of information about scanned objects that are part of compound objects. You can enable this setting, for example, to make sure that an object within an archive has been scanned by the application. |
|
|
|
Enables logging of information about objects that have not been processed for some reason. |
|
|
|
Enables heuristic analysis. Heuristic analysis helps the application to detect threats even before they become known to virus analysts. |
|
|
|
Specifies the heuristic analysis level. The heuristic analysis level sets the balance between the thoroughness of searches for threats, the load on the operating system's resources, and the scan duration. The higher the heuristic analysis level, the more resources and time are required for scanning. |
|
|
|
Enables usage of the iChecker technology. |
|
|
|
File Threat Protection task operation mode. The |
|
|
The [ScanScope.item_#] section contains the following settings: |
|||
|
Description of the scan scope, which contains additional information about the scan scope. The maximum length of the string specified using this setting is 4096 characters. |
Default value:
|
|
|
Enables scans of the specified scope. To run the task, enable scans of at least one scope. |
|
|
|
Scan scope limitation. With this scan scope, the application only scans files that are specified using masks in SHELL format. If this setting is not specified, the application scans all the objects in the scan scope. You can specify several values for this setting. |
The default value is
|
|
|
Path to the directory with objects to be scanned.
|
The default value is / (scan all local directories). |
|
The [ExcludedFromScanScope.item_#] section contains the following settings: |
|||
|
Description of the scan exclusion scope, which contains additional information about the exclusion scope. |
The default value is not defined. |
|
|
Excludes the specified scope from scans. |
|
|
|
Limitation of scan exclusion scope. In the exclusion scope, the application excludes from scans only files that are specified using masks in SHELL format. If this setting is not specified, the application does not scan any of the objects within the exclusion scope. You can specify several values for this setting. |
Default value: |
|
|
Path to the directory with objects to be excluded.
|
< The default value is not defined. |
|
The [ExcludedForProgram.item_#] section contains the following settings: |
|||
|
Path to excluded process. |
|
|
|
Exclude child processes of the excluded process specified by the |
|
|
|
Description of the process exclusion scope. |
Default value: |
|
|
Excludes the specified scope from scans. |
|
|
|
Limitation of the process exclusion scope. In the process exclusion scope, the application excludes from scans only the files that are specified using masks in SHELL format. If this setting is not specified, the application excludes from scans all the objects within the process exclusion scope. You can specify several values for this setting. |
Default value: |
|
|
Path to a directory with files that are modified by the process.
|
The default value is / (scan all local directories). |
|