Application settings for the command prompt
31 August 2023
ID 156605
When you install or update the application in silent mode, you can specify in your command the settings presented in the table below.
Use the following format: <settings>[=<value>]
. For example, POSITION=Admin
If setting values contain spaces, enclose these values in double quotes. For example, POSITION="Junior developer"
Application settings for the command prompt
Name | Description | Available values | Required / optional |
AGREETOEULA | Accept the terms and conditions of the End User License Agreement. | 0 – decline 1 – agree | Always required |
AGREETO_SUPPLEMENTAL_STATEMENT | Accept the terms and conditions of the Supplemental Statement on Data Processing. | 0 – decline 1 – agree | Always required |
AGREETO_MARKETING_STATEMENT | Accept the terms and conditions of the Statement Regarding Data Processing for Marketing Purposes. | 0 – decline 1 – agree | Always required |
AGREETOPRIVACYPOLICY | Accept the terms and conditions of the Privacy Policy. | 0 – decline 1 – agree | Always required |
ADWARE_DETECT | Turn on detection of adware and suspicious processes. | 0 – decline 1 – agree | Always required |
USER_MODE | Select the Administrator mode. | 0 – User with email reports 1 – User 2 – Administrator (by default) | Optional |
USER | User name. | Arbitrary value | Optional |
POSITION | User's position. | Arbitrary value | Optional |
ADMIN_EMAIL | Email address for sending reports. | Email address | Required if USER_MODE=0 |
SENDER_EMAIL | Email address from which reports are to be sent. | Email address | Required if USER_MODE=0 |
SMTP_SERVER | SMTP server address. | IP address or SMTP server name | Required if USER_MODE=0 |
SMTP_PORT | SMTP server port. | Available values: 1 – 65535, default port – 25 | Required if USER_MODE=0 |
CONNECTION_SECURITY | Type of encrypted connection for sending emails. | 0 – non-encrypted connection (by default) 1 – STARTTLS 2 – SSL/TLS | Optional |
NEED_AUTHENTICATION | Whether authentication on the SMTP server is required. | 0 – authentication not required (by default) 1 – authentication required | Optional |
EMAIL_USER | Login for authentication on the SMTP server. | Arbitrary value | Required if NEED_AUTHENTICATION=1 |
EMAIL_USER_PASSWORD | Password for authentication on the SMTP server. | Arbitrary value | Required if NEED_AUTHENTICATION=1 |
REPORTS_TYPE | Type of reports schedule. | manually – automatic reports are disabled weekly – reports are sent automatically once a week (by default) monthly – reports are sent automatically once a month daily – reports are sent automatically once a day | Optional |
REPORTS_DAY | Day on which reports are sent automatically. | [1-7] if REPORTS_TYPE=weekly [1-31] if REPORTS_TYPE=monthly | Optional |
REPORTS_TIME | Time when reports are sent automatically (in 24-hour clock format). | [00-23]:[00-59] By default, reports are sent at 12:00. | Optional |
PROXY_TYPE | Type of proxy server use. If PROXY_TYPE = manually, the PROXY_HOST and PROXY_PORT parameters are required. | auto – proxy server settings are detected automatically (by default) manually – configure the proxy server settings manually none – a proxy server is not used | Optional |
PROXY_HOST | Proxy server address. | Arbitrary value | Optional |
PROXY_PORT | Port used to connect to the proxy server. | [0-65535] | Optional |
PROXY_AUTH_LOGIN | User name to connect to the proxy server. | Arbitrary value | Optional |
PROXY_AUTH_PASSWORD | Password to connect to the proxy server. The password cannot be empty or contain quotation marks. | Arbitrary value | Optional |
PROXY_LOCAL_ADDRESS | Whether a proxy server is used for local addresses. | 0 – a proxy server is used 1 – a proxy server is not used (by default) | Optional |
MIGRATE_SETTINGS | Enable / disable settings migration from the previous version of the application. If enabled (or not specified) when updating the application in silent mode, only the always-required parameter values (AGREETOEULA, AGREETO_SUPPLEMENTAL_STATEMENT, AGREETOPRIVACYPOLICY, ADWARE_DETECT) will be used from a command. Optional and relative parameter values will be copied from the previously installed version. If the previously installed version is Beta1 or Beta2, the MIGRATE_SETTINGS value is ignored since automatic settings copying is not available for those versions. | 0 – disable 1 – enable (by default) | Optional |
REBOOTCOMPUTER | Restart the computer after uninstalling or updating the application. | 0 – do not restart 1 – restart | Required if updating |
PROTECTION_PASSWORD | Password-protect the application settings. Your password cannot be empty or contain quotation marks. | Arbitrary string value | Optional (incompatible with the PROTECTION_PASSWORD_PATH parameter) |
PROTECTION_PASSWORD_PATH | Specify a local or network path to a TXT file with the password to protect the application settings. | Arbitrary string value | Optional (incompatible with the PROTECTION_PASSWORD parameter) |
REGISTRATION_CODE | Registration code to activate the application | Arbitrary value | Optional |
KES_MONITORING_MODE | Kaspersky Anti-Ransomware Tool operates without protection drivers and interface of the application is blocked. This option is for internal use only. It is not recommended to change its value manually. | 0 – works in normal mode 1 – works without protection drivers and interface of the application is disabled | Optional |
The following table describes specific settings intended for internal use at Kaspersky. We cannot guarantee correct installation and operation of the application if you modify the default values of these settings.
Application settings for internal use
Name | Description | Default value |
INSTALLDIR | Internal setting for changing the default installation path of the application. | The default installation path is C:\Program Files (x86)\Kaspersky Lab\Kaspersky Anti-Ransomware Tool for Business 4.0 for a 64-bit operating system. |
SELFPROTECTION | Enable (1) / disable (0) self-protection. | Self-protection is enabled by default. |
RUNAPP | Run (1) / do not run (0) the application after installing in silent mode. | The application is launched by default. |
/log <path to folder> | Create application installer and MSI installer log files in the specified folder. The following file names will be used: "kart_installer_%m.%d_%H.%M.INST.log"; "kart_installer_%m.%d_%H.%M.MSI.log"; m – month, d – day, H – hour, M - minute. | Not set |
/disable_updates | Skip the search for installer updates, in case of launching without specifying the /q key | Not set |
/wait | Wait for the shut down of the already running installer before starting work | Not set |
All parameters are case-sensitive. Receiving the application error code ErrorCode: 253
alongside with an MSI error, indicates that the command did not use correct command syntax. Please review these instructions and try again.
The IS_ADMIN parameter is no longer supported. Use the USER_MODE parameter instead.
If you do not specify the optional parameters, Kaspersky Anti-Ransomware Tool for Business will be installed with the default values of these parameters.