Correlation Actions environmental variables
When the program is launched using the Correlation > Actions program, the following environmental variables are set prior to the action program’s execution and can be used by the action program as part of its function. The list of environmental variables for correlation actions is provided as follows. (Refer to the section on BMC-Defender-Server-tickets for a similar list associated with ticket actions.)
Variable | Description |
|---|---|
S_TIME | This is the time of the message, in YYYY/MM/DD HH:MM:SS format. It is the time that the message was received (that might be slightly different from any time embedded in the message.) |
S_TIMESTAMP | This is an integer number representing the number of seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time, according to the system clock. This might be useful for certain actions that update database tables. |
S_ADDRESS | This is the IP Address of the device that sent the message. |
S_FACILITY | This is the textual description of the facility code that was incorporated within the message. The value is in lower case and is identical to the facility names shown on the various BMC Defender Server pages. |
S_FACILITY_NUMBER | This is identical to the S_FACILITY value, except is the facility expressed as an integer number in the range of 0 to 23. If the facility is a user defined facility code, then the value is 1 (corresponding to the standard user facility code.) The S_FACILITY value, as described previously , reflects the name of the actual user-defined specified facility. |
S_SEVERITY | This is the textual description of the severity code that was incorporated within the message. The value is in lower case and is identical to the severity names shown on the various BMC Defender Server pages. |
S_SEVERITY_NUMBER | This is identical to the S_SEVERITY value as described previously, except is the severity expressed as an integer number in the range of 0 to 7. |
S_MESSAGE | This is the message portion of the received message, and can be 1024 characters or less. |
S_USERNAME | This is the user name (if any) parsed from the message. The username is a value that is contained in the Messages > Users tab of the program. If no user name exists in the message, the value is blank. |
S_SUMMARY | This is similar to the message, except that all punctuation marks are removed, spaces are collapsed, and the text is limited to 120 characters. This is mainly useful for entering text into a database table. (See the RUNSQL.bat discussion, as follows.) |
S_ACTION_NAME | This is the value of the action name, configured on the Edit Correlation Action page. This can be used as meta-data by the script, independent of any other arguments to the script. |
S_SANITIZE | This value is either Yes or No, reflecting the value selectable at the bottom of the Edit Ticket Action page. If Yes, then the value of environmental variables are sanitized (that is special characters such as < > | and others are removed or substituted to assist with batch file programming. If set to No, then the message contains special characters. (See additional notes as follows on Sanitize Environmental Variables ). |
The preceding environmental variables are set prior to the execution of any action program by the CO-Catlog.exe service, and are in addition to any ordinary environmental variables that exist (such as PATH, and COMSPEC.)
This section provides information about the following topics:
Related topic