SNMP Trap Messages

There are two main areas to configure:

SIP Trunk

The Mitel MiVoice Business SIP Trunk top provides instructions on configuring a SIP trunk for use with UNP. Make sure you've done SNMP configuration on your SIP trunk.

Emergency Services for the dial numbers to monitor

Important: There are several more steps to configuring a Emergency Services and SNMP than just what's listed here. Consult your Mitel documentation. Of the areas to configure, these areas are specific to UNP.

Consult your Mitel Emergency Services documentation on how to

Set up CESIDs

In Mitel Emergency Services, you can either set up CESIDs or use the Calling Party number.

If you're assigning a CESID to a device, directory number, zone, or whole system, you'll need the CESID to configure dial monitoring in UNP. Notifications are then triggered if the number is dialed from a device with the same CESID.

If you're not using CESIDs, SIP trunks originating 9-1-1 calls use the Calling Party number instead. In this case, you'll leave the CESID field blank when configuring your UNP Mitel Dial Monitor trigger. When 9-1-1 is dialed from any phone on the network, the notification with the Dial Monitor trigger assigned is sent.

Set up SNMP

SNMP Configuration

Make sure SNMP is enabled.

You can use the default values for other fields.

SNMP Trap Forwarding

Make sure SNMP is enabled.

Change the Trap Forwarding Attributes to:

Field	Setting
IP Address	IP address of the UNP server
Comments	Enter a comment that helps you identify this SNMP trap will forward to UNP.

In UNP, you create Mitel Dial Monitor triggers, which is an SNMP trap, and then assign the trigger to notifications.

If you want to include the information about the caller, you need to Configure MiVoice Business in UNP Mitel Module.

If you want to include the caller's name and location, you need to import your Mitel phone directory.

1. Export your Mitel MiVoice phone directory to a CSV file. Consult your Mitel MiVoice documentation on how to do this.
2. Go to Configuration > Integrations > SNMP Trap Trigger.
3. Select Settings.
4. For Import Mitel Directory CSV select Choose File.
5. Select the file you exported from your MiVoice communications manager.
6. Click Save.

Now you can include the location and caller name variables in the message template when you create your Dial Monitor triggers.

1. Go to Configuration > Phone Systems > Dial Monitoring.
2. Click New > New Mitel Dial Monitor.
3. Enter a descriptive Name.

4. For multi-site organizations, do one of the following:

   • If you're an All Sites Admin – To assign this trigger to a specific site, disable Available in All Sites and select a Site from the drop-down list. Or, you can leave it Available to All Sites.
   • If you're a Site Admin – This trigger is automatically assigned to your default site. Each Site Admin will need to create their own triggers.
5. Enter the number to monitor configured in your Mitel communication manager. Our example uses 911.

6. For CESID, enter the CESID number you defined in your communication manager (Emergency Services section). You can use a C# regular expression in this field to match multiple CESID numbers used on your network.

   Regular expressions for number ranges are more complex, refer to this external web site for assistance in writing expressions Regex for Numbers and Number Range.

7. (Optional) Change the Template Title and Body. You can use static text, variables (available from the Add text variables drop-down menu), or a combination of both.

Variable	Description
Note: Some of these variables may return null values. Check your Mitel documentation.
{DialedDigits}	The digits that are outpulsed on the outgoing trunk after digit modification has been performed.
{CesidDigits)	This is the CESID from: the CESID Assignment form (for the Directory Number), L2 to CESID Mapping form (for a device from which the emergency call is placed), Network Zones form (for a zone from which an emergency call was placed), or Default CESID form (for the whole system).
{CallingDN}	The DN of the device used to place the emergency call.
{CallerName}	The name of the calling user
{Location}	Original location of the user if placed from a hot desk service, otherwise the caller location.
{RegistrationDN}	DN registered with the phone, if from a hot desk service.
{RegistrationName}	Name of the user registered with the phone, if from a hot desk service.
{CallType}	Indicates that the call is an emergency call.
{SysName}	IP address or host name configured in the SNMP Configuration form used to identify the system responding to the emergency call.
{DetectTime}	The date and time (with seconds) that the emergency call was initiated.
{CallingPNI}	The Primary Node ID for the caller (if applicable).
{SeqNumber}	An incrementing number from 1, used for correlating the retry logs.

8. 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.
     • 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.
9. Click Save.

Create a Dial Monitor trigger for each emergency number you're monitoring in Mitel that you want extended to your UNP endpoints and contacts.

Create the notification(s) you want sent and assign the triggers.

Create the notification(s) you want sent and assign the Mitel Dial Monitor 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 – Since you defined message title and body for your individual Mitel Dial Monitor triggers, you'll want to pull that content into your notification.

• Select {activatorTitle} from the Title {} variable drop-down list.
• Select {activatorBody} from the Body {} variable drop-down list.

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.

Follow the instructions in your vendor documentation on how to configure the device or software to send SNMP traps to UNP.

To configure UNP,

• you'll need the unique Object Identifier (OID) for the trap you want to send.
• 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.

1. Go to Configuration > Integrations > SNMP Trap Trigger
2. Select New SNMP Trap Trigger.
3. Enter a descriptive Name.

4. For multi-site organizations, do one of the following:

   • If you're an All Sites Admin – To assign this trigger to a specific site, disable Available in All Sites and select a Site from the drop-down list. Or, you can leave it Available to All Sites.
   • If you're a Site Admin – This trigger is automatically assigned to your default site. Each Site Admin will need to create their own triggers.

5. Enter the Enterprise OID for the trap being sent, as defined in the MIB files of your SNMP-compliant device or software.

   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.

6. 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.
     • 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.

6. (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 UNP.
   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 triggers accepts any of the generic trap types in this table (0-6).

7. (Available only if you select 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.

8. Select Save.

Create as many triggers as you need, and then assign them to notifications.

Here's some different ways to create trap alerts

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