Actions

Difference between revisions of "SNMP in AlphaCom XE"

From Zenitel Wiki

(→‎Stentofon MIB OID numbers)
 
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
{{A}}
 
The AlphaCom XE runs a [[Wikipedia:SNMP|SNMP]] service, and supports SNMP polling and SNMP traps.
 
The AlphaCom XE runs a [[Wikipedia:SNMP|SNMP]] service, and supports SNMP polling and SNMP traps.
  
Line 4: Line 5:
  
  
−
== Stentofon MIB OID numbers ==
+
==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].  
 
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/>
+
The Zenitel Norway AS enterprise number is labeled '''enterprises.stentofon'''<br />
 
Allocated Sub OIDs:
 
Allocated Sub OIDs:
  
Line 16: Line 17:
 
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]]
 
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]]
  
−
== SNMP polling ==
+
==SNMP poll==
  
  
−
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.
+
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.  
 
These Mibs only implements polled information.  
  
Line 29: Line 30:
 
! style="background:#ffdead;" width="600" |Comment
 
! 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
+
|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
+
|RTP Statistics|| align="center" |1.3.6.1.4.1.26122.1.2.1||RTP audio statistics
 
|-
 
|-
 
|}
 
|}
Line 43: Line 44:
 
<br style="clear:both;" />
 
<br style="clear:both;" />
  
 +
==SNMP Traps==
  
−
== SNMP Traps ==
+
The AlphaCom log events can be sent as SNMP traps.
−
 
 
−
The AlphaCom logs 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.
 
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.
Line 57: Line 57:
 
! style="background:#ffdead;" width="350" |Alert criteria
 
! style="background:#ffdead;" width="350" |Alert criteria
 
|-
 
|-
−
| align=center | 1001 || align=center | 1.3.6.1.4.1.26122.1.11.1001 || [[System log]] events ||  
+
| align="center" |1001|| align="center" |1.3.6.1.4.1.26122.1.11.1001||[[AlphaCom debug log|Debug log]] events||
−
* Station Line error
+
*Software debug information
−
* 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 | 1002 || align=center | 1.3.6.1.4.1.26122.1.11.1002 || [[AlphaCom debug log|Debug log]] events ||  
+
| align="center" |1002|| align="center" |1.3.6.1.4.1.26122.1.11.1002||[[System log]] events||
−
* Software debug information
+
*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 ||  
+
| 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
+
*Point to point calls
−
* Group Calls
+
*Group Calls
−
* Call Request
+
*Call Request
−
* Ringing Group
+
*Ringing Group
 
|-
 
|-
 
|}
 
|}
Line 85: Line 85:
  
  
−
SNMP traps are using UDP port 162. As this is outbound data, there is no need to define this port in the Filers settings 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.
−
 
 
−
 
 
−
== Frequently asked questions on SNMP ==
 
−
 
 
−
=== Where to get the MIB configuration file? ===
 
−
 
 
−
The active MIB file for an AMC-IP board can be found in the folder :
 
−
 
 
−
/usr/local/share/snmp/mibs/ALPHACOM-MIB.txt
 
−
 
 
−
MIB text: [[AlphaCom MIB Revision 3]]
 
−
 
 
−
=== How to change the SNMP UDP port number? ===
 
−
* Connect to the [[Linux Console|linux console]] through the ssh port using a terminal program like Putty.
 
−
* log in as normal with ''alpha/com''
 
−
* In the linux bash write these commands:
 
−
** ''su'' [enter]
 
−
** ''root password'' [enter]
 
−
** ''nano /usr/local/share/snmp/snmpd.conf''
 
−
Add the line '''agentaddress 165''' somewhere. Here 165 is the new portnumber used as an example:
 
−
[[File:Snmp port change.png|left|thumb|500px]]
 
−
<br style="clear:both;" />
 
−
 
 
−
* Use ctrl+X followed by Y to save and exit.
 
−
 
 
−
For more information see: <br/>
 
−
http://stackoverflow.com/questions/16205453/how-to-change-the-net-snmp-default-port-to-one-less-than-1024-in-linux <br/>
 
−
http://www.net-snmp.org/docs/man/snmpd.conf.html
 
  
−
=== How to change the SNMP trap UDP port number? ===
+
==AlphaCom MIB file==
−
* Connect to the linux console through the ssh port using a terminal program like Putty.
 
−
* log in as normal with ''alpha/com''
 
−
* In the linux bash write these commands:
 
−
** ''su'' [enter]
 
−
** ''root password'' [enter]
 
−
** ''nano /var/opt/www/amc_ip_config.xml'' [enter]
 
−
Step a couple of pages down and you should find:
 
−
<destination>
 
−
        <type>snmptrap</type>
 
−
       
10.5.101.112
 
  
−
Add the new port number to the IP address like this: ''10.5.101.112:165''
+
*Link to [[Downloads#SNMP_MIB_files|download AlphaCom MIB file]]
−
[[File:Snmptrap port change1.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
* Use ctrl+X followed by Y to save and exit.
+
'''Revision 3:'''
−
* Finally write:
 
−
** ''/etc/init.d/syslog-ng restart''
 
−
 
 
−
[[File:Snmptrap port change2.png|thumb|left|500px]]
 
−
<br style="clear:both;" />
 
  
−
For more information see: <br/>
+
*OID enterprises.26122
−
http://www.net-snmp.org/docs/man/snmpcmd.html
+
*Added missing imports giving MIB validation errors.
 +
*Removed some unused import definitions
  
−
=== AlphaCom MIB revisions ===
+
'''Revision 2:'''
  
−
====Revision 3====
+
*OID enterprises.26122
−
OID enterprises.26122:
+
*Updated with Zenitel enterprise OID and snmptrap definition for AlphaCom syslog to snmptraps log facilities
−
MIB text: [[AlphaCom MIB Revision 3]]
 
  
−
====Revision 2====
+
'''Revision 1:'''
−
OID enterprises.26122:  
 
−
Included in RootFS versions: 0x-0xx and 1x-1xx (to be updated revision 2 released)
 
−
MIB text: [[AlphaCom MIB Revision 2]]
 
  
−
====Revision 1====
+
*OID: enterprises.9362
−
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]]
 
  
 +
<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]]
 
[[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"