Message content or counters — Legacy
This option allows you to choose a variable or counter from a pop-up menu. The variable is then replaced with the current value before the message is sent. For example, %MsgText
is replaced with the text of the current syslog message.
To add a variable:
- Position your cursor where you want to insert the variable.
- Click Insert message content or counter.
- Select a variable.
The following variables are available.
All of the message
Parameter |
|
Explanation |
The entire message as it appears on the display, including the time, date, priority and message text. Each field is space delimited. |
Example |
|
Date
Parameter |
|
Explanation |
The date the message arrived in the format YYYY-MM-DD. |
Example |
|
Time
Parameter |
|
Explanation |
The time the message arrived in the format HH:MM:SS. |
Example |
|
Facility
Parameter |
|
Explanation |
The facility of the message in text format. |
Example |
|
Level
Parameter |
|
Explanation |
The level of the message in text format. |
Example |
|
Host address of sender
Parameter |
|
Explanation |
The host IP address of the sending device. |
Example |
|
The message text
Parameter |
|
Explanation |
The message text part of the syslog message. |
Example |
|
Alarm min msg threshold
Parameter |
|
Explanation |
The threshold level set for the minimum message count alarms. |
Example |
|
Alarm max msg threshold
Parameter |
|
Explanation |
The threshold level set for the maximum message count alarms. |
Example |
|
Alarm disk space threshold
Parameter |
|
Explanation |
The threshold level set for the minimum disk space remaining in MB. |
Example |
|
Message count this hour
Parameter |
|
Explanation |
The number of messages received so far this hour. |
Example |
|
Message count last hour
Parameter |
|
Explanation |
The number of messages received in the last hour. |
Example |
|
Machine MAC address
Parameter |
|
Explanation |
The MAC address value of the first network adaptor found. |
Example |
|
Rule Name
Parameter |
|
Explanation |
The name of the Rule that triggered this action. |
Example |
|
Custom/Global/Statistics fields (Only in the registered edition)
VarCustom01 to VarCustom16
Parameter |
|
Explanation |
There are 16 custom fields that can be modified by the Run Script action. If these fields are not modified by the script, they remain blank. Be aware that a blank autosplit value may result in an invalid file name. The custom field values are cleared when a new message arrives. They are only valid for the current message. To store values longer than a single message, use |
Example |
Any value that the script creates can be used. |
VarGlobal01 to VarGlobal16
Parameter |
|
Explanation |
There are 16 global fields that can be modified by the Run Script action. If these fields are not modified by the script, they remain blank. Be aware that a blank autosplit value may result in an invalid file name. The global fields retain their value between messages. |
Example |
Any value that the script creates can be used. |
VarStats01 to VarStats16
Parameter |
|
Explanation |
There are 16 statistics fields that can be modified by the Run Script action. The statistics fields retain their value between messages. You can modify the names associated with the statistics fields and their initial value from the Script options section on the setup window. The custom statistics values are viewable on the statistics display and on the daily statistics e-mail. |
Example |
Any value that the script creates can be used. |