Managing Kaspersky Scan Engine cluster instances

The Cluster page allows you to manage Kaspersky Scan Engine instances that are part of a cluster.

Adding an instance of Kaspersky Scan Engine to a cluster

You can add a new or previously removed instance of Kaspersky Scan Engine to a cluster in the following ways:

• During automatic installation.
• During manual installation.
• After the installation, by specifying the appropriate settings in the DatabaseSettings > ConnectionString, DatabaseSettings > User, and DatabaseSettings > Password elements of klScanEngineUI.xml. The changes will take effect after you restart the service.

Cluster page contents

The Cluster page contains the following tabs:

• Hosts
• Settings profiles
• Cluster settings

Hosts

The Hosts tab displays a continuously updated (every five seconds) table of Kaspersky Scan Engine clustered instances. This table contains the following columns:

• Hostname—Host name of the computer that Kaspersky Scan Engine initialized on.
• Status—Initialization result.
• Integration mode—The mode of the Kaspersky Scan Engine instance: either HTTP mode or ICAP mode.
• Anti-virus database version—Version of the Kaspersky Scan Engine anti-virus databases.

  Also, this column may contain the update status with the following information:

  • Update is currently being performed
  • An error occurred during update
• Settings profile—Name of the settings profile that is used in the Kaspersky Scan Engine instance.

  If the name of the settings profile is Default, Kaspersky Scan Engine uses the preset settings. If the name is Custom, Kaspersky Scan Engine uses its own custom settings and does not use any settings profile.

On this tab, click the Options icon () to the left of the instance that you need, and then select any of the following actions:

• Change profile settings—Specifies which settings profile must be used
• Launch database update—Updates the Kaspersky Scan Engine anti-virus database

  You cannot launch the update if it is currently running and if the instance of Kaspersky Scan Engine is deinitialized.

• Enable logging—Enables debug logging in the instance of Kaspersky Scan Engine

  Also, you can disable launched debug logging.

  You cannot enable debug logging if the instance of Kaspersky Scan Engine is deinitialized.

• Remove from cluster—Removes the instance from the cluster. If the cluster instance does not exist, it can take up to 5 minutes before this cluster instance is removed.

  You cannot remove the instance of Kaspersky Scan Engine that is currently used.

Settings profiles

This tab displays a list of Kaspersky Scan Engine settings profiles created by a Kaspersky Scan Engine user. You can view the following data for each settings profile:

• Name of the settings profile
• Description of the settings profile

  The description may be absent if you have not specified it.

• Service mode

  Kaspersky Scan Engine mode (either ICAP or HTTP) for which the settings profile has been created.

• List of host names of Kaspersky Scan Engine instances that use the selected settings profile

  It is allowed that the profile is not used by any of the Kaspersky Scan Engine instances.

You can add a new settings profile, or edit or delete an existing profile.

To add a new settings profile:

1. Click the Add button above the list of all settings profiles.

   The wizard for adding a new settings profile opens.

2. In the Profile info tab, specify the following settings:
   • Name—Name of the settings profile

     This setting is mandatory. The name must differ from the ones created previously and the ones reserved by Kaspersky Scan Engine (Default and Custom), and it must contain up to 16 symbols.

   • Description—Description of the settings profile

     This setting is optional. The description must contain up to 256 symbols.

   • Service mode—The mode of the Kaspersky Scan Engine instance: either HTTP mode or ICAP mode.

     This setting is mandatory.

   • If needed, select the Use these host settings as base checkbox to configure the profile by using the settings of the Kaspersky Scan Engine instance that is currently running.

     If this checkbox is not selected, the default settings are used depending on the working mode (HTTP or ICAP).

3. Click Next.
4. In further steps, specify Kaspersky Scan Engine settings of different types, depending on the working mode (HTTP or ICAP). You can configure most of the parameters located on the Settings page, except for the settings from the License and Password sections, and the connection settings in the Service section:
   • In the Service tab, specify service settings
   • In the Scanning tab, specify scanning settings
   • In the Update tab, specify update settings
   • In the ICAP rules tab, specify ICAP rules
   • In the Logging tab, specify logging settings
   • In the Proxy tab, specify proxy settings
5. In the Summary tab, check the summary information about the settings profile.
6. Click Save.

   You can also save current changes at each step of the procedure.

To edit an existing settings profile:

1. Locate a settings profile that you want to edit, and then click the Edit button above the section with a brief description of the profile.

   The wizard for editing the settings profile opens.

2. Edit the settings that you need.

   You can edit all of the settings that are described in the procedure for adding a new settings profile above.

To delete an existing settings profile:

1. Click the Delete () icon next to the settings profile that you need to delete.
2. Click Confirm to confirm the action.

After the deletion is complete, the instances that use the settings of the deleted profile will continue using its configuration.

Cluster settings

On this tab, you can configure Kaspersky Scan Engine to automatically remove from the cluster those instances that are inactive for a specified period of time.

An instance is considered inactive if no service events have been registered from that instance. After removing an instance from a cluster, Kaspersky Scan Engine also deletes all service events associated with the instance. Kaspersky Scan Engine does not delete events with scan results.

To configure automatic removal of inactive cluster instances:

1. Turn on the Enable automatic removal toggle switch.
2. Specify the inactivity period in hours.

   To avoid accidental removal of a cluster instance, do not set the inactivity period to less than 24 hours.

3. Click Save.

If a previously removed instance becomes active, it can reconnect to the cluster.

To reconnect an instance to a cluster:

1. Change the instance host name.
2. Restart the Kaspersky Scan Engine services:
   • For HTTPD mode, restart the kavhttpd service:

     systemctl restart kavhttpd

   • For ICAP mode, restart the kavicapd service:

     systemctl restart kavicapd

   • If you are using the Kaspersky Scan Engine GUI, restart the klScanEngineUI service:

     systemctl restart klScanEngineUI