Teltonika Networks Wiki

Changes

SNMP configuration example (view source)

Revision as of 15:05, 2 August 2023

5,333 bytes added ,  15:05, 2 August 2023
no edit summary
Line 1: Line 1:  
==Summary==
 
==Summary==
    +
This chapter is a guide on configuring SNMP package to establish communication between devices.
 +
 +
===SNMP===
 
SNMP (Simple Network Management Protocol) - is widely used in networking management for networking monitoring. SNMP uses MIB (Management Information Base) to organize management data in the form of variables, which describe the system configuration and status.
 
SNMP (Simple Network Management Protocol) - is widely used in networking management for networking monitoring. SNMP uses MIB (Management Information Base) to organize management data in the form of variables, which describe the system configuration and status.
   −
This chapter is a guide on configuring SNMP package to establish communication between devices.
+
===Trap===
 +
Traps are alert messages sent by SNMP agent to SNMP manager.
 +
 
 +
'''SNMP agent''' - Teltonika router. Device which sends Trap messages to the manager.
 +
 
 +
'''SNMP manager''' - device which listens for Trap messages from the agents.
 +
 
 +
Teltonika routers are able to send SNMP Trap messages to the manager on their own when they experience a problem or a situation described in the rules.  
    
==Preconditions==
 
==Preconditions==
    
===RUT9xx===
 
===RUT9xx===
−
To setup SNMP first make sure that SNMP package is installed, more information here [[RUT955 Packages]] and [[RUT950 Packages]].
+
To setup SNMP first make sure that SNMP package is installed, more information here [[RUT955 Packages]] and [[RUT950_Package_Manager|RUT950 Packages]].
    
==OID codes==
 
==OID codes==
 
OID code (Object identifier code) - is an address used to identify devices and their status.
 
OID code (Object identifier code) - is an address used to identify devices and their status.
 +
 
[[File:SNMP_OID_MIB_Tree.png]]
 
[[File:SNMP_OID_MIB_Tree.png]]
   Line 58: Line 69:  
     </tr>
 
     </tr>
 
<table>
 
<table>
−
 
+
----
 
To communicate with Teltonika router the start of the OID code, in this case, will be 1.3.6.1.4.1.48690.
 
To communicate with Teltonika router the start of the OID code, in this case, will be 1.3.6.1.4.1.48690.
   Line 72: Line 83:  
       <td>static</td>
 
       <td>static</td>
 
       <td>1</td>
 
       <td>1</td>
−
       <td>Static router information (Router name, Modem Imei, Modem Modle etc.)</td>
+
       <td>Static router information (Router name, Modem Imei, Modem model etc.)</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 105: Line 116:  
     </tr>
 
     </tr>
 
<table>
 
<table>
 +
----
 
To access variable values, after enterprise number add field number and then specify variable number. For example: .1.3.6.1.4.1.48690.1.7.0 represents router name (48690.1.7.0: Enterprise (48690) - Teltonika, Field (1) - static, Variable (7.0) - routerName). All OID codes can be generated from MIB file, basic OID codes can be found here [[RUT955 SNMP#SNMP Variables list]].
 
To access variable values, after enterprise number add field number and then specify variable number. For example: .1.3.6.1.4.1.48690.1.7.0 represents router name (48690.1.7.0: Enterprise (48690) - Teltonika, Field (1) - static, Variable (7.0) - routerName). All OID codes can be generated from MIB file, basic OID codes can be found here [[RUT955 SNMP#SNMP Variables list]].
    
==MIB File==
 
==MIB File==
−
MIB File can be used with MIB browsers for easier access to router configuration and status information variables. Download the MIB file and upload/load it in MIB browser.  
+
MIB File can be used with MIB browsers for easier access to configuration and status information variables of the device. Download the MIB file and upload/load it in MIB browser.  
−
[[File:Networking device configrationexample snmp mib browser v1.png]]
+
In this example '''iReasoning MIB browser''' was used '''only for testing purpose'''.
 +
 
 +
[[File:Networking device configrationexample snmp mib browser v2.png]]
 
===Generating OID code from MIB File===
 
===Generating OID code from MIB File===
 
MIB File contains all OID codes.  
 
MIB File contains all OID codes.  
 
Line containing numbers needed for OID code can be identified by this marking "::=".
 
Line containing numbers needed for OID code can be identified by this marking "::=".
−
[[File:Networking device configurationexample snmp mib file oid codes v1.png|middle]]
+
 
 +
[[File:Networking device configurationexample snmp mib file oid codes v1.png]]
    
All that is left, is to add the numbers together. Example from given MIB File: 1.3.6.1.4.1.48690.1.1.0.
 
All that is left, is to add the numbers together. Example from given MIB File: 1.3.6.1.4.1.48690.1.1.0.
   −
'''Important note:''' Do not forget to add .0 at the end of the generated OID code.
+
'''Important note:''' Do not forget to add .0 at the end of the generated OID code, except to Trap OID codes. Trap OID codes are only used by SNMP agent (router), using them in MIB browser or command line will not give any results.
    
==SNMP Configuration==
 
==SNMP Configuration==
−
To configure SNMP, first enable SNMP service, leave or change the port, you can leave everything else as it is.
+
To configure SNMP, first enable SNMP service, leave or change the port, you can leave everything else as it is.  
 +
 
 +
Press "Download" button to download MIB file.
 +
 
 
[[File:Networking_device_configurationexample_snmp_snmpconfiguration_v1.png]]
 
[[File:Networking_device_configurationexample_snmp_snmpconfiguration_v1.png]]
    
===Testing SNMP with MIB browser===
 
===Testing SNMP with MIB browser===
−
Use MIB browser to test if SNMP works. Make sure to use same port and IP address of the router in MIB browser, upload/load MIB file. MIB browser lets you walk through all OID codes, or return a distinct variable value.
+
Use MIB browser to test if SNMP works. Make sure to use same port and IP address of the router in MIB browser. To enter port number in MIB browser press "Advanced" button '''(on the right of IP address field)'''.
 +
 
 +
[[File:Networking device configurationexample mib browser port v2.png]]
 +
 
 +
 
 +
To upload/load MIB file press "File" in menu bar '''(top left side of the window)''' and press "Load MIBs", '''make sure to select the MIB file you downloaded from the WebUI'''. MIB browser lets you walk through all OID codes, or return a distinct variable value. To walk through all OID codes select "walk" in Operation tab '''(top left of the window)'''. To iterate through OID codes manually, navigate to the desired folder on the left of the MIB browser window and select specific element '''(Double click)'''. The value of the variable will be printed in the '''Result Table'''.
 +
 
 +
[[File:Networking device configurationexample snmp test example v2.png]]
    
===Testing SNMP with console command===
 
===Testing SNMP with console command===
Line 134: Line 159:     
  $ snmpget -c public -v 2c 192.168.1.1:161 1.3.6.1.4.1.48690.1.7.0
 
  $ snmpget -c public -v 2c 192.168.1.1:161 1.3.6.1.4.1.48690.1.7.0
 +
 +
==Trap Configuration==
 +
 +
First enable SNMP Trap, then enter '''Host/IP''', Hots/IP is the SNMP manager, computer to which SNMP agent will send Trap messages. If router is connected to PC via ethernet cable, enter the IP address of the interface the router is connected to. You can use '''ipconfig''' command on windows, '''ifconfig''' on linux to find IP address of the interface to which router is connected. Next choose '''port''', preferably choose port number higher than '''1024''' so SNMP manager could establish connection without root/admin rights. If you choose to leave default port '''162''' make sure to launch SNMP manager with admin/root permissions.
 +
 +
[[File:Networking device configurationexample trap configurations v1.png]]
 +
 +
===Trap rules===
 +
Trap rules describe on what event SNMP agent should send Trap messages. There are certain rules which can be set up using Teltonika WebUI depending on physical configuration of the device.
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Rule name</th>
 +
      <th>Value</th>
 +
      <th>Explanation</th>
 +
    </tr>
 +
    <tr>
 +
      <td>Signal strength trap</td>
 +
      <td>Minimal mobile signal strength</td>
 +
      <td>Teltonika device will send trap message when mobile signal strength falls lower than specified</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Connection type trap</td>
 +
      <td>This trap does not have value</td>
 +
      <td>Teltonika device will send trap message when mobile connection establishes or changes</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Digital input trap</td>
 +
      <td>Inactive/Active/Both</td>
 +
      <td>Teltonika device will send trap message when Digital input value changes to specified value</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Digital isolated input trap</td>
 +
      <td>Inactive/Active/Both</td>
 +
      <td>Teltonika device will send trap message when Digital isolated input value changes to specified value</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Analog input trap</td>
 +
      <td>Higher/Lower/Both + Voltage value</td>
 +
      <td>Teltonika device will send trap message when Analog input value fulfills specified requirement</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Digital output trap</td>
 +
      <td>Inactive/Active/Both</td>
 +
      <td>Teltonika device will send trap message when Digital output value changes to specified value</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Digital relay output trap</td>
 +
      <td>Inactive/Active/Both</td>
 +
      <td>Teltonika device will send trap message when Digital relay output value changes to specified value</td>
 +
    </tr>
 +
    <tr>
 +
<table>
 +
----
 +
To create new rule chose action and press "Add" button, specify rule values and save.
 +
 +
Example: choose "Connection type trap" action and press "Add" button.
 +
 +
[[File:Networking device configurationexample snmp trap rule v1.png]]
 +
----
 +
Enable trap rule and press "Save".
 +
 +
[[File:Networking device configurationexample snmp new connection rule v1.png]]
 +
----
 +
New rule should appear in the main Trap window.
 +
 +
[[File:Networking device configurationexample new snmp rule saved v1.png]]
 +
----
 +
====Testing Trap with MIB browser====
 +
To test trap messages with MIB browser, open Trap receiver and configure the setting. Make sure to use the same port saved in WebUI configuration.
 +
 +
'''Note:''' Preferably open MIB browser with root/admin permissions.
 +
 +
[[File:Networking device configurationexample snmp trap receiver config v2.png]]
 +
----
 +
To test "Connection type trap" reboot mobile modem. You can reboot modem through Status -> Network window.
 +
MIB browser should receive Trap message.
 +
 +
[[File:Networking configurationexample received trap v2.png]]
 +
 +
===Testing Trap with Linux Terminal===
 +
To test Traps with Linux terminal extra configurations and packages are required. All information how to setup Trap listening service and how to test it can be found here [[Testing Trap With Linux Operating System]].
 +
[[Category:SNMP]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/44551...109684"