Difference between revisions of "Template:Networking rut manual snmp"

From Teltonika Networks Wiki
Line 1: Line 1:
 
==Summary==
 
==Summary==
  
'''Simple Network Management Protocol (SNMP)''' is a popular protocol for network management. It is used for collecting information from, and configuring, network devices. This section is an overview of the '''SNMP''' function in RUT routers.
+
<b>Simple Network Management Protocol (SNMP)</b> is a popular protocol for network management. It is used for collecting information from, and configuring, network devices.
 +
 
 +
This manual page provides an overview of the SNMP function in {{{name}}} devices.
  
 
{{#if:{{{device_name|}}}|{{Template: Networking_rut9xx_rut2xx_rutxxx_manual_package_disclosure
 
{{#if:{{{device_name|}}}|{{Template: Networking_rut9xx_rut2xx_rutxxx_manual_package_disclosure
Line 36: Line 38:
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <th>field name</th>
+
         <th>Field</th>
       <th>value</th>
+
       <th>Value</th>
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>MIB file</td>
 
       <td>MIB file</td>
       <td>-</td>
+
       <td>- (interactive button)</td>
       <td>Downloads Teltonika's MIB file</td>
+
       <td>Downloads the MIB file for this device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Enable SNMP service</td>
 
       <td>Enable SNMP service</td>
       <td>yes {{!}} no; Default: '''no'''</td>
+
       <td>yes | no; default: <b>no</b></td>
       <td>Toggles SNMP ON or OFF</td>
+
       <td>Turns SNMP on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Enable remote access</td>
 
     <td>Enable remote access</td>
         <td>yes {{!}} no; Default: '''no'''</td>
+
         <td>yes | no; default: <b>no</b></td>
         <td>Opens a port in firewall so that the SNMP service may be reached remotely from WAN</td>
+
         <td>Opens a port (set in the field below) in the Firewall settings so that the SNMP service may be reached remotely from WAN.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Port</td>
 
     <td>Port</td>
         <td>integer [0..65535]; Default: '''161'''</td>
+
         <td>integer [0..65535]; default: <b>161</b></td>
         <td>SNMP service port</td>
+
         <td>SNMP service port.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Community</td>
 
       <td>Community</td>
       <td>Public {{!}} Private {{!}} Custom; Default: '''Public'''</td>
+
       <td>Public | Private | Custom; default: <b>Public</b></td>
       <td>SNMP Community is an ID that allows access to a router's SNMP data</td>
+
       <td>SNMP Community is an ID that allows access to a router's SNMP data.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Location</td>
 
       <td>Location</td>
       <td>string; Default: '''Location'''</td>
+
       <td>string; default: <b>Location</b></td>
       <td>Trap named sysLocation</td>
+
       <td>Trap named sysLocation.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Contact</td>
 
     <td>Contact</td>
         <td>string; Default: '''[email protected]'''</td>
+
         <td>string; default: <b>[email protected]</b></td>
         <td>Trap named sysContact</td>
+
         <td>Trap named sysContact.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Name</td>
 
     <td>Name</td>
         <td>string; Default: '''Name'''</td>
+
         <td>string; default: <b>Name</b></td>
         <td>Trap named sysName</td>
+
         <td>Trap named sysName.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>SNMP version</td>
 
     <td>SNMP version</td>
         <td>v1/v2 {{!}} v1/v2/v3 {{!}} v3; Default: '''v1/v2'''</td>
+
         <td>v1/v2 | v1/v2/v3 | v3; default: <b>v1/v2</b></td>
         <td>Specifies which SNMP version is to be used</td>
+
         <td>Specifies which SNMP version is to be used.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 93: Line 95:
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <th>field name</th>
+
         <th>Field</th>
       <th>value</th>
+
       <th>Value</th>
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>SNMP trap</td>
 
       <td>SNMP trap</td>
       <td>yes {{!}} no; Default: '''no'''</td>
+
       <td>yes | no; default: <b>no</b></td>
       <td>Toggles SNMP trap ON or OFF</td>
+
       <td>Turns SNMP trap on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Host/IP</td>
 
       <td>Host/IP</td>
       <td>host {{!}} ip; Default: " "</td>
+
       <td>host | ip; default: <b>none</b></td>
       <td>Host to transfer SNMP traffic to</td>
+
       <td>Host to transfer SNMP traffic to.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Port</td>
 
     <td>Port</td>
         <td>integer [0..65535]; Default: '''162'''</td>
+
         <td>integer [0..65535]; default: <b>162</b></td>
         <td>Port for trap's host</td>
+
         <td>Port number of the trap's host.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Community</td>
 
     <td>Community</td>
         <td>Public {{!}} Private; Default: '''Public'''</td>
+
         <td>Public | Private; default: <b>Public</b></td>
         <td>SNMP Community is an ID that allows access to a router's SNMP data</td>
+
         <td>SNMP Community is an ID that allows access to a router's SNMP data.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>

Revision as of 14:24, 14 September 2020

Summary

Simple Network Management Protocol (SNMP) is a popular protocol for network management. It is used for collecting information from, and configuring, network devices.

This manual page provides an overview of the SNMP function in {{{name}}} devices.


The information in this page is updated in accordance with the [[Media:{{{fw_version}}}_WEBUI.bin|{{{fw_version}}}]] firmware version.

MIB file downloads

FIELD ROUTER MIB FILE
RUT2XX TLT-MIB_RUT2XX
RUT9XX TLT-MIB_RUT9XX

SNMP Configuration

Services snmp configuration v2.png

Field Value Description
MIB file - (interactive button) Downloads the MIB file for this device.
Enable SNMP service yes | no; default: no Turns SNMP on or off.
Enable remote access yes | no; default: no Opens a port (set in the field below) in the Firewall settings so that the SNMP service may be reached remotely from WAN.
Port integer [0..65535]; default: 161 SNMP service port.
Community Public | Private | Custom; default: Public SNMP Community is an ID that allows access to a router's SNMP data.
Location string; default: Location Trap named sysLocation.
Contact string; default: [email protected] Trap named sysContact.
Name string; default: Name Trap named sysName.
SNMP version v1/v2 | v1/v2/v3 | v3; default: v1/v2 Specifies which SNMP version is to be used.

Trap Settings

Services snmp trap.PNG

Field Value Description
SNMP trap yes | no; default: no Turns SNMP trap on or off.
Host/IP host | ip; default: none Host to transfer SNMP traffic to.
Port integer [0..65535]; default: 162 Port number of the trap's host.
Community Public | Private; default: Public SNMP Community is an ID that allows access to a router's SNMP data.

SNMP Variables list

NAME OID DESCRIPTION
ModemImei.0 .1.3.6.1.4.1.48690.1.1.0 Modem IMEI
ModemModel.0 .1.3.6.1.4.1.48690.1.2.0 Modem model
ModemManufacturer.0 .1.3.6.1.4.1.48690.1.3.0 Modem manufacturer
ModemRevision.0 .1.3.6.1.4.1.48690.1.4.0 Modem revision
ModemSerial.0 .1.3.6.1.4.1.48690.1.5.0 Modem serial number
Imsi.0 .1.3.6.1.4.1.48690.1.6.0 Modem IMSI
RouterName.0 .1.3.6.1.4.1.48690.1.7.0 Router's name
ProductCode.0 .1.3.6.1.4.1.48690.1.8.0 Router's Product code
BatchNumber.0 .1.3.6.1.4.1.48690.1.9.0 Router's batch number
HardwareRevision.0 .1.3.6.1.4.1.48690.1.10.0 Router's Hardware Revision number
SimState.0 .1.3.6.1.4.1.48690.2.1.0 SIM card status
PinState.0 .1.3.6.1.4.1.48690.2.2.0 PIN status
NetState.0 .1.3.6.1.4.1.48690.2.3.0 Mobile network registration status
Signal.0 .1.3.6.1.4.1.48690.2.4.0 Signal strength level
Operator.0 .1.3.6.1.4.1.48690.2.5.0 Operator currently in use
OperatorNumber.0 .1.3.6.1.4.1.48690.2.6.0 Operator number (MCC+MNC)
ConnectionState.0 .1.3.6.1.4.1.48690.2.7.0 Data session connection state
ConnectionType.0 .1.3.6.1.4.1.48690.2.8.0 Data session connection type
Temperature.0 .1.3.6.1.4.1.48690.2.9.0 Modem's temperature in 0.1 degrees Celsius
ReceivedToday.0* .1.3.6.1.4.1.48690.2.10.0 The current day's RX packet count
SentToday.0* .1.3.6.1.4.1.48690.2.11.0 The current day's TX packet count
ReceivedYesterday.0* .1.3.6.1.4.1.48690.2.12.0 Yesterday's RX packet count
SentYesterday.0* .1.3.6.1.4.1.48690.2.13.0 Yesterday's TX packet count
FirmwareVersion.0 .1.3.6.1.4.1.48690.2.14.0 Router's Firmware version
SimSlot.0 .1.3.6.1.4.1.48690.2.15.0 SIM slot currently in use
RouterUptime.0 .1.3.6.1.4.1.48690.2.16.0 Router up-time in seconds
ConnectionUptime.0 .1.3.6.1.4.1.48690.2.17.0 Mobile connection up-time in seconds
MobileIP.0 .1.3.6.1.4.1.48690.2.18.0 IP address of the mobile interface
Sent.0* .1.3.6.1.4.1.48690.2.19.0 The amount of data sent through the mobile interface
Received.0* .1.3.6.1.4.1.48690.2.20.0 The amount of data received through the mobile interface
CellID.0 .1.3.6.1.4.1.48690.2.21.0 ID of the current mobile operator's cell
SINR.0 .1.3.6.1.4.1.48690.2.22.0 SINR value in dB
RSRP.0 .1.3.6.1.4.1.48690.2.23.0 RSRP value in dBm
RSRQ.0 .1.3.6.1.4.1.48690.2.24.0 RSRQ value in dB
iccid.0 .1.3.6.1.4.1.48690.2.25.0 ICCID value for current SIM
hotSpotId.0 .1.3.6.1.4.1.48690.3.4.1.0 Hotspot ID
hotSpotSsid.0 .1.3.6.1.4.1.48690.3.4.2.0 Hotspot SSID
hotSpotEnableState.0 .1.3.6.1.4.1.48690.3.4.3.0 Hotspot status (enabled or disabled)
hotSpotIP.0 .1.3.6.1.4.1.48690.3.4.4.0 Hotspot interface IP address
hotSpotDownloadBandWidth.0 .1.3.6.1.4.1.48690.3.4.5.0 Hotspot download bandwidth
hotSpotUploadBandWidth.0 .1.3.6.1.4.1.48690.3.4.6.0 Hotspot upload bandwidth
hotSpotUsers.0 .1.3.6.1.4.1.48690.3.4.7.0 Hotspot users list
hotSpotUsersPass.0 .1.3.6.1.4.1.48690.3.4.8.0 Hotspot users password list
hotSpotUsersActive.0 .1.3.6.1.4.1.48690.3.4.9.0 List of active Hotspot users
hotSpotUsersMac.0 .1.3.6.1.4.1.48690.3.4.10.0 Hotspot users MAC address list
hotSpotUsersIp.0 .1.3.6.1.4.1.48690.3.4.11.0 Hotspot users IP address list
hotSpotUsersStartTime.0 .1.3.6.1.4.1.48690.3.4.12.0 Hotspot users log in time list
hotSpotUsersUseTime.0 .1.3.6.1.4.1.48690.3.4.13.0 Hotspot users log in up-time list
hotSpotUsersDownload.0 .1.3.6.1.4.1.48690.3.4.14.0 Hotspot users downloaded data count
hotSpotUsersUpload.0 .1.3.6.1.4.1.48690.3.4.15.0 Hotspot users uploaded data count
hotSpotEndTime.0 .1.3.6.1.4.1.48690.3.4.16.0 Hotspot
DigitalInput.0 .1.3.6.1.4.1.48690.5.1.0 Digital input state
DigitalIsolatedInput.0 .1.3.6.1.4.1.48690.5.2.0 Digital isolated input state
AnalogInput.0 .1.3.6.1.4.1.48690.5.3.0 Analog input state
DigitalOCOutput.0 .1.3.6.1.4.1.48690.5.4.0 Digital OC output state
DigitalRelayOutput.0 .1.3.6.1.4.1.48690.5.5.0 Digital Relay output state
AnalogInputCalc.0 .1.3.6.1.4.1.48690.5.6.0 Analog input value
Longtitude.0 .1.3.6.1.4.1.48690.6.1.0 GPS Longitude value
Latitude.0 .1.3.6.1.4.1.48690.6.2.0 GPS Latitude value
Accuracy.0 .1.3.6.1.4.1.48690.6.3.0 GPS coordinate accuracy
Datetime.0 .1.3.6.1.4.1.48690.6.4.0 GPS coordinate fix time
NumSatellites.0 .1.3.6.1.4.1.48690.6.5.0 Number of GPS satelites

* Mobile data usage values can only be obtained with SNMP v2 or v3.

[[Category:{{{device_name}}} Services section]]