Configuration File

The configuration file defines the parameters that control the operation of the interface software. The release includes a default configuration file. You can use the default configuration file as is, or change it to satisfy your site’s specific requirements.

The name of the configuration file is D/SINGLEPOINT/CONFIG. You can change this name. If you change it, you must also change it in COMS/SINGLPOINT/LOAD or in the PAT screen in the UTILITY window. For an example, refer to the definition for the SINGLEPOINTTEST program in COMS/SINGLPOINT/LOAD.

You can change parameters in this file. However, if you make changes, you must terminate and restart the interface software for the changes to take effect. See 3.4 for a description of how to initiate and terminate the interface software.

The following is a description of the format and contents of the configuration file.

Notes:

Each statement must end with a period.
The configuration file and the formats show keywords in uppercase. Keywords are case insensitive; you can enter them in uppercase or lowercase.
A percent sign (%) indicates the beginning of a comment. It may appear anywhere on a line. Everything following the percent sign is treated as a comment and is ignored.

DEFAULT_SOCKET TCP-port-number.
UTILIZATION_INTERVAL interval-in-seconds.
FILTER_FILE_NAME filter-file-name.
AUTO_LOGON_USERCODE usercode-1.
USE_PRIVILEGED_SYSTEM_USERCODE_ON_SP_AMS_PORT <TRUE|FALSE}.
ADM ODT-display-options.
SECURITY_ENABLED <0|1}.
DISK_INTERVAL interval–in–seconds.
DATABASE_LEVEL compatibility–level.
LOG_JOB_USERCODE <YES|NO}
RENEW_DISK_ALARMS number–of–intervals.
ALLOW_AUTOMATED_KEYINS <YES|NO}.
HACKER_DELAY interval-in-seconds.
USE_API {YES|NO}.
TERM ODT-terminal-options.
STARTDISKNAMES.
disk-family		 [(index)]		 [threshold-% 		[severity]]		 [AREASIZE area-size].
			.
			.
ENDDISKNAMES.

where:

DEFAULT_SOCKET TCP-port-number.

specifies the port number for the interface software message services. It is mapped into the TCP source port address. If ALLOW_AUTOMATED_KEYINS is YES or unspecified, DEFAULT_SOCKET defaults to 10301. If ALLOW_AUTOMATED_KEYINS is NO, DEFAULT_SOCKET defaults to 10302.

Note: You must include the same port number in the services file on the Operations Sentinel server. The default value 10301 is automatically placed in the services file during installation of Operations Sentinel on the Operations Sentinel server. See Section 2 for additional information.

UTILIZATION_INTERVAL interval-in-seconds.

specifies the time interval between utilization data messages. This determines the frequency that the utilization data is sent to Operations Sentinel. You can enter a value from 1 second to 3600 seconds. The default value is 20 seconds.

FILTER_FILE_NAME filter-file-name.

specifies the name of the filter file. The default name is D/SINGLEPOINT/FILTER.

AUTO_LOGON_USERCODE usercode-1.

specifies the usercode that enables terminal emulation sessions initiated at a Operations Sentinel workstation to be opened automatically in remote operator display terminal (ODT) mode. The default usercode is SPOADM. Subsection 2.4 describes the assignment of usercodes.

Note: You must specify the same usercode (usercode-1) when you set up the terminal emulation sessions during Operations Sentinel configuration. See the description of how to configure a terminal emulation session in the Operations Sentinel Administration and Configuration Guide for more information.

USE_PRIVILEGED_SYSTEM_USERCODE_ON_SP_AMS_PORT {TRUE|FALSE}.

specifies whether usercode-3 is to be privileged and have system user status. Usercode-3 is used for security validation of the port connection with the Operations Sentinel server. The default setting is TRUE. If you set this parameter to FALSE, any valid usercode is allowed.

ADM ODT-display-options.

specifies the display options for ODT terminal sessions. The ADM statement specified here is used by the interface software for all ODT sessions opened. The default settings are

ADM (ACTIVE 7, WAITING 3, SCHEDULED 2, COMPLETED 5, MESSAGES) DELAY 9.

You can change the settings in this statement before starting the interface software program.

TERM ODT-terminal-options.

specifies the terminal options for ODT terminal sessions. The TERM statement specified here is used by the interface software for each ODT session that is opened from Operations Sentinel Console. This allows you to override line truncation and other defaults. For example, with the following statement in the configuration file, each ODT terminal session displays each message at its full width and will assume a window size of 30 lines.

TERM TRUNCATE FALSE, LINES 30

See the System Commands Operations Reference Manual for a description of allowable terminal options.

If you do not specify a TERM statement in the configuration file, the interface software does not send terminal options to the MCP. In that case, the preset defaults defined for the MCP are used. These vary with the level of the MCP. For MCP level 57.1 or higher, these defaults include:

TRUNCATE TRUE
LINES 24
WIDTH 80
FIRST 2
RESPONSE EXPANDED
LANGUAGE host-default
CONVENTION host-default

SECURITY_ENABLED {0|1}.

specifies whether host systems running with S2 level security or with S2 level security and the SECADMIN option are enabled to use the auto-logon feature. The auto-logon feature allows terminal emulation sessions initiated at the Operations Sentinel workstation to be automatically opened in remote ODT mode. The default is 0 (false).

For systems with S2 level security

Set the SECURITY_ENABLED parameter in the configuration file to 1 (true).
Make sure that the auto-logon usercode (usercode-1) is a privileged usercode.

For S2 level security with the SECADMIN option enabled

Set the SECURITY_ENABLED parameter in the configuration file to 1 (true).
If a security administrator usercode is used, make sure that the auto-logon usercode (usercode-1) is a security administrator usercode.

If a security administrator usercode is not used, make sure that the auto-logon usercode (usercode-1) is a privileged usercode.

If the host system is not running S2 level security, you must set the SECURITY_ENABLED parameter to 0 (false).

DISK_INTERVAL interval–in–seconds.

defines the length of time from one cycle of threshold checking and utilization reporting to the next. interval–in–seconds can be any value from 10 to 3600. The default is 60.

DATABASE_LEVEL compatibility–level.

Note: Level 2.2 is the last level to support the DATABASE_LEVEL command. Future levels will only send the database level 2 messages.

specifies if the interface software should send messages in the old (A Series) format. If compatibility–level is 1, the interface sends messages only in the old format. If compatibility–level is 2, the interface sends messages only in the new format. If compatibility–level is 1+2, the interface sends messages in both formats. The default is 1+2.

LOG_JOB_USERCODE {YES|NO}

specifies whether or not the usercode is be included with Type 1 log entries when LOG_COMPATIBILITY is 1. See 3.3. The default for LOG_JOB_USERCODE is NO.

RENEW_DISK_ALARMS number–of–intervals.

specifies the number of DISK_INTERVAL intervals the interface waits before resending an alarm message for a threshold or NOT ONLINE violations. You can enter a value from 0 to 1440. For example: if number–of–intervals is 1, the interface sends the alarm each time it checks thresholds and finds a violation. If number–of–intervals is 0, the interface never renews alarms. If this statement is not in the configuration file, number–of–intervals defaults to 0.

ALLOW_AUTOMATED_KEYINS {YES|NO}.

tells the agent to accept (YES) or ignore (NO) keyins from the Operations Sentinel servers connected to it. SPIAPISUPPORT connections are ignored by the interface software when the configuration sets ALLOW_AUTOMATED_KEYINS to NO. The default is YES.

USE_API {YES|NO}.

tells the interface software whether or not to monitor applications connected to the Application Program Interface (API) library. See Section 1 and Section 7. If USE_API is YES, the interface software manages each application connected to the API library. If USE_API is NO, the interface software does not try to monitor these applications. Typically, you should set this parameter to YES if ALLOW_AUTOMATED_KEYINS is YES, and the MCP system runs applications that connect to the API library. If there are no such applications, setting USE_API to NO eliminates some nuisance messages that the interface software otherwise produces. By default, USE_API has the same value as that specified for ALLOW_AUTOMATED_KEYINS. If you specify this parameter, you must place it after the parameter ALLOW_AUTOMATED_KEYINS in the configurations file.

HACKER_DELAY interval-in-seconds.

specifies the length of time to stop listening for new connections when a failed connection suggests that a hacker may be attempting an intrusion. Although it stops listening for new connections, it still processes all information from established connections. Values from 0 to 3600 are accepted. The default is 300 (5 minutes).

STARTDISKNAMES.

signals the beginning of the disk monitoring parameters. Only one is allowed in the file. It must precede disk parameters and ENDDISKNAMES.

Note: Multiple disk monitoring parameters are permitted however they must all be included between the STARTDISKNAMES record and the ENDDISKNAMES record.

disk–family [(index)] [threshold–% [severity]] [AREASIZE area-size].

specifies the name of a disk family or disk unit for which the interface software is to perform disk threshold and/or disk space availability checking.

index

indicates a disk unit within the disk family. If a disk unit is not specified, the entire family is checked.

threshold

% - an integer that defines the monitoring threshold level for the disk family or disk unit. If specified and the disk space goes below this value, an alarm is raised in Operations Sentinel. If not specified, disk space availability information is sent to Status. To raise an alarm and send disk space availability information to Status, there must be at least two configuration entries for this disk or disk family, one with a threshold percentage and one without.

severity

specifies the severity of the alarm generated in Operations Sentinel if this family or unit goes below the threshold value. Use one of the following: CRITICAL, MAJOR, MINOR, or WARNING. The default is MAJOR.

AREASIZE area-size

Specifies the area-size argument (DU on EXAMPLE [area-size]). This may be useful for Data Base families when large DMSII structures are used (DU on DMSPACK 250000).

You must use spaces to separate family name, index, threshold, and severity values.

ENDDISKNAMES

signifies the end of the disk monitoring parameters. Only one is allowed in the file. It must be preceded by STARTDISKNAMES and the disk monitoring parameters.

Two configuration files are supplied on the release media. They are described in 3.5.1 and 3.5.3].

If there is a problem with the configuration file, the interface software program may not execute. These problems can occur with the configuration file:

The configuration file cannot be found.
The configuration file contains errors.

If the interface software cannot find the configuration file, it waits on a NOFILE and does not execute.

If any of the parameters cannot be read, the interface displays a message for each statement that cannot be read, uses the default value, and executes.

These messages displayed on the operator’s ODT result from errors in the configuration file.

If no socket is found:

<<ASPO>> SPO CONFIGURATION FILE: PORT SOCKET NUMBER NOT FOUND.
<<ASPO>> SPO SET DEFAULT SOCKET = 10301.

If no database level is found:

<<ASPO>> SPO CONFIGURATION FILE: DATABASE_LEVEL NOT FOUND.
<<ASPO>> SPO SET DEFAULT DATABASE_LEVEL = 1 + 2.

If no utilization timer is found:

<<ASPO>> SPO CONFIGURATION FILE: UTILIZATION TIMER NOT FOUND.
<<ASPO>> SPO SET DEFAULT UTILIZATION TIMER = 20.

If no filter file is found:

<<ASPO>> LOADING DEFAULT FILTERS.
<<ASPO>> SPO CONFIGURATION FILE: FILTER FILE NOT FOUND.
<<ASPO>> SPO SET DEFAULT FILTERING = name.

These are the default values if the configuration file contains errors:

DEFAULT_SOCKET 10301 if ALLOW_AUTOMATED_KEYINS = YES, otherwise 10302
UTILIZATION_INTERVAL 20
FILTER_FILE_NAME <none>
AUTO_LOGON_USERCODE <none>
USE_PRIVILEGED_SYSTEM_USERCODE_ON_SP_AMS_PORT TRUE
ADM (ACTIVE 7, WAITING 3, SCHEDULED 2, COMPLETED 5, MESSAGES) DELAY 9
TERM <none>
SECURITY_ENABLED 0
DISK_INTERVAL 60
DATABASE_LEVEL 1 + 2
RENEW_DISK_ALARMS 0
ALLOW_AUTOMATED_KEYINS YES
USE_API YES
HACKER_DELAY 300

UTILIZATION_INTERVAL 20 indicates the time interval in seconds between utilization data messages.

FILTER_FILE_NAME <none> indicates that the program uses the default set of filters.

AUTO_LOGON_USERCODE <none> indicates that auto-logon will not be turned on. You should change this.

TERM <none> indicates that preset terminal defaults defined for the MCP are used.

SECURITY_ENABLED 0 indicates that S2 security is not enabled.