Parameter Types

Configuration parameters can be of the following types:

1.Address—a network connection address specified as <IP address>:<port>. In some cases the port can be omitted (in each case this is indicated in the description of the parameter).

2.Boolean—a flag parameter. The parameter accepts only the Yes or No value.

3.Integer—a non-negative integer.

4.Fractional number—a non-negative number with a fractional part can be indicated as a parameter value.

5.Time interval—a time interval consisting of a non-negative integer and a suffix character indicating the specified unit of measurement. The following suffixes representing units of measurement can be used:

w—weeks (1w = 7d);

d—days (1d = 24h);

h—hours (1h = 60m);

m—minutes (1m = 60s);

s or no suffix—seconds.

If the time interval is specified in seconds, you can specify milliseconds after a point (no more than three digits, for example, 0.5s—500 milliseconds). It is possible to specify multiple time intervals in different time units as a single time interval; in this case, it is counted as a sum of intervals (in fact, the configuration parameters always store a number of milliseconds covered by this time interval).

In general terms, any time interval can be represented by the following expression: N1wN2dN3hN4mN5[.N6]s, where N1, , N6 is a number of the corresponding time unites included in this interval. For example, a year (365 days) can be represented as follows (all records are equivalent): 365d, 52w1d, 52w24h, 51w7d24h, 51w7d23h60m, 8760h, 525600m, 31536000s.

The examples below show you how intervals of 30 minutes, 2 seconds, 500 milliseconds can be specified:

in the configuration file:

UpdateInterval = 30m2.5s

using the drweb-ctl cfset command:

# drweb-ctl cfset Update.UpdateInterval 1802.5s

via a command-line parameter (for example, for Command-Line Arguments):

$ drweb-se --WatchdogInterval 1802.5

6.Size—the parameter value represents a size of an object (a file, a buffer, a cache, and so on), specified as a non-negative integer and a suffix representing a measurement unit. The following suffixes that specify size units can be used:

mb—megabytes (1mb = 1024kb);

kb—kilobytes (1kb = 1024b);

b—bytes.

If a suffix is omitted, the size is considered to be in bytes. A single size record can be specified by multiple sizes in different units; in this case, the resulting size is counted as their sum (in fact, the configuration parameters always store the size in bytes).

7.Path to directory (file)—the parameter value is a string representing an acceptable path to a directory (a file).

The file path must be ended with a file name.

On UNIX-like operating systems, names of directories and files are case-sensitive. If it is not explicitly mentioned in a parameter description, paths cannot be represented by masks with special characters (?, *).

8.Logging level—a level at which the Dr.Web for UNIX Mail Servers component events are logged. The following values are allowed:

DEBUG—the most detailed logging level. All messages and debug information are logged.

INFO—all messages are logged.

NOTICE—all error messages, warnings, and notifications are logged.

WARNING—all error messages and warnings are logged.

ERROR—only error messages are logged.

9.Log type—the parameter value specifies the Dr.Web for UNIX Mail Servers component logging method. The following values are allowed:

Stderr[:ShowTimestamp]—messages are output to stderr (standard error stream). This value can be used only in the settings of the configuration daemon. At that, if it works in the background (“daemonized”), i.e. it is started with the -d parameter, this value cannot be used because components operating in the background cannot access input/output streams of the terminal). The additional ShowTimestamp parameter instructs to add a timestamp to every message.

Auto—messages for logging are passed to the Dr.Web ConfigD configuration daemon, which stores them in a single location specified in its own settings (the Log parameter in the [Root] section). This value is specified for all components except for the configuration daemon and is used as a default value.

Syslog[:<facility>]—the component will pass messages to the syslog system logging service.

The <facility> additional option is used to specify a type of a log to store messages logged by syslog. The following values are allowed:

DAEMON—messages from daemons,

USER—messages from user processes,

MAIL—messages from mail programs,

LOCAL0—messages from local processes 0,

LOCAL7—messages from local processes 7;

<path>—messages will be stored by the component directly in the specified log.

Examples of how to specify a parameter value:

in the configuration file:

Log = Stderr:ShowTimestamp

using the drweb-ctl cfset command:

# drweb-ctl cfset Root.Log /var/opt/drweb.com/log/general.log

via a command-line parameter (for example, for Command-Line Arguments):

$ drweb-se --Log Syslog:DAEMON

10. Action—action to be applied by the Dr.Web for UNIX Mail Servers component upon detection of certain threats or upon another event. The following values are allowed:

Report—only notify on threat detection without applying any action;

Cure—attempt to cure the threat (that is, remove only malicious content from the file body);

Quarantine—put the infected file in quarantine;

Delete—delete the infected file.

Some of the actions can be applied only upon certain events (for example, a “Scanning error” event cannot trigger the Cure action). Allowed actions are always listed in the description of each parameter of the action type.

Other types of parameters and their allowed values are explicitly specified in the description of these parameters.