SNMP Trap Trigger

See Also

Introduction to Triggers, Available Triggers, Using AMTrigger, Setting a SNMP Trap Watcher

Description

Launches a task when a SNMP (Simple Network Management Protocol) trap is received. A trap is a message sent by an agent to a management system indicating that an event has occurred on the host running the agent. This trigger accepts filters which can be specified to monitor for specific traps.

Practical Usage

Used to integrate tasks with other network systems management software.

Parameters

General Tab

Agent IP Address

Specifies whether the trigger will start the task when an SNMP trap is received from any device or only devices within a specific IP range. The available options are:

 

Community

Specifies whether the trigger will start the task when an SNMP trap is received from any community or only devices within a specific community. The available options are:

 

Enterprise OID

Specifies whether the trigger will start the task when an SNMP trap is received from any Enterprise OID or only devices within a specific Enterprise OID. The available options are:

 

Trap Generic Type

Specifies whether the trigger will filter out traps that are not intended for a specific generic type. The available options are:

 

Trap Specific Type

Causes the trigger to capture the type of the trigger if Enterprise Specific is selected for Trap Generic Type. The available options are:

 

Data Tab

 

Use String notation for OIDs

If enabled, specifies that string notation is used for object identifiers (enabled by default).

Use String notation for timetick values

If enabled, specifies that string notation is used for timetick values (enabled by default).

Behavior Tab

Trigger after the condition has been met 'X' times.

If enabled, specifies how many times the trigger condition must be met before the task is started (disabled by default). This parameter is available in all triggers except the Schedule Trigger.

AMTrigger Parameters

When this trigger is activated, it automatically passes the "AMTrigger" object to the task. AMTrigger can be used within a task to determine whether or not the task was started by a trigger, which trigger started the task, when the trigger was activated and other trigger related properties. For more details, see Using AMTrigger.

Common AMTrigger Fields

Every instance of AMTrigger populates a list of common fields which are described in the table below.

Name

Data Type

Return Value

AMTrigger.Trigger

String

Returns the name of the event or condition that triggered the task. Each event or condition contains a unique name. For this trigger, the value is always AMSNMPTRIGGER.

AMTrigger.TaskName

String

Returns the name of the managed task that the trigger was attached to. Useful to determine the responsible task when two managed tasks point to the same AML file.

AMTrigger.TriggerredDateTime

String

Returns the date and time when the trigger occurred.

AMTrigger.TriggeredOn

String

Returns the machine name where the trigger occurred.

AMTrigger.WasLocked

Boolean

If the workstation was locked when the trigger occurred, the value returned is 1. Otherwise, it will be 0.

AMTrigger.WasLoggedOff

Boolean

If the workstation was logged off when the trigger occurred, the value returned is 1. Otherwise, it will be 0.

AMTrigger.AML

String

Returns a verbose set of information about the triggered event or condition in AML (AutoMate Markup Language) format.

 

Specific AMTrigger Fields

The AMTrigger fields described below are exclusive only to the SNMP trigger.

Name

Data Type

Return Value

AMTrigger.GenericType
 

Text

Returns the generic type for the SNMP trap when the task was triggered. Possible return values are:

  • enterprisespecific: an enterprise-specific event has occurred

  • coldstart: reinitialization of the agent with alteration of configuration

  • warmstart: reinitialization of the agent without alteration of configuration

  • linkdown: failure in one of the communication links

  • linkup: restoration of one of the communication links

  • authenticationfailure: reception of a protocol message not properly authenticated

  • egpneighborloss: loss of an EGP peer relationship of the EGP protocol

AMTrigger.SpecificType

Text

Returns the specific type for the SNMP trap when the task was triggered.

AMTrigger.ObjectType

Text

Returns the object type for the SNMP trap when the task was triggered.

AMTrigger.Host

Text

Returns the host specified in the SNMP trap when the task was triggered.

AMTrigger.Community

Text

Returns the community specified in the SNMP trap when the task was triggered.

AMTrigger.TimeStamp

Text

Returns the timestamp specified in the SNMP trap when the task was triggered.

AMTrigger.BindingVarNumber

Text

Returns the total number of variables that were sent with the SNMP trap.

AMTrigger.VarName[i]

Text

Returns the associated variable name that was sent with the SNMP trap. Use AMTrigger.BindingVarNumber to find the total number of available variables. To use this property, simply append the number to the end if the property name - it is not an array. Example %AMTrigger.VarName2%

AMTrigger.VarValue[i]

Text

Returns the associated variable value that was sent with the SNMP trap. Use AMTrigger.BindingVarNumber to find the total number of available variables. To use this property, simply append the number to the end if the property name - it is not an array. Example %AMTrigger.VarValue2%.

AMTrigger.VarSyntax[i]

Text

Returns the associated variable syntax (such as integer) that was sent with the SNMP trap. Use AMTrigger. BindingVarNumber to find the total number of available variables. To use this property, simply append the number to the end if the property name - it is not an array. Example %AMTrigger.VarSyntax2%.

 

NOTE: A full list of AMTrigger objects exclusive to each trigger can be viewed from the Expression Builder by expanding Objects -> Triggers and selecting the desired trigger.

See Also

Setting a SNMP Trap Watcher

About Triggers

All Available Triggers

Using AMTrigger