SNMP Trap Trigger

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.

IMPORTANT: Use of the SNMP trigger requires a fundamental comprehension of SNMP, its required protocol data units (PDU) and other related terms, such as NMS or MIB.  

Practical Usage

Used to integrate tasks with other network systems management software.

Parameters

General properties

Property

Description

Agent IP Address

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

  • Any host: If selected, the task will run when an SNMP trap is received from any host with no IP address restrictions (default).

  • A specific host: If selected, the task will only run if an SNMP trap is received from a host within the specified IP Address Range. Selecting this option enables the following:

    • IP Range Start - The starting IP address of the range of acceptable IP addresses.

    • IP Range End - The ending IP address of the range of acceptable IP addresses.

Community

Indicates 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:

  • Any community: The task will run when an SNMP trap is received from any host with no community restrictions.

  • A specific host: The task will only run if an SNMP trap is received from a host within the specified community. Selecting this option enables the following:

    • Community - Specifies the community that the trap must originate from in order to trigger the task.

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:

  • Any Enterprise OID :The task will run when an SNMP trap is received from any enterprise OID with no enterprise OID restrictions.

  • A specific Enterprise OID: The task will only run if an SNMP trap is received from a host within the specified enterprise OID. Selecting this option enables the following:

    • Specific Enterprise OID: Specifies the enterprise OID that the trap must originate from in order to trigger the task.

Trap Generic Type

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

  • Any Type: Any type of event.

  • Enterprise Specific: An enterprise-specific event.

  • Cold Start: Re initialization of the agent with alteration of configuration.

  • Warm Start: Reinstallation of the agent without alteration of configuration.

  • Link Down: Failure in one of the communication links.

  • Link Up: Restoration of one of the communication links.

  • Authentication Failure: Reception of a protocol message not properly authenticated.

  • EGP Neighbor Loss: Loss of an EGP peer relationship of the EGP protocol.

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:

  • Any code: The trigger will listen to traps sent with any Code.

  • A specific code: The trigger will only listen for traps sent with the code specified in the specific code parameter. Selecting this option enables the following:

    • Trap specific type code: Specifies the trap code to monitor.

Data Properties

Property

Description

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 Properties

Property

Description

Trigger on startup if condition is true

If enabled, the system will act upon conditions that already exist upon startup of the current trigger. For example, if the Notepad window is already open on the desktop, a newly created Window trigger set to monitor for the existence of a Notepad window will immediately launch the task as a result. If disabled, the trigger will ignore the open Notepad window upon startup. This parameter is disabled by default.

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. For example, if a Window trigger is set to monitor for the appearance of a Notepad window and this parameter is set to 3, the task will not launch until the third instance of Notepad appears on the desktop.

↑ Top of Page

AMTrigger

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. The AMTrigger fields described below are exclusive only to the SNMP trigger.

Name

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

Date/Time

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

AMTrigger.BindingVarNumber

Number

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

 

↑ Top of Page