Actions

Difference between revisions of "SNMP in AlphaCom XE"

From Zenitel Wiki

(→‎Frequently asked questions on the ACE SNMP implementation)
 
(108 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
The AlphaCom XE and some of its stations runs a [[Wikipedia:SNMP|SNMP]] service.<br>
+
{{AI}}
 +
The ICX-AlphaCom and AlphaCom XE run 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 ICX-AlphaCom responds to the server. An SNMP trap is initiated by the ICX-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 ICX-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:
 
  
−
* enterprises.26122
+
==SNMP poll==
  
−
=== AlphaCom MIB ===
 
  
−
====Revision 1====
+
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.
−
OID: enterprises.9362
+
These Mibs only implements polled information.
−
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====
+
The ICX-AlphaCom MIB implements two main statuses:
−
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 3====
+
{| border="1"
−
OID enterprises.26122:
+
! style="background:#ffdead;" width="200" |Variable
−
MIB text: [[AlphaCom MIB Revision 3]]
+
! 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 ICX-Web, Node State - Operational
 +
|-
 +
|RTP Statistics|| align="center" |1.3.6.1.4.1.26122.1.2.1||RTP audio statistics
 +
|-
 +
|}
  
−
== Frequently asked questions on SNMP ==
 
  
 +
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 ICX-Web (UDP port 161).
  
−
=== Which functions of SNMP are implemented? ===
+
[[File:SNMP Filters 161.PNG|thumb|left|500px|Define and enable UDP port 161 in '''Filters''' settings in ICX-Web]]
 +
<br style="clear:both;" />You also need to configure the System Information for the SNMP server from System Configuration / Logging / SNMP System Information
 +
[[File:Snmp system info.jpg|left|frame|Configure the System Information for the SNMP Server.]]
 +
<br style="clear:both;" />
  
−
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.
 
−
These Mibs only implements polled information.
 
  
−
The AlphaCom MIB implements two main statuses:
+
==SNMP Traps==
 +
 
 +
The ICX-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.
  
−
* AMC-IP status (Enabled/Disabled)  (Same as AlphaWeb Node State/Operational)
 
−
* 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.  
+
{| border="1"
−
Example of reading the AlphaCom MIB with NET-SNMP:
+
! 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||[[ICX-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>
  
−
> snmpwalk –v 2c –c public localhost enterprises.26122
 
  
−
=== Where to get the MIB configuration file? ===
+
SNMP trap is configured in ICX-Web, '''System Configuration''' > '''Logging'''. Select destination ‘SNMP Trap’ and configure which logs you want to send.
  
−
The active MIB file for a ACE board can be found in the folder :
+
[[File:SNMP trap.PNG|thumb|left|500px|Configuration of SNMP Traps in ICX-Web]]
 +
<br style="clear:both;" />
  
−
/usr/local/share/snmp/mibs/ALPHACOM-MIB.txt
 
  
−
MIB text: [[AlphaCom MIB Revision 3]]
+
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 ICX-Web.
  
−
=== How to activate SNMP in AlphaCom XE? ===
+
==ICX-AlphaCom MIB file==
−
 
−
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..
 
  
−
=== How to change the SNMP UDP port number? ===
+
*Link to [[Downloads#SNMP_MIB_files|download 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 /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.
+
'''Revision 3:'''
  
−
For more information see: <br/>
+
*OID enterprises.26122
−
http://stackoverflow.com/questions/16205453/how-to-change-the-net-snmp-default-port-to-one-less-than-1024-in-linux <br/>
+
*Added missing imports giving MIB validation errors.
−
http://www.net-snmp.org/docs/man/snmpd.conf.html
+
*Removed some unused import definitions
  
−
=== How to change the SNMP trap UDP port number? ===
+
'''Revision 2:'''
−
* 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''
+
*OID enterprises.26122
−
[[File:Snmptrap port change1.png|thumb|left|500px]]
+
*Updated with Zenitel enterprise OID and snmptrap definition for AlphaCom syslog to snmptraps log facilities
−
<br style="clear:both;" />
 
  
−
* Use ctrl+X followed by Y to save and exit.
+
'''Revision 1:'''
−
* Finally write:
 
−
** ''/etc/init.d/syslog-ng restart''
 
  
−
[[File:Snmptrap port change2.png|thumb|left|500px]]
+
*OID: enterprises.9362
−
<br style="clear:both;" />
 
  
−
For more information see: <br/>
+
<br />
−
http://www.net-snmp.org/docs/man/snmpcmd.html
 
  
−
== 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:06, 7 November 2024

AI.png

The ICX-AlphaCom and AlphaCom XE run 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 ICX-AlphaCom responds to the server. An SNMP trap is initiated by the ICX-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 ICX-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 ICX-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 ICX-Web, 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 ICX-Web (UDP port 161).

Define and enable UDP port 161 in Filters settings in ICX-Web


You also need to configure the System Information for the SNMP server from System Configuration / Logging / SNMP System Information

Configure the System Information for the SNMP Server.



SNMP Traps

The ICX-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 ICX-Web, System Configuration > Logging. Select destination ‘SNMP Trap’ and configure which logs you want to send.

Configuration of SNMP Traps in ICX-Web



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

ICX-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=238818"