logmsg Command-Line Utility
Contents
The logmsg utility enables you to configure log messages to be sent to a specific Message Server on behalf of the specified application. For example, if a specific situation occurs, you can call logmsg to send a log message to a specific Message Server for information purposes or to perform an appropriate action. You can also use logmsg to generate and clear Management Layer alarms based on conditions external to the Management Layer.
Overview
The logmsg utility was developed to serve the need of customer scripts to raise alarms in the Management Layer. It is packaged with Solution Control Server, and uses existing Management Layer functionality to generate and clear Management Layer alarms based on conditions external to the Management Layer. When an external alarm condition is detected, such as by a script, logmsg is called to send a log message with the corresponding Log Event ID. SCS then triggers an active alarm specified by the Alarm Condition identified by the Detect Log Event ID.
logmsg is used by the stuck calls scripts (see Handling Stuck Calls). However, you can also use it independently of the stuck calls scripts, as described in this section.
Installing logmsg
If you installed Solution Control Server 8.5.100.41 and earlier, logmsg is already installed, and is located in the same folder in which Solution Control Server was installed.
Staring with SCS 8.5.100.42 release, the logmsg utility is not installed by default with Solution Control Server. You can install it separately by following the instructions in the section "Solution Control Server Utilities" in the Framework Deployment Guide. After the utilities are installed, logmsg is stored in the location you specified during the installation.
Starting in 8.1.2, you can install the Solution Control Server utilities without installing Solution Control Server itself.
Using the Utility
logmsg is located in the same folder in which Solution Control Server was installed.
All logmsg command parameters are made in a single command. The general syntax is as follows:
logmsg -h <host> -p <port> -lmid <ID> -aname <name> -atype <type> -adbid <dbid> -hname <host>[-urgent <level>] -lmtext <text> [-lmattfile <filename>]
The parameters are described in the following table, and are mandatory unless stated otherwise in the table.
Configuring Alarms for Events External to the Management Layer
You can also use logmsg to generate and clear Management Layer alarms based on conditions external to the Management Layer. For example, you may configure an alarm to be triggered in response to a stuck call.
When an external alarm condition is detected, such as by a script, call logmsg to send a log message with the corresponding Log Event ID. SCS then triggers an active alarm specified by the Alarm Condition identified by the Detect Log Event ID.
Before you use this utility for this purpose, you must configure one Alarm Condition object for each condition for which an alarm is to be triggered. Each condition must specify a Detect Log Event ID and a Cancel Log Event ID.