SNMP Trap Messages
Important: You need a good understanding of networks and SNMP, or you need to work with your network manager to implement SNMP traps. Revolution supports SNMPv1, SNMPv2c, and SNMPv3.
The Simple Network Management Protocol (SNMP) standard allows devices to communicate even if they are different hardware and run different software. Revolution supports Trap messages, which are a widely used mechanism to receive alerts about the activities of a device across a network.
Note: Only All Sites Admins have full access to configuration.
- An SNMP-compliant device or software is configured to send Trap messages to Revolution. The important thing to know here is that SNMP trap set up is primarily done on the device or software side, not within Revolution.
- An SNMP trap message is sent from the device or software when some sort of event occurs. (In this case, a 9-1-1 call is made.)
- You've created triggers in Revolution that listen for the Trap messages, and these triggers are assigned to notifications.
- When a trap message is received from the device or software, the Trap trigger associated with it sends the notification to the assigned endpoints and contacts.
- (Applies only to SNMPv1) SNMP traps include a community string. The community string configured in Revolution must match the community string included in the Trap message. Only one community string can be configured. So, if you have more than one device or software configured to send trap messages to Revolution, they must all use the same community string. SNMP trap messages support both public and non-public community strings. For SNMPv1, typically the community string 'public' is used.
- SNMP itself does not include a resend mechanism. If there's a network hiccup and the SNMP Trap message isn't sent or is lost, Revolution knows nothing about it. However, the device or software may have a resend mechanism in place. For example, The Mitel Emergency Services check to make sure SNMP trap messages are sent when an emergency call is made. Check your vendor documentation for information on this.
In Revolution SNMP is used to:
SNMP traps can be sent by any SNMP-compliant device or software. The SNMP trap trigger allows you to configure Revolution to receive trap messages from those devices or software. For example, I have a temperature monitoring SNMP-compliant device in my server room. I have it configured to send trap messages to my Revolution when there's a change in alarm states, which then triggers a notification to my network administrator to alert him to check the server room.
There are 7 generic trap types. You can create an individual trigger for each or create one trigger for any of them.
There are three basic steps to create a Trap trigger:
Follow the instructions in your vendor documentation on how to configure the device or software to send SNMP traps to Revolution.
To configure Revolution,
-
you'll need the unique Object Identifier (OID) for the trap you want to send.
Note: If the device generates a trap message with a NULL value, Revolution will ignore that message.
- If you're using the enterpriseSpecific trap type, you'll also need the list of vendor-specific trap codes. The vendor determines what the trap codes are.
The OID and trap codes are found in the Management Information Bases (MIB) files for the device or software.
Prerequisite: Confirm that the Revolution community string matches that of your device or software. See Make SNMP setting changes.
- Go to Configuration > Integrations > SNMP Trap Trigger
- Select New SNMP Trap Trigger.
- Enter a descriptive Name.
-
For Available in All Sites:
- Enable to ensure all your site locations have access.
- Disable and select a Site to limit which site has access.
-
Enter the Enterprise OID for the trap being sent, as defined in the MIB files of your SNMP-compliant device or software.
Note: This is a required field.
For our example, 1.3.6.1.4.1.20916.1.8.2.1 is the OID – iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) 20916 products(1) roomalert32E(8) traps(2) alarmmessage(1) – 20916 is the private enterprise number assigned to the vendor by the Internet Assigned Numbers Authority.
- For Version, select the version of SNMP trap message:
- V1 – define the version as SNMPv1.
- V2 – define the version as SNMPv2.
- V3 authentication – define the version as SNMPv3 and specify the following
- Username and Authentication – Credentials used for V3 security. The Username is always required and the Authentication must have a minimum of eight characters and can not contain whitespace.
- Authentication Type – Encryption type (MD5 or SHA) used with the authentication password.
- V3 authentication and privacy – adds privacy information onto details similar to V3 authentication.
- Privacy Phrase – Additional phrase required in addition to V3 credentials.
- Privacy Type – Encryption type (DES, AES-128, AES-192, or AES-256) used with the privacy phrase.
-
(Only applies to Version V1) Select the Generic Trap Type from the drop-down list.
For our example, I'll select enterpriseSpecific for my temperature monitoring device.
Generic Trap Name and Number Description
Note: The number assigned to the trap name is automatically assigned by Revolution. coldStart (0) Indicates that the agent has rebooted. All management variables will be reset; specifically, Counters and Gauges will be reset to zero (0). One nice thing about the coldStart trap is that it can be used to determine when new hardware is added to the network. When a device is powered on, it sends this trap to its trap destination. If the trap destination is set correctly (i.e., to the IP address of your Network Management System) the NMS can receive the trap and determine whether it needs to manage the device. warmStart (1) Indicates that the agent has reinitialized itself. None of the management variables will be reset. linkDown (2) Sent when an interface on a device goes down. The first variable binding identifies which interface went down. linkUp (3) Sent when an interface on a device comes back up. The first variable binding identifies which interface came back up. authenticationFailure (4) Indicates that someone has tried to query your agent with an incorrect community string; useful in determining if someone is trying to gain unauthorized access to one of your devices. egpNeighborLoss (5) Indicates that an Exterior Gateway Protocol (EGP) neighbor has gone down. enterpriseSpecific (6) Indicates that the trap is enterprise-specific. SNMP vendors and users define their own traps under the private-enterprise branch of the SMI object tree. To process this trap properly, the NMS has to decode the specific trap number that is part of the SNMP message.
ANY This trigger accepts any of the generic trap types in this table (0-6). -
(Available only if you select V1 > enterpriseSpecific) Enter the Specific Trap Code defined by the vendor.
For our example, my temperature monitoring device has a temperature alarm profile to notify me when the temperature falls below 60 or rises above 80. The particular alarm message that I want has a trap code of 1.
- Select Save.
Create as many triggers as you need, and then assign them to notifications.
Create an alert for each individual trap type you want to receive data on. For example, I want to know when
- new hardware is added to the network – create a trigger for trap type coldStart
- a device interface goes down – create a trigger for trap type linkDown ... and when
- a device interface is up again – create a trigger for trap type linkUp
I can then have each trigger assigned to its own notification or have one generic notification with all three triggers assigned.
Create enterprise specific alerts for each type of code you want to receive data on. For example, I want to know when
- the room temperature alarm is activated – create a trigger for trap type enterpriseSpecific and Specific Code Type 1
- there's a change in power state (main power vs batter back-up power) – create a trap type enterpriseSpecific and Specific Code Type 3
I can have each trigger assigned to its own notification, or have one generic notification with all
Create one generic alert for all SNMP trap messages – create a trigger for trap type ANY.
For this one, I'll create one notification and assign this trigger. Any time an SNMP trap message is received, the notification is sent. For enterprise specific trap messages, this trigger is sent when any vendor-defined trap code is received.
Create the notification(s) you want sent and assign the SNMP trap triggers.
-
General – Typically, you'll select a Text and Images or Stored Audio notification type. You might also choose to use Text to Speech since this is an emergency notification. If you want to include an opening tone to get the receivers attention, choose Stored Audio notification type. You would not choose One-Way, Recorded, or Two-Way notification types.
-
Select Triggers – Select SNMP from the Activator drop-down list and select the trigger you created.
-
Message Details and Actions – Enter the content you want sent.
-
Endpoints & Contacts – Assign the endpoints and contacts you want the emergency notification sent to. If you want the notification sent to the Mobile app, for example, add the contacts and make sure to check Mobile in the Contact Methods section.
Alter these settings from Configuration > Integration > SNMP under the Settings tab.
-
Trap Listening Port – (default 162). Change this value if your network is configured for a different port.
-
SNMP Community String – (default public) Change this value to match the community string included in the SNMP traps sent to Revolution. If you select V3 as your SNMP Version, Revolution will use the defined authentication and security ahead of this value.
For Mitel MiVoice business users, their default community string is MitelRW.
-
Trap Threshold - (default 0) Specify a time, in seconds, where Revolution will discard any traps older than this threshold from a queue of information. Note that a value of 0 means there is no threshold.