Designing and Managing Behavior Models - Alarm Actions - Perl
Subroutine - NerveCenter Variables
-
NerveCenter defines a number of variables for use in Perl subroutines, Command Alarm actions, and logging actions. These variables contain information about the alarm transition that just occurred and about the trigger that caused the transition.
The variables (and functions) available to you for use in poll conditions, trigger functions, Action Router rule conditions, and Perl Subroutine alarm actions are summarized in a pop-up menu for Perl accessible via a right mouse click in the respective editing area. (See the section, Using the Pop-Up Menu for Perl, for more information.)
The variables available to you for use in Command Alarm actions and the logging actions are available to you via the Special Symbol drop-down listbox.
The complete list of NerveCenter variables that you can use are shown in the table below:
|
Variable |
Contains |
|
AlarmInstanceID |
String. The unique identifier for an alarm instance managed by a NerveCenter Server. If you are connected to more than one server, you can use the $NCHostName variable to identify the server associated with the alarm instance. |
|
AlarmName |
String. The name of the alarm whose instance just underwent a transition. |
|
AlarmProperty |
String. The name of the alarm’s property. |
|
AlarmTransitionTime |
String. The time at which the alarm transition occurred. This time is formatted as follows: mm/dd/yyyy hh:mm:ss day. An example of an alarm transition time is 06/02/1998 11:02:26 Tue. |
|
DestState |
String. The state of the alarm instance following the current transition. |
|
DestStatePlatformSev |
String. The network management platform severity that is mapped to $DestStateSev. |
|
DestStateSev |
String. The severity of the state where the transition ended. |
|
NCHostName |
String. The NerveCenter Server associated with an alarm instance. |
|
$NewMaxNodePlatformSev |
String. The network management platform severity that is mapped to $NewMaxNodeSev. |
|
$NewMaxNodeSev |
String. The maximum severity associated with a node, following the current transition. This maximum severity is determined by looking at the states of all alarm instances that are monitoring the node. |
|
$NodeAddress |
String. The IP address of the node being monitored. |
|
$NodeAddressList |
String. A comma-separated list of all the IP addresses associated with the node being monitored. No white space is allowed in this list. |
|
$NodeName String. |
The name of
the node being monitored by the alarm instance that underwent the transition. |
|
$NodePropertyGrp |
String. The property group of the node being monitored. |
|
$NoOfVarBinds |
Number. The number of variable bindings in the trigger that caused the alarm transition. These variable bindings may have been derived from a poll condition or an SNMP trap. |
|
$OpcApplication |
String. If an IT/Operations message caused the transition, this variable contains the value of the application field in the message. |
|
$OpcGroup |
String. If an IT/Operations message caused the transition, this variable contains the value of the message-group field in the message. |
|
$OpcMessage |
String. If an IT/Operations message caused the transition, this variable contains the value of the message-text field in the message. |
|
$OpcMsgId |
String. If an IT/Operations message caused the transition, this variable contains the value of the message-number field in the message. |
|
$OpcNodeName |
String. If an IT/Operations message caused the transition, this variable contains the value of the node field in the message. The node referred to in this field is the one on which the condition being reported occurred. |
|
$OpcObject |
String. If an IT/Operations message caused the transition, this variable contains the value of the object field in the message. |
|
$OpcSeverity |
String. If an IT/Operations message caused the transition, this variable contains the value of the severity field in the message. |
|
$OpcType |
String. If an IT/Operations message caused the transition, this variable contains the value of the message-type field in the message. |
|
$OrigState |
String. The state of the alarm instance prior to the current transition. |
|
$OrigStatePlatformSev. |
String. The network management platform severity that is mapped to $OrigStateSev |
|
$OrigStateSev |
String. The severity of the state where the transition began. |
|
$PollKey |
String. If a poll caused the transition, this variable contains a value that uniquely describes the poll and the alarm instance with which it interacted. That value has the format pollID.nodeID.baseObject.instance. $PollKey is usually used as an index into a Perl hash. |
|
$PrevMaxNodePlatformSev |
String. The network management platform severity that is mapped to $PrevMaxNodeSev. |
|
$PrevMaxNodeSev |
String. The maximum severity associated with a node, prior to the current transition. This maximum severity is determined by looking at the states of all alarm instances that are monitoring the node. |
|
$ReadCommunity |
String. The read community string of the node being monitored. |
|
$TrapPduAgentAddress |
String. If an SNMP trap caused the transition, this variable contains the trap’s agent address. |
|
$TrapPduCommunity |
String. If an SNMP trap caused the transition, this variable contains the trap’s community string. |
|
$TrapPduEnterprise |
String. If an SNMP trap caused the transition, this variable contains the trap’s enterprise OID. |
|
$TrapPduGenericNumber |
Number. If an SNMP trap caused the transition, this variable contains the trap’s generic trap number. |
|
$TrapPduSpecificNumber |
Number. If an SNMP trap caused the transition, this variable contains the trap’s specific trap number. |
|
$TrapPduTime |
Number. If an SNMP trap caused the transition, this variable contains the trap’s timestamp. |
|
$TriggerBaseObject |
String. The base object portion of the trigger’s subobject attribute. For example, if the trigger’s subobject is IfEntry.2, the base object is ifEntry. |
|
$TriggerInstance |
Number. The instance portion of the trigger’s subobject attribute. For example, if the trigger’s subobject is IfEntry.2, the instance is 2. |
|
$TriggerName |
String. The name of the trigger that caused the alarm transition. |
|
$VarBinds |
String. The list of all variable bindings in the form attribute=value. In the case of Perl subroutines and Action Router rules, it makes sense to use attribute name, value or object for an individual variable binding. |
|
$VB(n) |
String. The
nth variable binding. You can use $VB(n) in Log to File and Log Database
alarm actions only. |
|
$WriteCommunity |
String. The
write community string of the node being monitored. |
|
Previous:
Functions for Use in Perl Subroutines |
|
|
Next: Perl Subroutine Example |
|
|
Please send comments or corrections to
Information
Development |
This file was
last updated on 10 October © 2002 |