Command line options

To switch to application installation, removal, update, or repair mode, run the installation file from the application installation package on the command line with the relevant options.

Each option must be preceded by the "--" characters. For example: --param1=value1.
Options must be separated by a space.

The following option types are available:

• Flag: --flag
• Key-value: --key=value
• List of components: --features=feature1,feature2

The complete list of options is provided below.

install-mode

This optional argument of the Key type is used for selecting application installation, removal, upgrade, or repair modes.

Allowed parameters:

• install—Install the application
• delete—Remove the application
• upgrade—Upgrade the application
• repair—Repair the application

The default value is install.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• Check if the parameter matches allowed values.
  Error: Invalid parameter message.

accept-eula

This mandatory argument of the Flag type is used for accepting the terms and conditions of the End User License Agreement when you install or upgrade the application.

The option is used in the following modes:

• install—Install the application
• upgrade—Upgrade the application

Checks:

• Check if the name of the option is correct.
  Error: Unknown option message.
• Check if the option is specified.
  Error: Message about not being able to install the product without accepting the terms and conditions of the End User License Agreement.

accept-privacy-policy

This mandatory argument of the Flag type is used for accepting the terms and conditions of the Privacy Policy when you install or upgrade the application.

The option is used in the following modes:

• install—Install the application
• upgrade—Upgrade the application

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• Check if the option is specified.
  Error: Message about not being able to install the product without accepting the Privacy Policy.

components

This optional argument of the Features type is used to select components that you want to install.

This option is used only in the install mode (installing the application).

Allowed parameters:

• Antispam – Anti-Spam
• AntivirusForMailbox – Anti-Virus for the Mailbox role
• AntivirusForTransport – Anti-Virus for Hub Transport and Edge Transport roles.

Specify the components to be installed as a comma-separated list. The Management Console component is installed without additional options. The CAS Interceptor is not included in the set of components that can be installed using the command line.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• Check if the parameter matches allowed values.
  Error: Invalid parameter message.

install-dir

This optional argument of the Key type is used to specify the installation folder of the application. If the folder does not exist, it is automatically created.

This option is used only in the install mode (installing the application).

The default value is %Program Files (x86)%\Kaspersky Lab\Kaspersky Security for Microsoft Exchange Servers.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• Check if the specified path is valid.
  Error: invalid parameter message.

data-dir

This optional argument of the Key type is used to specify the data storage folder of the application. If the folder does not exist, it is automatically created.

This option is used only in the install mode (installing the application).

Default value: <application setup folder>\data.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• Check if the specified path is valid.
  Error: invalid parameter message.

sql-server-name

This optional argument of the Key type is used to specify the name of the SQL server.

This option is used only in the install mode (installing the application).

The default value is the name of the current computer.

If an SQL Server Express version was installed, specify the name (or IP address) of the computer where the SQL server is installed, and the name of the SQL instance, for example, MYCOMPUTER\SQLEXPRESS. Otherwise, the installation is terminated.

Checks: Check if the name of the option is correct.
Error: unknown option message.

sql-db-name

This optional argument of the Key type is used for specifying the name of the SQL database that is used for storing Backup data, statistics, and application configuration details.

This option is used only in the install mode (installing the application).

The default value is SecurityForExchange.

Checks: Check if the name of the option is correct.
Error: unknown option message.

additional-sql-params

This optional argument of the Key type is used for specifying additional settings for connecting to the Backup and statistics database server.

This option is used only in the install mode (installing the application).

The list of options and corresponding parameters is entered as one line.

Example: Connection Timeout=30;Integrated Security=SSPI;MultiSubnetFailover=true.

Checks: Check if the name of the option is correct.
Error: unknown option message.

service-account-name

This optional argument of the Key type is used for specifying the name of the user account to be used for running the KSE 9.0 service.

This option is used only in the install mode (installing the application).

The default value is LocalSystem user account credentials.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• service-account-pwd is specified, service-account-name must not be empty or missing from the installation command line.
  Error: "Account name for running the KSE 9.0 service not specified" message.

service-account-pwd

This optional argument of the Key type is used for specifying the password of the user account to be used for running the KSE 9.0 service.

This option is used only in the install mode (installing the application).

The default value is LocalSystem user account credentials.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• service-account-name is specified, service-account-pwd <>Null.
  Error: Prompt for password in interactive mode.

installation-log-name

This optional argument of the Key type is used for specifying the path to the executable operation log file.

If you specify an invalid path, then this will return an error, but the operation will not be interrupted. After the operation is completed, the path to the log file is displayed on the command line.

The option is used in the following modes:

• install—Install the application
• delete—Remove the application
• upgrade—Upgrade the application
• repair—Repair the application

The default value is %TMP%\kseinstall.log.

Checks:

• Check if the name of the option is correct.
  Error: unknown option message.
• Check if the specified path is valid.
  Error: invalid parameter message.

read-eula

This optional argument of the Flag type is used to display the End User License Agreement.

If this option is used with any other installation options, it is the only one that is processed, the rest of the options are ignored.

Checks: Check if the name of the option is correct.
Error: unknown option message.

read-privacy-policy

This optional argument of the Flag type is used to display the Privacy Policy.

If this option is used with any other installation options, it is the only one that is processed, the rest of the options are ignored.

Checks: Check if the name of the option is correct.
Error: unknown option message.

help

This optional argument of the Flag type is used to display the command line help.

Checks: Check if the name of the option is correct.
Error: unknown option message.