Changes

Created page with "{{Template: Networking_rutxxx_manual_fw_disclosure | fw_version = {{#switch: {{{series}}} | RUT2XX = {{{series}}}_R_00.01.14 | RUT9XX = {{{series}}}_R_00.06.08.1}} | serie..."
{{Template: Networking_rutxxx_manual_fw_disclosure
| fw_version = {{#switch: {{{series}}}
| RUT2XX = {{{series}}}_R_00.01.14
| RUT9XX = {{{series}}}_R_00.06.08.1}}
| series = {{{series}}}
}}
==Summary==

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

{{Template:Networking_rutos_manual_package_disclosure
| name = {{{name}}}
| series = {{{series}}}
| package = SNMP
}}

==MIB file downloads==

<table class="nd-othertables">
<tr>
<th style="width: 150px">FIELD ROUTER</th>
<th style="width: 150px">MIB FILE</th>
</tr>
<tr>
<td>RUT2XX</td>
<td>'''[[Media:TLT-MIB_RUT2XX.txt|TLT-MIB_RUT2XX]]'''</td>
</tr>
<tr>
<td>RUT9XX</td>
<td>'''[[Media:TLT-MIB_RUT9XX.txt|TLT-MIB_RUT9XX]]'''</td>
</tr>
</table>

==SNMP Configuration==

[[Image:Services snmp configuration v2.png]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>MIB file</td>
<td>- (interactive button)</td>
<td>Downloads the MIB file for this device.</td>
</tr>
<tr>
<td>Enable SNMP service</td>
<td>yes | no; default: <b>no</b></td>
<td>Turns SNMP on or off.</td>
</tr>
<tr>
<td>Enable remote access</td>
<td>yes | no; default: <b>no</b></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>
<td>Port</td>
<td>integer [0..65535]; default: <b>161</b></td>
<td>SNMP service port.</td>
</tr>
<tr>
<td>Community</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>
</tr>
<tr>
<td>Location</td>
<td>string; default: <b>Location</b></td>
<td>SysLocation object. Arbitrary SNMP variable that represents a custom location.</td>
</tr>
<tr>
<td>Contact</td>
<td>string; default: <b>[email protected]</b></td>
<td>SysContact object. Arbitrary SNMP variable that represents a contact Name.</td>
</tr>
<tr>
<td>Name</td>
<td>string; default: <b>Name</b></td>
<td>SysName object. Arbitrary SNMP variable that represents the system's Name.</td>
</tr>
<tr>
<td>SNMP version</td>
<td>v1/v2 | v1/v2/v3 | v3; default: <b>v1/v2</b></td>
<td>Specifies which SNMP version is to be used.</td>
</tr>
</table>

==Trap Settings==

[[Image:Services snmp trap.PNG]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>SNMP trap</td>
<td>yes | no; default: <b>no</b></td>
<td>Turns SNMP trap on or off.</td>
</tr>
<tr>
<td>Host/IP</td>
<td>host | ip; default: <b>none</b></td>
<td>Host to transfer SNMP traffic to.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>162</b></td>
<td>Port number of the trap's host.</td>
</tr>
<tr>
<td>Community</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>
</tr>
</table>

===List of traps===
----

<table class="nd-mantable">
<tr>
<th style="width: 250px">NAME</th>
<th style="width: 560px">DESCRIPTION</th>
</tr>
<tr>
<td>Signal strength trap</td>
<td>A message will be sent when the mobile signal strength drops below specified value.</td>
</tr>
<tr>
<td>Connection type trap</td>
<td>A message will be sent when connection type changes, e.g. GSM changes to WCDMA.</td>
</tr>
<tr>
<td>Digital input trap</td>
<td>A message will be sent when digital input state will change to a specified one.</td>
</tr>
<tr>
<td>Digital output trap</td>
<td>A message will be sent when digital output state will change to a specified one.</td>
</tr>
{{#ifeq:{{{name}}}|RUT955|
<tr>
<td>Digital isolated input trap</td>
<td>A message will be sent when digital isolated input state will change to a specified one.</td>
</tr>
<tr>
<td>Analog input trap</td>
<td>A message will be sent when input voltage changes, e.g. voltage is <i>Higher</i> than 6V.</td>
</tr>
<tr>
<td>Digital relay output trap</td>
<td>A message will be sent when digital relay output state will change to a specified one.</td>
</tr>
|}}
</table>

==SNMP Variables list==

<table class="nd-mantable">
<tr>
<th style="width: 250px">NAME</th>
<th style="width: 250px">OID</th>
<th style="width: 579px">DESCRIPTION</th>
</tr>
<tr>
<th>Device</th>
<th></th>
<th></th>
</tr>
<tr>
<td>ModemImei.0</td>
<td>.1.3.6.1.4.1.48690.1.1.0</td>
<td>Modem IMEI</td>
</tr>
<tr>
<td>ModemModel.0</td>
<td>.1.3.6.1.4.1.48690.1.2.0</td>
<td>Modem model</td>
</tr>
<tr>
<td>ModemManufacturer.0</td>
<td>.1.3.6.1.4.1.48690.1.3.0</td>
<td>Modem manufacturer</td>
</tr>
<tr>
<td>ModemRevision.0</td>
<td>.1.3.6.1.4.1.48690.1.4.0</td>
<td>Modem revision</td>
</tr>
<tr>
<td>ModemSerial.0</td>
<td>.1.3.6.1.4.1.48690.1.5.0</td>
<td>Modem serial number</td>
</tr>
<tr>
<td>Imsi.0</td>
<td>.1.3.6.1.4.1.48690.1.6.0</td>
<td>Modem IMSI</td>
</tr>
<tr>
<td>RouterName.0</td>
<td>.1.3.6.1.4.1.48690.1.7.0</td>
<td>Router's name</td>
</tr>
<tr>
<td>ProductCode.0</td>
<td>.1.3.6.1.4.1.48690.1.8.0</td>
<td>Router's Product code</td>
</tr>
<tr>
<td>BatchNumber.0</td>
<td>.1.3.6.1.4.1.48690.1.9.0</td>
<td>Router's batch number</td>
</tr>
<tr>
<td>HardwareRevision.0</td>
<td>.1.3.6.1.4.1.48690.1.10.0</td>
<td>Router's Hardware Revision number</td>
</tr>
<tr>
<th>Mobile</th>
<th></th>
<th></th>
</tr>
<tr>
<td>SimState.0</td>
<td>.1.3.6.1.4.1.48690.2.1.0</td>
<td>SIM card status</td>
</tr>
<tr>
<td>PinState.0</td>
<td>.1.3.6.1.4.1.48690.2.2.0</td>
<td>PIN status</td>
</tr>
<tr>
<td>NetState.0</td>
<td>.1.3.6.1.4.1.48690.2.3.0</td>
<td>Mobile network registration status</td>
</tr>
<tr>
<td>Signal.0</td>
<td>.1.3.6.1.4.1.48690.2.4.0</td>
<td>Signal strength level</td>
</tr>
<tr>
<td>Operator.0</td>
<td>.1.3.6.1.4.1.48690.2.5.0</td>
<td>Operator currently in use</td>
</tr>
<tr>
<td>OperatorNumber.0</td>
<td>.1.3.6.1.4.1.48690.2.6.0</td>
<td>Operator number (MCC+MNC)</td>
</tr>
<tr>
<td>ConnectionState.0</td>
<td>.1.3.6.1.4.1.48690.2.7.0</td>
<td>Data session connection state</td>
</tr>
<tr>
<td>ConnectionType.0</td>
<td>.1.3.6.1.4.1.48690.2.8.0</td>
<td>Data session connection type</td>
</tr>
<tr>
<td>Temperature.0</td>
<td>.1.3.6.1.4.1.48690.2.9.0</td>
<td>Modem's temperature in 0.1 degrees Celsius</td>
</tr>
<tr>
<td>ReceivedToday.0<span class="asterisk">*</span></td>
<td>.1.3.6.1.4.1.48690.2.10.0</td>
<td>The current day's RX packet count</td>
</tr>
<tr>
<td>SentToday.0<span class="asterisk">*</span></td>
<td>.1.3.6.1.4.1.48690.2.11.0</td>
<td>The current day's TX packet count</td>
</tr>
<tr>
<td>ReceivedYesterday.0<span class="asterisk">*</span></td>
<td>.1.3.6.1.4.1.48690.2.12.0</td>
<td>Yesterday's RX packet count</td>
</tr>
<tr>
<td>SentYesterday.0<span class="asterisk">*</span></td>
<td>.1.3.6.1.4.1.48690.2.13.0</td>
<td>Yesterday's TX packet count</td>
</tr>
<tr>
<td>FirmwareVersion.0</td>
<td>.1.3.6.1.4.1.48690.2.14.0</td>
<td>Router's Firmware version</td>
</tr>
<tr>
<td>SimSlot.0</td>
<td>.1.3.6.1.4.1.48690.2.15.0</td>
<td>SIM slot currently in use</td>
</tr>
<tr>
<td>RouterUptime.0</td>
<td>.1.3.6.1.4.1.48690.2.16.0</td>
<td>Router up-time in seconds</td>
</tr>
<tr>
<td>ConnectionUptime.0</td>
<td>.1.3.6.1.4.1.48690.2.17.0</td>
<td>Mobile connection up-time in seconds</td>
</tr>
<tr>
<td>MobileIP.0</td>
<td>.1.3.6.1.4.1.48690.2.18.0</td>
<td>IP address of the mobile interface</td>
</tr>
<tr>
<td>Sent.0<span class="asterisk">*</span></td>
<td>.1.3.6.1.4.1.48690.2.19.0</td>
<td>The amount of data sent through the mobile interface</td>
</tr>
<tr>
<td>Received.0<span class="asterisk">*</span></td>
<td>.1.3.6.1.4.1.48690.2.20.0</td>
<td>The amount of data received through the mobile interface</td>
</tr>
<tr>
<td>CellID.0</td>
<td>.1.3.6.1.4.1.48690.2.21.0</td>
<td>ID of the current mobile operator's cell </td>
</tr>
<tr>
<td>SINR.0</td>
<td>.1.3.6.1.4.1.48690.2.22.0</td>
<td>SINR value in dB</td>
</tr>
<tr>
<td>RSRP.0</td>
<td>.1.3.6.1.4.1.48690.2.23.0</td>
<td>RSRP value in dBm</td>
</tr>
<tr>
<td>RSRQ.0</td>
<td>.1.3.6.1.4.1.48690.2.24.0</td>
<td>RSRQ value in dB</td>
</tr>
<tr>
<td>iccid.0</td>
<td>.1.3.6.1.4.1.48690.2.25.0</td>
<td>ICCID value for current SIM</td>
</tr>
<tr>
<th>Hotspot<span class="asterisk">**</span></th>
<th></th>
<th></th>
</tr>
<tr>
<td>hotSpotId.0</td>
<td>.1.3.6.1.4.1.48690.3.1.1.0</td>
<td>Hotspot ID</td>
</tr>
<tr>
<td>hotSpotSsid.0</td>
<td>.1.3.6.1.4.1.48690.3.1.2.0</td>
<td>Hotspot SSID</td>
</tr>
<tr>
<td>hotSpotEnableState.0</td>
<td>.1.3.6.1.4.1.48690.3.1.3.0</td>
<td>Hotspot status (enabled or disabled)</td>
</tr>
<tr>
<td>hotSpotIP.0</td>
<td>.1.3.6.1.4.1.48690.3.1.4.0</td>
<td>Hotspot interface IP address</td>
</tr>
<tr>
<td>hotSpotDownloadBandWidth.0</td>
<td>.1.3.6.1.4.1.48690.3.1.5.0</td>
<td>Hotspot download bandwidth</td>
</tr>
<tr>
<td>hotSpotUploadBandWidth.0</td>
<td>.1.3.6.1.4.1.48690.3.1.6.0</td>
<td>Hotspot upload bandwidth</td>
</tr>
<tr>
<td>hotSpotUsers.0</td>
<td>.1.3.6.1.4.1.48690.3.1.7.0</td>
<td>Hotspot users list</td>
</tr>
<tr>
<td>hotSpotUsersPass.0</td>
<td>.1.3.6.1.4.1.48690.3.1.8.0 </td>
<td>Hotspot users password list </td>
</tr>
<tr>
<td>hotSpotUsersActive.0</td>
<td>.1.3.6.1.4.1.48690.3.1.9.0</td>
<td>List of active Hotspot users</td>
</tr>
<tr>
<td>hotSpotUsersMac.0</td>
<td>.1.3.6.1.4.1.48690.3.1.10.0</td>
<td>Hotspot users MAC address list</td>
</tr>
<tr>
<td>hotSpotUsersIp.0</td>
<td>.1.3.6.1.4.1.48690.3.1.11.0</td>
<td>Hotspot users IP address list</td>
</tr>
<tr>
<td>hotSpotUsersStartTime.0</td>
<td>.1.3.6.1.4.1.48690.3.1.12.0</td>
<td>Hotspot users log in time list</td>
</tr>
<tr>
<td>hotSpotUsersUseTime.0</td>
<td>.1.3.6.1.4.1.48690.3.1.13.0</td>
<td>Hotspot users log in up-time list</td>
</tr>
<tr>
<td>hotSpotUsersDownload.0</td>
<td>.1.3.6.1.4.1.48690.3.1.14.0</td>
<td>Hotspot users downloaded data count</td>
</tr>
<tr>
<td>hotSpotUsersUpload.0</td>
<td>.1.3.6.1.4.1.48690.3.1.15.0</td>
<td>Hotspot users uploaded data count</td>
</tr>
<tr>
<td>hotSpotEndTime.0</td>
<td>.1.3.6.1.4.1.48690.3.1.16.0</td>
<td>Hotspot</td>
</tr>
<tr>
<th>Input/Output</th>
<th></th>
<th></th>
</tr>
<tr>
<td>DigitalInput.0</td>
<td>.1.3.6.1.4.1.48690.5.1.0</td>
<td>Digital input state</td>
</tr>
<tr>
<td>DigitalIsolatedInput.0</td>
<td>.1.3.6.1.4.1.48690.5.2.0</td>
<td>Digital isolated input state</td>
</tr>
<tr>
<td>AnalogInput.0</td>
<td>.1.3.6.1.4.1.48690.5.3.0</td>
<td>Analog input state</td>
</tr>
<tr>
<td>DigitalOCOutput.0</td>
<td>.1.3.6.1.4.1.48690.5.4.0</td>
<td>Digital OC output state</td>
</tr>
<tr>
<td>DigitalRelayOutput.0</td>
<td>.1.3.6.1.4.1.48690.5.5.0</td>
<td>Digital Relay output state</td>
</tr>
<tr>
<td>AnalogInputCalc.0</td>
<td>.1.3.6.1.4.1.48690.5.6.0</td>
<td>Analog input value</td>
</tr>
{{#ifeq:{{{name}}}|RUT955|
<tr>
<td>digital4pinInput.0</td>
<td>.1.3.6.1.4.1.48690.5.7.0</td>
<td>Digital input state from 4PIN</td>
</tr>
<tr>
<td>digital4pinOutput.0</td>
<td>.1.3.6.1.4.1.48690.5.8.0</td>
<td>Digital output state from 4PIN</td>
</tr>
<tr>
<th>GPS</th>
<th></th>
<th></th>
</tr>
<tr>
<td>Longtitude.0</td>
<td>.1.3.6.1.4.1.48690.6.1.0</td>
<td>GPS Longitude value</td>
</tr>
<tr>
<td>Latitude.0</td>
<td>.1.3.6.1.4.1.48690.6.2.0</td>
<td>GPS Latitude value</td>
</tr>
<tr>
<td>Accuracy.0</td>
<td>.1.3.6.1.4.1.48690.6.3.0</td>
<td>GPS coordinate accuracy</td>
</tr>
<tr>
<td>Datetime.0</td>
<td>.1.3.6.1.4.1.48690.6.4.0</td>
<td>GPS coordinate fix time</td>
</tr>
<tr>
<td>NumSatellites.0</td>
<td>.1.3.6.1.4.1.48690.6.5.0</td>
<td>Number of GPS satelites</td>
</tr>
|}}
</table>

<span class="asterisk">*</span> Mobile data usage values can only be obtained with <b>SNMP v2 or v3</b>.<br>
<span class="asterisk">**</span> Values from second, third or fourth hotspot instance can be taken by changing X value .1.3.6.1.4.1.48690.3.<b style="color: #1550bf;">X</b>.1.0, possible values are 1 - 4.

[[Category:{{{name}}} Services section (legacy)]]

Navigation menu