This topic describes the Customize Action window in IBM® Director.
Purpose
IBM Director has several predefined event
action types. With the exception of Add to Event Log, you must
customize each event action type that you want to use. You can use the Customize
Action window to customize defined event actions and user-defined (or custom)
event actions displayed in the Event Action Plan Builder.
Predefined event action types
- Add/Remove “event” system to Static Group
- Adds a managed object to or removes a managed object from a specified
static group when the managed object logs a specific event.
- Add/Remove source group members to target static group
- Adds all specified managed objects in a source group to a target group
or removes all specified managed objects from the target group.
- Add a Message to the Console Ticker Tape
- Displays a message in red type that scrolls from right to left at the
bottom of IBM Director Console.
- Add to the Event Log
- Adds a description of the event to the IBM Director event log.
- Define a Timed Alarm to Generate an Event
- Generates an event only if IBM Director does not receive an associated
event within the specified interval.
- Define a Timed Alarm to Start a Program on the Server
- Starts a program on the management server if IBM Director does not receive
an associated event within the specified interval.
- Log to Textual Log File
- Generates a text log file for the event that triggers this action.
- Post a News Group (NNTP)
- Sends a message to a newsgroup using the Network News Transfer Protocol
(NNTP).
- Resend Modified Event
- Creates or changes an event action that modifies and resends an original
event.
- Send an Alphanumeric Page (via TAP)
- Windows only) Sends a message to a pager using the Telocator Alphanumeric
Protocol (TAP).
- Send an Event Message to a Console User
- Displays a pop-up message on the management console of one or more specified
users.
- Send an Internet (SMTP) E-mail
- Sends a Simple Mail Transfer Protocol (SMTP) e-mail message.
- Send an SNMP Inform to an IP host
- Sends an SNMP inform request to a specified IP host.
- Send an SNMP Trap to a NetView Host
- Generates an SNMP trap and sends it to a specified NetView® host using
a TCP/IP connection to the host. If delivery of the SNMP trap fails, a message
is posted in the history log of the managed object.
- Send an SNMP Trap to an IP Host
- Generates an SNMPv1 or SNMPv2c trap and sends it to a specified IP address
or host name.
- Send a Numeric Page
- (Windows only) Sends a numeric-only message to the specified pager.
- Set an Event System Variable
- Sets the managed system variable to a new value or resets the value of
an existing system variable.
- Start a Program on a System
- Starts a program on any managed objects on which IBM Director Agent is
installed.
- Start a Program on the “event” System
- Starts a program on the managed object that generated the event.
- Start a Program on the Server
- In response to an event, starts a program on the management server that
received the event.
- Start a Task on the “event” System
- In response to an event, starts a noninteractive task on the managed object
that generated the event.
- Update the Status of the “event” System
- When the selected resource status generates an event, causes a status
indicator beside the icon of the managed object that is associated with the
resource to be set or cleared according to your specification.
Event-data-substitution variables
For
some event action types, you can include event-specific information as part
of the text message. Including event information is referred to as event
data substitution. You can use these event-data-substitution variables
to customize event actions.
- &date
- Provides the date the event occurred.
- &time
- Provides the time the event occurred.
- &text
- Provides the event details, if they are supplied by the event.
- &type
- Provides the event-type criteria that are used to trigger the event. For
example, the event that is generated when a managed object goes offline is
of type Director.Topology.Offline. This corresponds to the entry on the Event
Type page.
- &severity
- Provides the severity level of the event.
- &system
- Provides the name of the managed object for which the event was generated.
The system name is either the name of IBM Director Agent or, in the case of
an SNMP device, the TCP/IP address.
- &sender
- Provides the name of the managed object from which the event was sent.
This variable returns null if the name is unavailable.
- &group
- Provides the group to which the target object belongs and is being monitored.
This variable returns null if the group is unavailable.
- &category
- Provides the category of the event, either Alert or Resolution. For example,
if the managed object goes offline, the category is Alert. If the managed
object goes online, the category is Resolution.
- &pgmtype
- Provides a dotted representation of the event type using internal type
strings.
- ×tamp
- Provides the coordinated time of the event.
- &rawsev
- Provides the nonlocalized string of event severity (Fatal, Critical, Minor,
Warning, Harmless, Unknown).
- &rawcat
- Provides the nonlocalized string of event category (Alert, Resolution).
- &corr
- Provides the correlator string of the event. Related events, such as those
from the same monitor-threshold activation, will match this.
- &snduid
- Provides the unique ID of the event sender.
- &sysuid
- Provides the unique ID of the managed object that is associated with the
event.
- &prop:file_name#property_name
- Provides the value of the property string property_name from property
file file_name (relative to IBM\Director\classes).
- &sysvar:variable_name
- Provides the event system variable variable_name. This variable
returns null if a value is unavailable.
- &slotid:slot_id
- Provides the value of the event detail slot with the nonlocalized ID slot_id.
- &md5hash
- Provides the MD5 (message digest 5) hash code, or cyclic redundancy check
(CRC), of the event data (good event-specific unique ID).
- &hashtxt
- Provides a full replacement for the field with an MD5 hash code (32-character
hex code) of the event text.
- &hashtxt16
- Provides a full replacement for the field with a short MD5 hash code (16-character
hex code) of the event text.
- &otherstring
- Provides 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 has one event detail that has an ID of key1 and
a value of value1. You can use the substitution variable &soltid: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, “Not applicable”
is returned.