ALARMPROGRAM configuration parameter

Use the ALARMPROGRAM configuration parameter to specify the full pathname of the alarmprogram file that handles event alarms and controls logical-log backups.

onconfig.std value
On UNIX™: $INFORMIXDIR/etc/alarmprogram.sh

On Windows™: %INFORMIXDIR%\etc\alarmprogram.bat

if not present
On UNIX: $INFORMIXDIR/etc/no_log.sh

On Windows: %INFORMIXDIR%\etc\no_log.bat

value
pathname = Full path name of the alarmprogram file.
takes effect
After you edit your onconfig file and restart the database server.
When you reset the value dynamically in your onconfig file by running the onmode -wf command.
When you reset the value in memory by running the onmode -wm command.

Usage

You can set the ALRM_ALL_EVENTS configuration parameter to specify whether the ALARMPROGRAM configuration parameter runs for all events that are logged in the MSGPATH, or only for specified noteworthy events (events greater than severity 1).

If the script that the ALARMPROGRAM configuration parameter specifies does not exist, the default alarm handler, no_log.sh or no_log.bat, is substituted. After you have the correct script in place, update the value of the ALARMPROGRAM configuration parameter to specify the script. You can make this update with the server online by using the onmode -wm command.

The following sample scripts are provided.
Table 1. Sample scripts
Script name (UNIX) Script name (Windows) Description
log_full.sh log_full.bat To back up logical logs automatically when the database server issues a log-full event alarm, set ALARMPROGRAM to log_full.sh or log_full.bat.

You can modify the script and set it to the full path of ALARMPROGRAM in the onconfig file.

no_log.sh no_log.bat To disable automatic logical-log backups, set ALARMPROGRAM to no_log.sh or no_log.bat.
alarmprogram.sh alarmprogram.bat Handles event alarms and controls logical-log backups. Modify alarmprogram.sh or alarmprogram.bat and set ALARMPROGRAM to the full path name of alarmprogram.sh or alarmprogram.bat. See Customizing the ALARMPROGRAM Scripts.

Instead of using the supplied scripts, you can write your own shell script, batch file, or binary program to execute events. Set ALARMPROGRAM to the full pathname of this file. The database server executes this script when noteworthy events occur. These events include database, table, index, or simple-large-object failure; all logs are full; internal subsystem failure; initialization failure; and long transactions. You can have the events noted in an email or pagermail message.

To generate event alarms, set ALARMPROGRAM to $INFORMIXDIR/etc/alarmprogram.sh or %INFORMIXDIR%\etc\alarmprogram.bat and modify the file according.

Important: When you choose automatic logical-log backups, backup media should always be available for the backup process.

Do not use the continuous log backup command (onbar -b -l -C) if you have automatic log backup setup through the ALARMPROGRAM parameter.