Metadefender Client Configuration

The Configuration page specifies the settings for the Metadefender Client package that will be available through the client download page, the location of which is listed at the bottom of the Configuration page. After a client has been generated, the Metadefender Client download page can be shared with anyone who should be able to use Metadefender Client to scan files with this Metadefender Core server.

  1. Access the Metadefender Core Management Console .

  2. Click the Sources tab and then c lick Metadefender Client .
    images/download/attachments/347401/SourcesMDClient.png

Note: The Windows Metadefender Client is supported to run only on endpoints running Windows 7 or later.

The following properties can be set for the Metadefender Client download package. These properties can also be set by modifying the Metadefender Client INI file, which is located by default at C:\Program Files (x86)\OPSWAT\Metadefender Core <1|4|8|12|16|20>\MetascanClient\MetascanClientConf.ini.

Property

Description

Default Value

Metadefender Core

This is the address that Metadefender Client will use to access the Metadefender Core server. This should be an address (IP address or machine name) that will be accessible from every machine where Metadefender Client will be run.

<IP Address>:8008/metascan_rest

API Key

The API key that is defined on the local server.

N/A

File Size Limit

The maximum size of files to be scanned by Metadefender Client. Files larger than this size will not be scanned.

5 MB

Batch Size

The number of files that can be processed concurrently by Metadefender Client.

100

Thread Count

The number of threads Metadefender Client will use to scan files. This should only be increased if Metadefender Client is expected to run on systems with a high number of processor cores.

10

File Scan Timeout

The number of seconds the Metadefender Client will wait for the server to respond with scan results. After timeout threshold is reach, Metadefender Client will display a "operation time out" error.

300

User Interface

This specifies whether Metadefender Client will allow the end user to select what type of scan they want to run. If Metadefender Client is set to run in automatic mode, then it will run silently without any user interaction.

Allow User Selection

Scan Types

Specifies which scan types will be available for the user to choose from.

  • Fast: Scans all running processes.

  • Intermediate: Scans running processes and loaded libraries.

  • Full: Scans entire system.

  • Custom: Scans the files and directories the user selects.

Fast

Local Log Directory

The directory where Metadefender Client will log all scanning activity.

C:\MetascanClient.log

After configuration changes have been made, you can generate a new Metadefender Client downloadable package by clicking Update Client Download .

Metadefender client command line options

All of the options specified in the configuration file can also be set on the command line. Options set on the command line override the same options set in the configuration file. The following table specifies additional options that can be set on the command line. Default values are in bold.

Variable

Description

show_ui

Determines whether the Metadefender Client User Interface will be displayed.

Possible values:

  • 0: Metadefender Client will run silently.

  • 1: The Metadefender Client user interface will be displayed to the user.

exit_on_clean

Determines whether the Metadefender Client user interface will exit if all files scanned are clean.

Possible values:

  • 0: Metadefender Client will not immediately exit after a scan where all files are clean.

  • 1: Metadefender Client will immediately exit after a scan where all files are clean.

exit_on_dirty

Determines whether the Metadefender Client user interface will exit if there are dirty files found during a scan.

Possible values:

  • 0: Metadefender Client will not immediately exit after a scan where one or more dirty files are found.

  • 1: Metadefender Client will immediately exit after a scan where one or more dirty files are found.

auto_start

Determines if the Metadefender client will start scanning immediately once application launches.

Possible values:

  • 0: Metadefender Client will not immediately start scanning.

  • 1: Metadefender Client will immediately start scanning.

Note: show_ui=0 is ignored if auto_start is not set to 1.

auto_save_result

Determines if the scan results should be saved automatically.

Possible values:

  • 0: Metadefender Client will not save results automatically.

  • 1: Metadefender Client will automatically save scan results at the location where Metadefender Client is located.

key

API key given by OPSWAT when OPSWAT hosted server is used.

Command line usage example

The following is an example command to start a fast scan automatically against a Metadefender Core server with the IP address 10.0.0.1:

MetascanClient.exe server=10.0.0.1:8008/metascan_rest auto_start=1 allowed_scan_levels=1