Vscan | Configuration

AI Tools

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. If a setting is left empty or omitted, its default value is used (if there is one). If a setting contains a value outside its allowed range or of the wrong type, the connector will not start and will report the invalid setting.

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

Example

The shipped template, with every optional key at its default:

[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)

127.0.0.1

IP address of the MetaDefender Storage Security instance.

Port

Integer

80

HTTP port of the MetaDefender Storage Security instance.

PortSsl

Integer

443

HTTPS port of the MetaDefender Storage Security instance. The connector switches between Port and PortSsl automatically; 0 pins it to plain HTTP.

IgnoreCertErrors

Integer (0-1)

0

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

Apikey

Text


API key used to authenticate with MetaDefender Storage Security. It also needs read access to the NetApp ONTAP accounts for the storage synchronisation.

StorageUnits

Integer (0 or greater)

0

Number of configured storage units. Maintained by the connector; 0 means no NetApp ONTAP storage currently has event-based real-time protection running.

[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 should match the StorageUnits value above. If the value of the StorageUnits variable is less than the number of Storage Unit sections in the file, only the first N storage units will be checked. If the value is greater, all storage units will be checked and the extra amount of the value will be silently ignored. If there is any storage unit section that is missing (e.g. StorageUnits=3, [Storage Unit 1] and [Storage Unit 3] are present but [Storage Unit 2] is missing), the connector will fail.

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 file.

LogPath

Text (absolute path)


Directory the log files are written to. Empty keeps the default <install dir>\logs. 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

FileProcessingTimeoutInSeconds

Integer

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