SNMP Trap Condition

See Also

Setting a SNMP Trap Condition, About Conditions, All Available Conditions, Using AMTrigger, Using AMCondition

Description

Launches task when a SNMP trap is received.  Specify filters to watch for specific traps.  An SNMP trap is a message sent by an agent to a management system indicating that an event has occurred on the host running the agent.

Practical Usage

Used to integrate tasks with other network systems management software.

Parameters

General Tab

Agent IP Address

Specifies whether the condition 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:

any host:  The task will run when an SNMP Trap is received from any host with no IP address restrictions.

a specific host: The task will only run if an SNMP Trap is received from a host within the specified IP Address Range.

IP Range Start: Specifies the starting IP address of the range of acceptable IP addresses.

IP Range Ends: Specifies the ending IP address of the range of acceptable IP addresses.

Community

Specifies whether the condition 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.

Community: Specifies the community that the trap must originate from in order to condition the task.

Enterprise OID

Specifies whether the condition 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.

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

Trap Generic Type

Specifies whether the condition will filter out traps that are not intended for a specific generic type.

The available options are:

Trap Specific Type

Causes the condition to capture the type of the condition if "Enterprise Specific" is selected for "Trap Generic Type"

The available options are:

any code: The condition will listen to traps sent with any Code.

a specific code: The condition will only listen for traps sent with the code specified in the specific code parameter.

Trap specific code type:

Data Tab

Use String notation for OIDs
Boolean
Use String notation for timetick values
Boolean

Behavior Tab

All available Conditions contain Behavior properties that dictate how it should handle a monitored event or condition. These properties determine whether the Condition should act as a trigger, a wait object or conditional (or decision making) object. By default, new Conditions are set to wait for the specified event/condition indefinitely, allowing it to act as a trigger object. For more details, see Condition Behavior.

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 AMSERVICETRIGGER.

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 in the table below are specific only to Performance triggers.

Name

Data Type

Return Value

AMTrigger.GenericType

 

Text

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

The 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%.

 

AMCondition Parameters

Each Event or Condition contains its own set of unique AMCondition values. Therefore, the total number of fields that AMConditon creates during runtime and what they are called depend largely on the condition that was activated. However, every instance of AMCondition is populated with the following general fields:

Name

Data Type

Return Value

AMCondition.Agent

String

Returns the name of the agent where the condition activated.

AMCondition.DateTime

String

Returns the date and time of when the condition occurred.

AMCondition.Name
 

String

Returns the name of the activated condition. Each condition contains a unique name. For example, if the File condition was initiated, the value returned would be . See the help topic for each condition to determine that object's unique name.

AMCondition.Result
 

String

Returns the result of the activated condition (True or False).

AMCondition.WasLocked

Boolean

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

AMCondition.WasLoggedOff

Boolean

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

AMCondition.AML

String

Returns verbose data about the activated condition in AutoMate Markup Language (AML) format.

 

Specific AMCondition Fields

The AMCondition fields described in the table below are specific only to the Performance Condition.

Name

Data Type

Return Value

AMCondition.GenericType

 

Returns the generic type for the SNMP trap when the condition was activated.

The 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

AMCondition.SpecificType

 

Returns the specific type for the SNMP trap when the condition was activated.

AMCondition.ObjectType

 

Returns the object type for the SNMP trap when the condition was activated.

AMCondition.Host

 

Returns the host specified in the SNMP trap when the condition was activated.

AMCondition.Community

 

Returns the community specified in the SNMP trap when the condition was activated.

AMCondition.TimeStamp

 

Returns the timestamp specified in the SNMP trap when the condition was activated.

AMCondition.BindingVarNumber

 

Returns the total number of variables that were sent with the SNMP trap when the condition was activated.

AMCondition.VarName[i]

 

Returns the associated variable name that was sent with the SNMP trap when the condition was activated. Use AMCondition.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 %AMCondition.VarSyntax2%.

AMCondition.VarValue[i]

Text

Returns the associated variable value that was sent with the SNMP trap when the condition was activated. Use AMCondition.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 %AMCondition.VarSyntax2%.

AMCondition.VarSyntax[i]

Text

Returns the associated variable syntax (such as integer) that was sent with the SNMP trap when the condition was activated. Use AMCondition.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 %AMCondition.VarSyntax2%.