NAME

gencfg - configuration values for the Keon Agent SDK 5.1 generic layer

DESCRIPTION

This page contains configuration settings for the generic layer of the Keon Agent SDK 5.1.

Configuration file structure

The configuration files have extension .cfg and are located in

        $ETCROOT/global.cfg
        $ETCROOT/services/<service>.cfg
        $ETCROOT/tcp/s<port>.cfg

where $ETCROOT is the Agent data directory, for example, /opt/etc/SDTI/Agents/etc.

The global.cfg file contains data common to all Agents, as well as information needed by catd and catlogger. This file is supplied by the Base System.

The services directory contains Agent-specific configuration files, where <service> is the service name of the Agent, for example, services/pop3_sample-5.0.cfg. These files are supplied by the Agents.

The tcp directory contains information specific to an Agent instance, that is, a configured port. The name s<port>.cfg might, for example, be s110.cfg indicating configuration data for port 110. The 's' indicates a server port. These files are typically created by a configuration program when setting up an Agent for a specific port.

Global configuration parameters

Version
Configuration parameter layout. Should be 1.

ApplicationRoot
Directory containing binaries, libs, etc. For example, /opt/<name>.

EtcRoot
Directory containing configuration files. For example, /etc/opt/<name>.

VarRoot
Directory containing data files. For example, /var/opt/<name>.

BoKS.NodeKey
BoKS node key (required).

BoKS.NodeKeyFile
File containing the BoKS node key (overridden by BoKS.NodeKey).

BoKS.Domain
BoKS domain. Default is 6500.

BoKS.Servers
BoKS server list: address[,address]... Default is broadcast only.

BoKS.CacheTTL
Base time-to-live in seconds for cacheable requests. Default is 120 seconds. Value O disables caching.

BoKS.MyAddress
ID (IP address) to be used in BoKS packets. Default is from the network interface.

BoKS.LogFile
Log spool file for asynchronous logging to BoKS. Default is none, send sychronously.

ELS.LogFile
Log spool file for asynchronous logging to ELS. Default is none, send sychronously.

ELS.Servers
Log servers: address:port[,address:port] (required)

ELS.DontVerifyServer
If > 0, ignore ELS server certificate (in the event that the signing CA was unavailable. For testing).

HostPSD.File
Agent Host Virtual Card (PSD) file for this host.

HostPSD.Password
Agent Host Virtual Card (PSD) password.

HostPSD.PasswordFile
File containing the Agent Host Virtual Card (PSD) password (overriden by HostPSD.Password).

HostPSD.BoKS
If present and atoi() != 0, indicates that the Agent Host Virtual Card (PSD) is a BoKS Agent Host PSD. Default is no.

CA.DBFile
File containing all trusted CAs.

Cert.CacheTTL
Time-to-live in seconds for entries in the verified certificate cache.

Cert.MaxCacheSize
Max size of the verified certificate cache. =item Log.File

Local log file, used instead of BoKS or ELS. Not set as default.

Log.HostPSD
If set to a non-zero value, log Agent Host Virtual Card distinguished name on startup.

Debug.Spec
Debug specification (for example, level).

Debug.File
The file part only of the debug specification. This should be set or the library prints warnings and errors to stderr.

The following values are read by catd.

Start.FailCount
Default: 5.

Start.FailInterval
Default: 30.

Start.FailDisable
Default: 300.

The ``Start'' values are interpreted by catd as follows. If a program exits more than failcount times in failinterval seconds, the program or service is disabled for faildisable seconds or until reconfigured.

Start.program.Start
Should be ``on'' or ``off.'' If ``on,'' the program will be started or restarted if it exits (unless the exits take place too rapidly, see ``Start.Fail*'' above).

Start.program.Program
The path to the executable, together with any arguments. catd will start all programs specified in this way at the same time that catd is started.

Parameters for each service

Idle
Optional idle time.

Lifespan
Optional lifespan.

Debug.Spec
Debug specification for this service only.

Debug.File
Debug file for this service only.

The following values are not currently used by the library, but should be set to ensure that auxiliary programs function correctly.

Name
The name of the service, for example, ``pop3_sample-5.0''.

Description
One-line description of the service.

Program
Full path and argument to the program to be started.

The following values are used as defaults to the configuration program.

Default.AuthMethod
Optional default name for the method.

Default.Server
Optional default value for the server.

Default.Port
Optional default value for the port.

Default.Inetd
Optional default value for the tag in /etc/inetd.conf.

Parameters for each port

Start
``auto, ''off,`` or ''hook.``

auto: the service is started by catd when catd is invoked.

off: the service is disabled

hook: as for ``auto'' but started via bindhook (Windows NT only).

Inetd
Set to ``1'' if the service is started via inetd (UNIX only).

SEE ALSO

cat, catd, bindhook, cfgfiles