Vscan | Configuration

The OPSWAT connector for NetApp ONTAP is configured through a config.ini file. This page documents the settings available in that file, grouped by section. IP, Port, Apikey, StorageUnits and the keys of every [Storage Unit N] section are required: if one of them is missing, empty or invalid, the connector does not start and reports the setting. Every other setting is optional: if it is left empty or omitted, or its value is outside the allowed range or of the wrong type, the connector uses the default value and logs a warning.

For the full behaviour of every key, including validation messages and troubleshooting, see ONTAP Connector Configuration file.

Example

The template the connector package is built from, with every optional key at its default. A connector downloaded from MetaDefender Storage Security has Apikey, Port and PortSsl filled in, StorageUnits=1, and a [Storage Unit 1] section for the storage it was downloaded for.

[MetaDefender Storage Security]
IP=127.0.0.1
Port=80
PortSsl=443
IgnoreCertErrors=0
Apikey=
StorageUnits=0

[Settings]
LogRetentionCountInFiles=7
LogMaxFileSizeInMegabytes=10
LogPath=
LogLevel=Information
FileProcessingTimeoutInSeconds=3600
RpcLocalPipeHost=127.0.0.1
ZoneIdentifierFiles=0
TimeoutResponse=4
StorageSyncIntervalInSeconds=15

[MetaDefender Storage Security] section

Defines how the connector reaches the MetaDefender Storage Security instance.

Setting

Type

Default

Description

IP

Text (IPv4 address)


Required. IP address of the MetaDefender Storage Security instance. Hostnames are not accepted. The template uses 127.0.0.1.

Port

Integer (1-65535)


Required. HTTP port of the MetaDefender Storage Security instance. The template uses 80, but there is no default: an empty or invalid value stops the connector.

PortSsl

Integer (1-65535)

443

HTTPS port of the MetaDefender Storage Security instance. The connector switches between Port and PortSsl automatically, and the switching cannot be turned off. A value outside the range, including 0, is replaced with 443.

IgnoreCertErrors

Integer (0-1)

0

1 ignores TLS certificate errors on HTTPS requests, for example with the default self-signed MDSS certificate.

Apikey

Text


Required. API key used to authenticate with MetaDefender Storage Security. It also needs read permission on accounts for the storage synchronisation; without it, every synchronisation cycle is skipped.

StorageUnits

Integer (0 or greater)


Required. Number of [Storage Unit N] sections. Maintained by the connector; 0 means no NetApp ONTAP storage currently has event-based real-time protection running. The template uses 0; a connector downloaded from MetaDefender Storage Security starts at 1.

[Storage Unit N] sections

One section per configured storage unit, numbered sequentially ( [Storage Unit 1], [Storage Unit 2], and so on). The number of these sections must match the StorageUnits value above. If StorageUnits is less than the number of Storage Unit sections in the file, only the first N sections are read and the rest are ignored. If StorageUnits is greater, the connector looks for a section that does not exist and fails to start. The same happens when a section in the sequence is missing (e.g. StorageUnits=3, [Storage Unit 1] and [Storage Unit 3] are present but [Storage Unit 2] is missing). Both ClientId and SharePath are required in every section that is read.

Every StorageSyncIntervalInSeconds the connector reads the NetApp ONTAP accounts from MetaDefender Storage Security, keeps the storages whose event-based real-time protection is running, and rewrites the [Storage Unit N] sections, the StorageUnits count and the ONTAP AV Connector data-lifs registry values to match. Changes apply without a service restart. Set StorageSyncIntervalInSeconds=0 to keep hand-written sections untouched.

Setting

Type

Default

Description

ClientId

Text


Identifier of the storage unit generated by MetaDefender Storage Security

SharePath

Text


Path of the share to protect as it is integrated in MetaDefender Storage Security

[Settings] section

General connector behavior.

Setting

Type

Default

Description

LogRetentionCountInFiles

Integer (1-200)

7

Number of log files kept; older files are deleted. Replaces LogRetentionCountInDays, which is still read when the new key is absent.

LogMaxFileSizeInMegabytes

Integer (1-1024)

10

Size at which the current log file is rolled over to a new timestamped file (YYYYMMDD_HHMMSS.log). An identical warning or error is written once per log file.

LogPath

Text (absolute or relative path)


Directory the log files are written to. Empty keeps the default <install dir>\logs. A relative path is resolved against the installation directory. An unusable path falls back to the default and the reason is logged.

LogLevel

Text

Information

Logging verbosity. One of: Verbose, Debug, Information, Warning, Error, Fatal. The value is case-sensitive.

FileProcessingTimeoutInSeconds

Integer (1 or greater)

3600

Maximum time allowed to process a single file before it times out

RpcLocalPipeHost

Text

127.0.0.1

Local host address used for the connector's internal communication

ZoneIdentifierFiles

Integer (0-3)

0

Handling mode for Windows Zone.Identifier files (see below).

TimeoutResponse

Integer (0-5)

4

Verdict sent to ONTAP when a file hits FileProcessingTimeoutInSeconds. 4 blocks only where scanning is mandatory.

StorageSyncIntervalInSeconds

Integer (0-86400)

15

How often the storage units are synchronised with MetaDefender Storage Security. 0 disables the synchronisation and leaves config.ini and the registry as configured by hand.

ZoneIdentifierFiles values

Zone.Identifier files are small metadata streams Windows attaches to files downloaded from the internet. They hold no user content, so scanning them is usually unnecessary. This setting selects how the connector handles them; all other files always go through the normal scanning pipeline regardless of this value.

Value

Mode

Behavior

0

Skip (default)

Zone.Identifier files are ignored, not scanned and no verdict is returned

1

Scan

Zone.Identifier files are sent to MetaDefender Storage Security and scanned like any other file

2

Allow

Zone.Identifier files are immediately allowed without scanning

3

Block

Zone.Identifier files are immediately blocked without scanning