View source for SNMP configuration example

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

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

===RUT9xx===
To setup SNMP first make sure that SNMP package is installed, more information here [[RUT956 Packages]] and [[RUT951_Package_Manager|RUT951 Packages]].

==OID codes==
OID code (Object identifier code) - is an address used to identify devices and their status.

[[File:SNMP_OID_MIB_Tree.png]]

OID code is represented by the numbers in the boxes starting from "root".

<table class="nd-mantable">
    <tr>
        <th>Number</th>
       	<th>Label</th>
       	<th>Explanation</th>
    </tr>
    <tr>
      	<td>1</td>
       	<td>iso</td>
       	<td>ISO is the group that established the OID standard</td>
    </tr>
    <tr>
      	<td>3</td>
       	<td>org</td>
       	<td>An organization will be specified next</td>
    </tr>
    <tr>
      	<td>6</td>
       	<td>dod</td>
       	<td>The US Department of Defense (established the early internet)</td>
    </tr>
    <tr>
      	<td>1</td>
       	<td>internet</td>
       	<td>Communication will be via Internet/network</td>
    </tr>
    <tr>
      	<td>4</td>
       	<td>private</td>
       	<td>This is a device manufactured by a private entity</td>
    </tr>
    <tr>
      	<td>1</td>
       	<td>enterprise</td>
       	<td>The device manufacturer is classified as an enterprise</td>
    </tr>
    <tr>
      	<td>48690</td>
       	<td>Teltonika</td>
       	<td>Teltonika enterprise number</td>
    </tr>
<table>
----
To communicate with Teltonika router the start of the OID code, in this case, will be 1.3.6.1.4.1.48690.

Every configuration or status variable has distinct OID code.

<table class="nd-mantable">
    <tr>
        <th>Field</th>
       	<th>Number</th>
       	<th>Explanation</th>
    </tr>
    <tr>
      	<td>static</td>
       	<td>1</td>
       	<td>Static router information (Router name, Modem Imei, Modem model etc.)</td>
    </tr>
    <tr>
      	<td>gsm</td>
       	<td>2</td>
       	<td>Sim card information (Sim State, Operator, Mobile IP etc.)</td>
    </tr>
    <tr>
      	<td>hotspot</td>
       	<td>3</td>
       	<td>Hotspot information (Hotspot ip, users etc.)</td>
    </tr>
    <tr>
      	<td>Trap</td>
       	<td>4</td>
       	<td>Trap messages (Information sent through trap messages)</td>
    </tr>
    <tr>
      	<td>rut9x5</td>
       	<td>5</td>
       	<td>Input/Output information</td>
    </tr>
    <tr>
      	<td>gps</td>
       	<td>6</td>
       	<td>GPS information (Latitude, accuracy etc.)</td>
    </tr>
    <tr>
      	<td>ethernet</td>
       	<td>7</td>
       	<td>Information about router ports</td>
    </tr>
<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]].

==MIB File==
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. 
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===
MIB File contains all OID codes. 
Line containing numbers needed for OID code can be identified by this marking "::=".

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

'''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==
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:SNMP_config_example_7.8_5.png]]

===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. 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===
We can use '''snmpget''' command to get information from router:

 $ snmpget -c public -v 2c '''IP_address''':'''port''' '''OID_code'''

'''Example:''' 

 $ 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:SNMP_config_example_7.8_1.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>Trap type</th>
        <th>Rule name</th>
       	<th>Value</th>
       	<th>Explanation</th>
    </tr>
    <tr>
        <td>GSM</td>
      	<td>Signal strength</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>GSM</td>
      	<td>Network type</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>Input/Output</td>
      	<td>Input(3)</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>Input/Output</td>
      	<td>Output(4)</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>Events log</td>
      	<td>Config change</td>
       	<td>All/AVL/Buttons/Call utilities/Hotspot/CLI/DDNS/DHCP/DMVPN/SSH/Email to SMS/Wake on LAN/Events Reporting/Firewall/USB tools/GPS/Site blocking/IO juggler/IO scheduler/IP block/IPsec/Landing page/Modbus server/Modbus TCP client/Modbus gateway/MQTT broker/MQTT publisher/Multi AP/Failover/Network/NTP client/NTP server/OpenVPN/Mobile operator list/Overview/Printer server/Package restore/Reboot scheduler/Ping reboot/Post/get/PPTP/Proxy blocker/Profiles/Mobile data limit/RMS/Users management/RS console/RS modbus/RS modem/RS overIP/Fota/Sim switch/Simcard/SMS gateway/SMS utilities/SNMP/SNMP Trap/SQM/Stunnel/System/Telnet/Web server/Traffic logging/User groups/VRRP/Widget/WiFi scanner/Wireless/L2TP</td>
       	<td>Teltonika device will send trap message when configuration changes were done to specified value</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>New DHCP client</td>
       	<td>All/Connected from LAN/Connected from WiFi</td>
       	<td>Teltonika device will send trap message when new DHCP client connected to the device</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>New DHCP client</td>
       	<td>All/Connected from LAN/Connected from WiFi</td>
       	<td>Teltonika device will send trap message when new DHCP client connected to the device</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Reboot</td>
       	<td>All/From Web UI/From input/output/From ping reboot/From wget reboot/From reboot scheduler/From button/From SMS</td>
       	<td>Teltonika device will send trap message when the device reboots by type</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Startup</td>
       	<td>All/Device startup completed/After unexpected shutdown</td>
       	<td>Teltonika device will send trap message when device startups by type</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>SSH</td>
       	<td>All/Succesful authentication/Unsuccesful authentication</td>
       	<td>Teltonika device will send trap message when there is SSH connection authentication</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Web UI</td>
       	<td>All/Succesful authentication/Unsuccesful authentication</td>
       	<td>Teltonika device will send trap message when there is Web UI connection authentication</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>New WiFi client</td>
       	<td>All/Connected/Disconnected</td>
       	<td>Teltonika device will send trap message when there is new WiFi client</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Mobile data</td>
       	<td>All/Connected/Disconnected</td>
       	<td>Teltonika device will send trap message when there is Mobile data connection</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>WAN failover</td>
       	<td>All/Switched to main/Switched to failover</td>
       	<td>Teltonika device will send trap message when there is WAN failover</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>SMS</td>
       	<td>SMS received</td>
       	<td>Teltonika device will send trap message when there is new SMS sent to device</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Signal strength</td>
       	<td>All/-121dBm-113dBm/-113dBm-98dBm/-98dBm-93dBm/-93dBm-75dBm/-75dBm-60dBm/-60dBm-50dBm</td>
       	<td>Teltonika device will send trap message when the signal strength reaches provided threshold</td>
    </tr>
    <tr>
        <td>Hotspot client</td>
      	<td>Connected</td>
       	<td>This trap does not have value</td>
       	<td>Teltonika device will send trap message when a client connects to a hotspot interface.</td>
    </tr>  
    <tr>
        <td>Events log</td>
      	<td>Sim switch</td>
       	<td>All/Changing to SIM1/Changing to SIM2</td>
       	<td>Teltonika device will send trap message when there is a SIM switch in the device</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Port state</td>
       	<td>All/Link state/Link speed/Unplugged/Plugged in/LAN1/LAN2/LAN3/LAN4/WAN</td>
       	<td>Teltonika device will send trap message when there is port state change</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>Topology changes</td>
       	<td>Topology changes</td>
       	<td>Teltonika device will send trap message when there is topology changes</td>
    </tr>
    <tr>
        <td>Events log</td>
      	<td>GPS</td>
       	<td>All/Left geofence/Entered geofence</td>
       	<td>Teltonika device will send trap message when there is changes in GPS</td>
    </tr>
    <tr>
        <td>Hotspot client</td>
      	<td>Disconnected</td>
       	<td>This trap does not have value</td>
       	<td>Teltonika device will send trap message when a client disconnects to a hotspot interface.</td>
    </tr> 
<table>
====Events log====
----
<table>
    <tr>
        <th>Event</th>
        <th>Event subtype</th>
        <th>Description</th>
    </tr>
    <tr>
        <td><b>Config change</b></td>
        <td>All | Specific config change; default: <b>all</b></td>
        <td>Informs on changes to the device's configuration.</td>
    </tr>
    <tr>
        <td><b>Reboot</b></td>
        <td>All | From Web UI | From ping reboot | From reboot scheduler | From button; default: <b>All</b></td>
        <td>Informs on if the device was rebooted.</td>
    </tr>
    <tr>
        <td><b>Startup</b></td>
        <td>Device startup completed</td>
        <td>Informs on when the device is fully booted.</td>
    </tr>
    <tr>
        <td><b>GPS</b></td>
        <td>All {{!}} Entered geofence {{!}} Left geofence; default: <b>All</b></td>
        <td>Informs on when the device has entered or left a user defined geofence zone.</td>
    </tr>
    <tr>
        <td><b>Mobile data</b></td>
        <td>All {{!}} Connected {{!}} Disconnected; default <b>All</b></td>
        <td>Informs on changes to the state of the device's mobile connection.</td>
    </tr>
    <tr>
        <td><b>New DHCP client</b></td>
        <td>All | Connected from LAN | Connected from WiFi | default <b>All</b></td>
        <td>Informs on new DHCP lease give outs.</td>
    </tr>
    <tr>
        <td><b>Ports state</b></td>
        <td>All {{!}} Link speed {{!}} Link state {{!}} Unplugged {{!}} Plugged in {{!}} Specific port; default: <b>All</b></td>
        <td>Informs on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes.</td>
    </tr>
    <tr>
        <td><b>Reboot</b></td>
        <td>All | From button | From Input/Output | From Ping Reboot | From Reboot Scheduler | From WebUI | From SMS; default: <b>All</b></td>
        <td>Informs after device reboot occurrences.</td>
    </tr>
    <tr>
        <td><b>Signal strength</b></td>
        <td>All {{!}} - 121 dBm - 113 dBm {{!}} - 113 dBm - 98 dBm {{!}} - 98 dBm - 93 dBm {{!}} - 93 dBm - 75 dBm {{!}} - 75 dBm - 60 dBm {{!}} - 60 dBm - 50 dBm; default: <b>All</b></td>
        <td>Informs on signal strength changes.</td>
    </tr>
    <tr>
        <td><b>SMS</b></td>
        <td>SMS received</td>
        <td>Informs on received SMS messages.</td>
    </tr>
    <tr>
        <td><b>SSH</b></td>
        <td>All | Successful authentication | Unsuccessful authentication; default: <b>All</b></td>
        <td>Informs on successful or unsuccessful SSH login attempts.</td>
    </tr>
    <tr>
        <td><b>Topology state</b></td>
        <td>Topology changes</td>
        <td>Informs on changes to the device's network topology.</td>
    </tr>
    <tr>
        <td><b>WAN failover</b></td>
        <td>All {{!}} Switched to failover {{!}} Switched to main; default: <b>All</b></td>
        <td>Informs on WAN failover occurrences.</td>
    </tr>|}}
    <tr>
        <td><b>WebUI</b></td>
        <td>ALL | Successful authentication | Unsuccessful authentication; default: <b>All</b></td>
        <td>Informs on successful or unsuccessful HTTP/HTTPS login attempts.</td>
    </tr>
    <tr>
        <td><b>New WiFi client</b></td>
        <td>All {{!}} Connected {{!}} Disconnected; default: <b>All</b></td>
        <td>Informs on new WiFi clients. Possible triggers are:</td>
    </tr>
</table>

----
To create new rule chose action and press "Add" button, specify rule values and save:

[[File:SNMP_config_example_7.8_2.png|1000px]]
----
Enable trap rule and press "Save".
[[File:SNMP_config_example_7.8_3.png|1000px]]
----
New rule should appear in the main Trap rules window:
[[File:SNMP_config_example_7.8_4.png|1000px]]
----
====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]]