Actions

Difference between revisions of "SNMP in AlphaCom XE"

From Zenitel Wiki

(→‎Where to get the MIB configuration file?)
 
(117 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
The AlphaCom E and some of its stations runs a [[Wikipedia:SNMP|SNMP]] service.<br>
+
{{A}}
 +
The AlphaCom XE runs a [[Wikipedia:SNMP|SNMP]] service, and supports SNMP polling and SNMP traps.
  
−
== Stentofon MIB OID numbers ==
+
The main difference between a SNMP poll and a SNMP trap is which device initiates the communication. An SNMP poll is initiated by the SNMP server and the AlphaCom responds to the server. An SNMP trap is initiated by the AlphaCom when it has information to send (usually some event happened) and does not want to wait for the server to ask for information.
  
−
Zenitel Norway AS have assigned a Private Enterprise Number ([http://en.wikipedia.org/wiki/Object_identifier OID]): [http://www.iana.org/assignments/enterprise-numbers 26122]
+
 
−
The Zenitel Norway AS enterprise number is labeled '''enterprises.stentofon'''<br/>
+
==Stentofon MIB OID numbers==
 +
Zenitel Norway AS has assigned a Private Enterprise Number [http://oid-info.com/get/1.3.6.1.4.1.26122 OID 26122].
 +
 
 +
The Zenitel Norway AS enterprise number is labeled '''enterprises.stentofon'''<br />
 
Allocated Sub OIDs:
 
Allocated Sub OIDs:
  
Line 10: Line 14:
 
*2 - enterprises.stentofon.ipstation
 
*2 - enterprises.stentofon.ipstation
  
−
=== Note about AlphaCom OID ===
 
  
−
The AlphaCom OID has of historical reasons not followed the enterpise numbering defined above.  
+
Note that the AlphaCom OID has of historical reasons not always followed the enterprise numbering defined above, see [[SNMP_in_AlphaCom_XE#AlphaCom_MIB_revisions|AlphaCom_MIB_revisions]]
−
The current AlphaCom OID is:
+
 
 +
==SNMP poll==
 +
 
 +
 
 +
In addition to the [[Downloads#SNMP_MIB_files|AlphaCom MIB]], the standard MIBs [http://tools.ietf.org/html/rfc1213 mibII], [http://net-snmp.sourceforge.net/docs/mibs/ucdavis.html ucd-snmp] and [http://tools.ietf.org/html/rfc3418 snmpv2] are implemented.
 +
These Mibs only implements polled information.
 +
 
 +
The AlphaCom MIB implements two main statuses:
 +
 
 +
{| border="1"
 +
! style="background:#ffdead;" width="200" |Variable
 +
! style="background:#ffdead;" width="200" |Object ID
 +
! style="background:#ffdead;" width="600" |Comment
 +
|-
 +
|Nodestate|| align="center" |1.3.6.1.4.1.26122.1.1.1||AMC-IP status enabled/disabled. Shows if the AlphaCom is operational. Same info as in AlphaWeb, Node State - Operational
 +
|-
 +
|RTP Statistics|| align="center" |1.3.6.1.4.1.26122.1.2.1||RTP audio statistics
 +
|-
 +
|}
 +
 
 +
 
 +
All MIBs variables are accessed through [[WikiPedia:SNMP#SNMPv2_and_Structure_of_Management_Information|SNMP v2]] protocol with '''community''' = '''public'''. All variables are read only.
 +
 +
The default MIBs are always active, but in order to receive polling requests from an SNMP server you need to open the firewall (Filters) in AlphaWeb (UDP port 161).
 +
 
 +
[[File:SNMP Filters 161.PNG|thumb|left|500px|Define and enable UDP port 161 in '''Filters''' settings in AlphaWeb]]
 +
<br style="clear:both;" />
  
−
* enterprises.9362
+
==SNMP Traps==
  
−
=== AlphaCom MIB ===
+
The AlphaCom log events can be sent as SNMP traps.
  
−
====Revision 1====
+
The alert types that support SNMP traps have a number assigned to them, for example, 1001 is the number assigned to System Log events. The following table lists the number sent in the SNMP trap for each alert type.
−
OID: enterprises.9362
 
−
Included in RootFS versions: 01-0x and 10-1x (to be updated revision 2 released)
 
−
MIB text: [[ACE_SW_ALPHACOM_MIB|AlphaCom MIB Revision 1]]
 
  
−
====Revision 2====
 
−
OID enterprises.26122:
 
−
Included in RootFS versions: 0x-0xx and 1x-1xx (to be updated revision 2 released)
 
−
MIB text: [[AlphaCom MIB Revision 2]]
 
  
−
== Frequently asked questions on the ACE SNMP implementation ==
+
{| border="1"
 +
! style="background:#ffdead;" width="120" |Alert number
 +
! style="background:#ffdead;" width="200" |Object ID
 +
! style="background:#ffdead;" width="250" |Alert type
 +
! style="background:#ffdead;" width="350" |Alert criteria
 +
|-
 +
| align="center" |1001|| align="center" |1.3.6.1.4.1.26122.1.11.1001||[[AlphaCom debug log|Debug log]] events||
 +
*Software debug information
 +
|-
 +
| align="center" |1002|| align="center" |1.3.6.1.4.1.26122.1.11.1002||[[System log]] events||
 +
*Station Line error
 +
*Board down
 +
*Device/MultiModule (card cage) error
 +
*AGA/AE1 audio line error
 +
*Software error
 +
*[[RCI|Remote Control Input]] on/off
 +
*Customized event logging ([[LOG|LOG command]])
 +
|-
 +
| align="center" |1003|| align="center" |1.3.6.1.4.1.26122.1.11.1003||[[Call Statistics Log|Call Statistics log]] events||
 +
*Point to point calls
 +
*Group Calls
 +
*Call Request
 +
*Ringing Group
 +
|-
 +
|}
 +
<br>
  
  
−
=== Which functions of SNMP are implemented? ===
+
SNMP trap is configured in AlphaWeb, '''System Configuration''' > '''Logging'''. Select destination ‘SNMP Trap’ and configure which logs you want to send.
  
−
In addition to the AlphaCom [[WikiPedia:Management_information_base|MIB]], the standard MIBs [http://tools.ietf.org/html/rfc1213 mibII], [http://net-snmp.sourceforge.net/docs/mibs/ucdavis.html ucd-snmp] and [http://tools.ietf.org/html/rfc3418 snmpv2] are implemented.
+
[[File:SNMP trap.PNG|thumb|left|500px|Configuration of SNMP Traps in AlphaWeb]]
−
These Mibs only implements polled information.
+
<br style="clear:both;" />
  
−
The AlphaCom MIB implements two main statuses:
 
  
−
* AMC-IP status (Enabled/Disabled)  (Same as AlphaWeb Node State/Operational)
+
SNMP traps are using UDP port 162. As this is outbound data, there is no need to define this port in the Filters settings in AlphaWeb.
−
* RTP statistics (Audio Statistics)
 
  
−
All MIBS variables are accessed through [[WikiPedia:SNMP#SNMPv2_and_Structure_of_Management_Information|SNMP v2]] protocol with community public. All variables are read only.
+
==AlphaCom MIB file==
−
Example of reading the AlphaCom MIB with NET-SNMP:
 
  
−
> snmpwalk –v 2c –c public localhost enterprises.9362
+
*Link to [[Downloads#SNMP_MIB_files|download AlphaCom MIB file]]
  
−
=== Where to get the MIB configuration file? ===
+
'''Revision 3:'''
  
−
The active MIB file for a ACE board can be found in the folder :
+
*OID enterprises.26122
 +
*Added missing imports giving MIB validation errors.
 +
*Removed some unused import definitions
  
−
/usr/local/share/snmp/mibs/ALPHACOM-MIB.txt
+
'''Revision 2:'''
  
−
MIB text: [[AlphaCom MIB Revision 3]]
+
*OID enterprises.26122
 +
*Updated with Zenitel enterprise OID and snmptrap definition for AlphaCom syslog to snmptraps log facilities
  
−
=== How to activate SNMP in AlphaComE? ===
+
'''Revision 1:'''
−
 
−
The default MIBS are always active, but you need to open the firewall in AlphaWeb (UDP port 161)
 
−
If you need to log to snmp (snmp traps) it is possible to configure this in AlphaWeb ‘System Configuration’ / ‘Logging’
 
−
Select destination ‘SNMP Trap’ and configure which logs you want to send.
 
−
The SNMP traps will be sent with the OID: enterprises.1000.1 (This may be subject to change since it is not using our own Zenitel SNMP OID)
 
−
As a general rule it is better to use syslog directly for these kinds of log events and not SNMP. Most  Building Management Systems handles both syslog and SNMP. The SNMP log options is implemented to serve systems that do not handle syslog..
 
  
−
=== Which function of SNMP in AlphaComE will be implemented in near future? ===
+
*OID: enterprises.9362
  
−
There is at this moment not any plans for more SNMP implementation.
+
<br />
  
−
== Related articles ==
+
==Related articles==
  
−
* [[IP Station MIB]]
+
*Link to [[Downloads#SNMP_MIB_files|download MIB files]]
 +
*[[SNMP in IP Stations]]
 +
*Link to a [https://www.manageengine.com/products/mibbrowser-free-tool free MIB Browser], useful for testing
  
−
[[Category:AlphaCom E Software]]
+
[[Category:Logging]]

Latest revision as of 06:43, 13 September 2022

AlphaCom icon 300px.png

The AlphaCom XE runs a SNMP service, and supports SNMP polling and SNMP traps.

The main difference between a SNMP poll and a SNMP trap is which device initiates the communication. An SNMP poll is initiated by the SNMP server and the AlphaCom responds to the server. An SNMP trap is initiated by the AlphaCom when it has information to send (usually some event happened) and does not want to wait for the server to ask for information.


Stentofon MIB OID numbers

Zenitel Norway AS has assigned a Private Enterprise Number OID 26122.

The Zenitel Norway AS enterprise number is labeled enterprises.stentofon
Allocated Sub OIDs:

  • 1 - enterprises.stentofon.alphacom
  • 2 - enterprises.stentofon.ipstation


Note that the AlphaCom OID has of historical reasons not always followed the enterprise numbering defined above, see AlphaCom_MIB_revisions

SNMP poll

In addition to the AlphaCom MIB, the standard MIBs mibII, ucd-snmp and snmpv2 are implemented. These Mibs only implements polled information.

The AlphaCom MIB implements two main statuses:

Variable Object ID Comment
Nodestate 1.3.6.1.4.1.26122.1.1.1 AMC-IP status enabled/disabled. Shows if the AlphaCom is operational. Same info as in AlphaWeb, Node State - Operational
RTP Statistics 1.3.6.1.4.1.26122.1.2.1 RTP audio statistics


All MIBs variables are accessed through SNMP v2 protocol with community = public. All variables are read only.

The default MIBs are always active, but in order to receive polling requests from an SNMP server you need to open the firewall (Filters) in AlphaWeb (UDP port 161).

Define and enable UDP port 161 in Filters settings in AlphaWeb


SNMP Traps

The AlphaCom log events can be sent as SNMP traps.

The alert types that support SNMP traps have a number assigned to them, for example, 1001 is the number assigned to System Log events. The following table lists the number sent in the SNMP trap for each alert type.


Alert number Object ID Alert type Alert criteria
1001 1.3.6.1.4.1.26122.1.11.1001 Debug log events
  • Software debug information
1002 1.3.6.1.4.1.26122.1.11.1002 System log events
  • Station Line error
  • Board down
  • Device/MultiModule (card cage) error
  • AGA/AE1 audio line error
  • Software error
  • Remote Control Input on/off
  • Customized event logging (LOG command)
1003 1.3.6.1.4.1.26122.1.11.1003 Call Statistics log events
  • Point to point calls
  • Group Calls
  • Call Request
  • Ringing Group



SNMP trap is configured in AlphaWeb, System Configuration > Logging. Select destination ‘SNMP Trap’ and configure which logs you want to send.

Configuration of SNMP Traps in AlphaWeb



SNMP traps are using UDP port 162. As this is outbound data, there is no need to define this port in the Filters settings in AlphaWeb.

AlphaCom MIB file

Revision 3:

  • OID enterprises.26122
  • Added missing imports giving MIB validation errors.
  • Removed some unused import definitions

Revision 2:

  • OID enterprises.26122
  • Updated with Zenitel enterprise OID and snmptrap definition for AlphaCom syslog to snmptraps log facilities

Revision 1:

  • OID: enterprises.9362


Related articles

Retrieved from "https://wiki.zenitel.com/w/index.php?title=SNMP_in_AlphaCom_XE&oldid=231050"