Commands Reference, Volume 4

notifyevent Command

Purpose

Mails event information generated by the event response resource manager (ERRM) to a specified user ID.

Syntax

notifyevent [-h] [user-ID]

Description

The enotifyevent script always return messages in English. The language in which the messages of the notifyevent script are returned depend on the locale settings.

These scripts capture event information that is posted by the event response resource manager (ERRM) in environment variables that are generated by the ERRM when an event occurs. These scripts can be used as actions that are run by an event response resource. They can also be used as templates to create other user-defined actions.

See the RSCT Guide and Reference to understand how an event response resource runs an action command.

Event information is returned about the ERRM environment variables that are listed and described in the RSCT Guide and Reference, and also includes the following:

Local Time

Time when the event or rearm event is observed. The actual environment variable supplied by ERRM is ERRM_TIME. This value is localized and converted to readable form before being displayed.

These scripts use the mail command to send event information to the specified user ID. When a user ID is specified, it is assumed to be valid, and it is used without verifying it. If a user ID is not specified, the user who is running the command is used as the default.

user-ID is the optional ID of the user to whom the event information will be mailed. If user-ID is not specified, the user who is running the command is used as the default.

Flags

-h

Writes the script's usage statement to standard output.

Parameters

log_file

Specifies the name of the file where event information is logged. An absolute path for the log_file parameter should be specified.

The log_file is treated as a circular log and has a fixed size of 64KB. When log_file is full, new entries are written over the oldest existing entries.

If log_file already exists, event information is appended to it. If log_file does not exist, it is created so that event information can be written to it.

Exit Status

0

Command has run successfully.

Restrictions

1. These scripts must be run on the node where the ERRM is running.
2. The mail command is used to read the file.

Standard Output

When the -h flag is specified, the script's usage statement is written to standard output.

Examples

1. Specify user1 in Web-based System Manager to send mail to a user. The event response resource manager then runs the following command:

   /usr/sbin/rsct/bin/notifyevent user1

2. You can use the mail command to read the contents of the event information. The following example shows how a warning event for the /var file system (a file system resource) is formatted and logged:

   ========================================================================
   Event reported at Sun Mar 26 16:38:03 2002
    
   Condition Name:		 			/var space used
   Severity:					Warning
   Event Type:		 			Event
   Expression: 					PercentTotUsed>90
    
   Resource Name:					/var
   Resource Class Name:				IBM.FileSystem
   Data Type:					CT_UINT32
   Data Value:					91

Location

/usr/sbin/rsct/bin/enotifyevent

Contains the enotifyevent script

/usr/sbin/rsct/bin/notifyevent

Contains the notifyevent script

Related Information

Commands: mail

Books: see the RSCT Guide and Reference for information about the event response resource manager (ERRM) and about how to use ERRM environment variables