Message Event Reports Syntax

Format

TYPE=ME | CLASS=object-class
				| INSTANCE=objec-name
				| APPL=application-name
			[ | APPLQUAL=application-qualifier ]
				| TEXT=message-text

object-class

object-class and object-name identify the system to which the log message or automation applies. The class of a system can be any of the base classes, or any class derived directly or indirectly from one of the base classes. Only the object name is used to determine which Operations Sentinel log the event is written to.

object-name

object-name is the name of the Windows or Linux system that is the originator of the console message. This name must match the name of the system as identified by the Windows/Linux Agent monitoring that system.

To appear in the automation control table of Operations Sentinel Console, this name must also match the name that was specified as the system name in the Operations Sentinel configuration. object_name is case insensitive.

SP-AMS Consideration [MCP, UNIX]

You can use the variable \_HOSTID\ to substitute the name of the systemthat sent the matched message.

application-name

application-name is the name of the application that sent the event report. This attribute is required. It is used only when logging the message.

Reserved Names

See table in “AL Event Reports Syntax” for the names of processes internal to Operations Sentinel. Do not use them as the application name in event reports. These names are case sensitive, as all are application-name attribute values.

application-qualifier

application-qualifier further qualifies the program that sent the request. It is commonly used to distinguish between one instance of the application and another. This attribute is optional. It is used only when logging the message.

Message Text

message-text is the text of the console message.

Formatting Multiline Text

To create multiline log text, enter the correct number of escape characters (\) before the newline character (\n) as follows.

From the program spo_event, use the sequence \n.
From a program that is writing to spo_pipe, use a newline character.
From a shell command or script writing to spo_pipe, use the sequence \n.
From an action in an AMS database, use the sequence \\n.

Including a Backslash in Text

To include a backslash (\) in text, you must enter multiple characters, because a backslash has a special meaning in certain contexts.

From spo_event or from a shell command, script, or C, C++, or C# program writing to spo_pipe, use two backslashes (\\).
[OS 2200, MCP, UNIX]
From an AMS database, use four backslashes (\\\\).

Note: Using an incorrect number of escape characters can result in a truncated event report.

Example

The following example shows an event report sent to Operations Sentinel Console from a Windows monitored system.

TYPE=ME | CLASS=Windows System
				| INSTANCE=ntsys
				| APPL=spo_pipe
				| APPLQUAL=test
				| Text=Sample_message_text