You can use the following event-data-substitution variables.
Note: Any
of the substitution variables can have a null value. In that case, the localized
version of the string "Not Applicable" is returned.
- &date
- The localized date on which the event occurred.
Example: 7/23/2007
- &time
- The localized time at which the event occurred.
Example: 2:32 PM CDT
- &text
- The event details, if they are supplied by the event.
Example: System moonlite is offline with errors.
- &type
- The event-type criteria that were used to trigger the event. For example,
the event that is generated when a system goes
offline is of type Director > Topology > Offline. This type corresponds to
the entry on the Event Type page.
Example: ComputerSystem
or Processor
- &severity
- The severity level of the event.
Example: Informational
- &system
- The IP address or host name of the system on
which the event was generated. The system name is either the name of the system
running Common Agent or, in
the case of an SNMP device, the TCP/IP address.
Example: moonlite
- &sender
- The name of the system that
sent the event. This can be different from the &system value if the event
was forwarded or transmitted through an intermediate system. This variable
returns a null value if the name is unavailable.
Example: moonlite
- &group
- The group to which the target system belongs
and that is monitoring the system.
This variable returns a null value if the group is unavailable.
Example: TestHardwareGroup
- &category
- The category of the event, either Alert or Resolution. For example, if
the system goes offline,
the category is Alert. If the system goes
online, the category is Resolution.
Example: Alert
- &pgmtype
- The fully qualified representation of the event type using internal type
strings (ComponentCategory.ComponentType).
Examples: ManagedElement.ManagedSystemElement.LogicalElement.LogicalDevice.System.ComputerSystem
ManagedElement.ManagedSystemElement.LogicalElement.LogicalDevice.Processor
- ×tamp
- The long value timestamp of the time that the event occurred, in milliseconds,
since 1/1/1970 12:00 AM GMT.
Example: 1185219178228
- &rawsev
- The nonlocalized string of event severity. Non-localized string of the
event severity.
Example: Any of the
following strings: “FATAL”, “CRITICAL”, “MINOR”, “WARNING”, “INFORMATIONAL”,
“UNKNOWN”.
- &rawcat
- The nonlocalized string of event category.
Example: Any of the following strings: “ALERT”, “RESOLUTION”.
- &corr
- An internally generated correlation identifier for this event. This identifier
allows an alert event to be correlated with a resolution event,
thereby indicating that the problem that caused the alert has been corrected.
The length of this string can vary.
Example: 1883481972341237
- &snduid
- The unique ID of the event sender.
Example: 7F153619BA2D7861
- &sysuid
- The unique ID of the system that
is associated with the event.
Example: 4309132478791324
- &prop:file_name#property_name
- The value of the property string property_name from property file file_name. file_name can
include the absolute directory path or the relative path to the IBM\Director\classes
directory.
Note: For IBM® i,
you must use the absolute directory path.
The properties file contains
key=value pairs. property_name is the name of a key in the properties
file. The value of the specified property is returned. The value can be any
string, depending on the purpose and contents of the properties file.
Examples: &prop:logging.properties#SystemErr.level = INFO
&prop:encoding.properties#zh = UTF-8
&prop:security.properties#enableAuthentication = TRUE
- &sysvar:variable_name
- The string value of a variable, variable_name, previously set in
the IBM Systems
Director sysvar file.
Variables can be set in this file using the Set an event system variable event
action. The variable name and value can be any string. This variable returns
null if a value is unavailable. For information about the event action, see "Set
an event system variable."
Examples: &sysvar:DEBUG_SETTING = DEBUG_ON
&sysvar:IP = 9.3.44.150
- &slotid:slot_id
- The nonlocalized ID slot_id is the identifier of event details
contained within the event. An event might include any number of event details.
This substitution variable is used to retrieve those details. The user must
know the identifier of the event detail that they want. The value can be any
string as defined by the component that generates the event.
Example: &slotid:Suppressions = “3 instances of this condition
have been suppressed.”
- &otherstring
- If any other word is preceded by an &, it is treated the same as the
slot_id in the previous &slotid:slot_id variable. The otherstring string
is used as an identifier to locate event details contained with the event.
The
value of the detail slot that has a localized label that matches otherstring.
A detail slot is a record in an event detail. For example, an event
might have one event detail that has an ID of key1 and a value of value1.
You could use the substitution variable &slotid:key1 to obtain
the value value1. You also can use &key1 to obtain the value value1.
In the description above, otherstring is a placeholder for the user-defined
event detail ID. However, if the passed ID is not found, the value Not
applicable is returned.
Example: &Suppressions
= “3 instances of this condition have been suppressed.”