11.16 NTEventLog

Use this Knowledge Script to write AppManager event information to the Windows event log. By default, the event is written to the Windows Application event log on the computer where the Action is initiated. You can select another event log where the event will be written, and you can select the event type: Error, Warning, or Information. You can also specify a custom event message or use the default message.

NOTE:This Action is performed on all physical nodes of a cluster when the NTEventLog Knowledge Script runs on a cluster server.

11.16.1 Setting Parameter Values

Set the following parameters as needed:

Parameter	How to Set It
Event Notification
Event severity -- Action warning	An event is raised when you select the custom message format but neglect to enter any text for the custom message body. Under these circumstances, the script continues to execute and uses the standard message format. Set the severity level, from 1 to 40, to indicate the importance of an event in which the NTEventLog job returns a warning. The default is 35 (magenta event indicator).
Event severity -- Action failure	Set the severity level, from 1 to 40, to indicate the importance of an event in which the NTEventLog job fails. The default is 5 (red event indicator).
Severity Configuration
Minimum event severity for Action	Set the minimum severity level, from 1 to 40, for an event that triggers this Action. The default is 1.
Maximum event severity for Action	Set the maximum severity level, from 1 to 40, for an event that triggers this Action. The default is 40.
Action
Event log name	Select the log where the event message is written. The default is Application.
Event type	Select the type of event message. The default is Error.
Destination computer	Provide the name or IP address of the computer to whose log the event message is written. Leave this parameter blank for a local computer. You can also click Browse [...] to select from a list of computers in the same domain as the agent computer.
Event source	Specify a name for the source of the event. The default is AppManager.
Event category	Specify a numerical identifier for the event category. Enter a number from 0 to 32766. The default is 0.
Event ID	Specify a numerical ID for the event. Enter a number from 0 to 65535. The default is 260.
Message format	Select the format you want to use for the message sent by this script: Standard format generates a message based upon the selections you make from the Standard message options parameters. Custom format generates a message based upon the subject and message body you supply in the Custom message options parameters. The default is Standard.
Standard Message Options
Include date/timestamp?	Select Yes to include the date/timestamp in the standard message. The default is unselected.
Include JobID?	Select Yes to include the job ID in the standard message. The default is unselected.
Include agent computer name?	Select Yes to include the name of the agent computer in the standard message (the computer hosting the agent that initiated the Action). The default is Yes.
Include event severity?	Select Yes to include the severity of the event in the standard message. The default is Yes.
Include Knowledge Script name?	Select Yes to include the Knowledge Script name in the standard message (the Knowledge Script that initiated the Action). The default is unselected.
Include AppManager object name?	Select Yes to include the AppManager resource object name in the standard message (the AppManager resource object where the event was raised). The default is unselected.
Include AppManager event ID (only on MS Action)?	Select Yes to include the AppManager event ID in the standard message (possible only in cases when the Action is carried out by the management server). The default is unselected.
Include event detail message?	Select Yes to include the event detail message. The default is unselected.
Custom Message Options
Custom text (can include substitutions)	Provide the text you want to include in your custom message. You can use the keywords listed below to indicate the information you want to include in the body of your custom message. Add a space before and after keywords to ensure that the keywords display properly. $ShortMsg$ (short event message) $DetailMsg$ (detailed event message) $Time$ (date and time of the event) $JobID$ (ID of the job that raised the event) $MachineName$ (name of the computer where the event was raised) $Severity$ (severity of the event) $KSName$ (name of the Knowledge Script that raised the event) $ObjectName$ (name of the AppManager resource object where the event was raised) $EventID$ (event ID) For $ShortMsg$ and $DetailMsg$ you can use number and wildcard options to indicate specific portions of the text string to include. For example: $DetailMsg$[5] includes the fifth word of the detailed event message $ShortMsg$[1-5] includes the first through fifth words of the short message event $DetailMsg$[5] includes the first through fifth words of the detailed event message $ShortMsg$[5] includes the fifth through last words of the short event message If you do not enter a word specifier, AppManager returns the entire string. The following are examples of the types of messages you can construct using these keywords: Event from $MachineName$: The $ShortMsg$[1-3] has failed. The last command was $DetailMsg$[4*]. A severity $Severity$ event has occurred! Call the owner of $MachineName$ immediately!