Changes

no edit summary
Line 1: Line 1:  +
{{Template: Networking_rutxxx_manual_fw_disclosure
 +
| fw_version = {{#switch: {{{series}}}
 +
  | RUT2XX = {{{series}}}_R_00.01.14.3
 +
  | RUT9XX = {{{series}}}_R_00.06.08.2}}
 +
| series    = {{{series}}}
 +
}}
 
==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.
   −
{{#if:{{{device_name|}}}|{{Template: Networking_rut9xx_rut2xx_rutxxx_manual_package_disclosure
+
This manual page provides an overview of the SNMP function in {{{name}}} devices.
| device_name                      = {{{device_name}}}
  −
| package_name                    = SNMP
  −
| series                          = {{{series}}}
  −
}}}}
     −
{{Template: Networking_rutxxx_manual_fw_disclosure
+
{{Template:Networking_rutos_manual_package_disclosure
| fw_version = {{{fw_version}}}
+
| name    = {{{name}}}
 +
| series  = {{{series}}}
 +
| package = SNMP
 
}}
 
}}
   Line 36: Line 40:  
<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>SysLocation object. Arbitrary SNMP variable that represents a custom location.</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>SysContact object. Arbitrary SNMP variable that represents a contact Name.</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>SysName object. Arbitrary SNMP variable that represents the system's Name.</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 97:  
<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>
 +
 +
===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>
 
</table>
   Line 126: Line 170:  
       <th style="width: 250px">OID</th>
 
       <th style="width: 250px">OID</th>
 
       <th style="width: 579px">DESCRIPTION</th>
 
       <th style="width: 579px">DESCRIPTION</th>
 +
    </tr>
 +
    <tr>
 +
    <th>Device</th>
 +
        <th></th>
 +
        <th></th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 176: Line 225:  
       <td>.1.3.6.1.4.1.48690.1.10.0</td>
 
       <td>.1.3.6.1.4.1.48690.1.10.0</td>
 
       <td>Router's Hardware Revision number</td>
 
       <td>Router's Hardware Revision number</td>
 +
    </tr>
 +
    <tr>
 +
    <th>Mobile</th>
 +
        <th></th>
 +
        <th></th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 223: Line 277:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td>ReceivedToday.0</td>
+
     <td>ReceivedToday.0<span class="asterisk">*</span></td>
 
         <td>.1.3.6.1.4.1.48690.2.10.0</td>
 
         <td>.1.3.6.1.4.1.48690.2.10.0</td>
         <td>Tee current day's RX packet count</td>
+
         <td>The current day's RX packet count</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>SentToday.0</td>
+
       <td>SentToday.0<span class="asterisk">*</span></td>
 
       <td>.1.3.6.1.4.1.48690.2.11.0</td>
 
       <td>.1.3.6.1.4.1.48690.2.11.0</td>
 
       <td>The current day's TX packet count</td>
 
       <td>The current day's TX packet count</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>ReceivedYesterday.0</td>
+
       <td>ReceivedYesterday.0<span class="asterisk">*</span></td>
 
       <td>.1.3.6.1.4.1.48690.2.12.0</td>
 
       <td>.1.3.6.1.4.1.48690.2.12.0</td>
 
       <td>Yesterday's RX packet count</td>
 
       <td>Yesterday's RX packet count</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td>SentYesterday.0</td>
+
     <td>SentYesterday.0<span class="asterisk">*</span></td>
 
         <td>.1.3.6.1.4.1.48690.2.13.0</td>
 
         <td>.1.3.6.1.4.1.48690.2.13.0</td>
 
         <td>Yesterday's TX packet count</td>
 
         <td>Yesterday's TX packet count</td>
Line 268: Line 322:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Sent.0</td>
+
       <td>Sent.0<span class="asterisk">*</span></td>
 
       <td>.1.3.6.1.4.1.48690.2.19.0</td>
 
       <td>.1.3.6.1.4.1.48690.2.19.0</td>
 
       <td>The amount of data sent through the mobile interface</td>
 
       <td>The amount of data sent through the mobile interface</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Received.0</td>
+
       <td>Received.0<span class="asterisk">*</span></td>
 
       <td>.1.3.6.1.4.1.48690.2.20.0</td>
 
       <td>.1.3.6.1.4.1.48690.2.20.0</td>
 
       <td>The amount of data received through the mobile interface</td>
 
       <td>The amount of data received through the mobile interface</td>
Line 296: Line 350:  
       <td>.1.3.6.1.4.1.48690.2.24.0</td>
 
       <td>.1.3.6.1.4.1.48690.2.24.0</td>
 
       <td>RSRQ value in dB</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>
 
     <tr>
 
     <tr>
 
     <td>hotSpotId.0</td>
 
     <td>hotSpotId.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.1.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.1.0</td>
 
         <td>Hotspot ID</td>
 
         <td>Hotspot ID</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotSsid.0</td>
 
     <td>hotSpotSsid.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.2.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.2.0</td>
 
         <td>Hotspot SSID</td>
 
         <td>Hotspot SSID</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>hotSpotEnableState.0</td>
 
       <td>hotSpotEnableState.0</td>
       <td>.1.3.6.1.4.1.48690.3.4.3.0</td>
+
       <td>.1.3.6.1.4.1.48690.3.1.3.0</td>
 
       <td>Hotspot status (enabled or disabled)</td>
 
       <td>Hotspot status (enabled or disabled)</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>hotSpotIP.0</td>
 
       <td>hotSpotIP.0</td>
       <td>.1.3.6.1.4.1.48690.3.4.4.0</td>
+
       <td>.1.3.6.1.4.1.48690.3.1.4.0</td>
 
       <td>Hotspot interface IP address</td>
 
       <td>Hotspot interface IP address</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotDownloadBandWidth.0</td>
 
     <td>hotSpotDownloadBandWidth.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.5.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.5.0</td>
 
         <td>Hotspot download bandwidth</td>
 
         <td>Hotspot download bandwidth</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotUploadBandWidth.0</td>
 
     <td>hotSpotUploadBandWidth.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.6.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.6.0</td>
 
         <td>Hotspot upload bandwidth</td>
 
         <td>Hotspot upload bandwidth</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotUsers.0</td>
 
     <td>hotSpotUsers.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.7.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.7.0</td>
 
         <td>Hotspot users list</td>
 
         <td>Hotspot users list</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotUsersPass.0</td>
 
     <td>hotSpotUsersPass.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.8.0 </td>
+
         <td>.1.3.6.1.4.1.48690.3.1.8.0 </td>
 
         <td>Hotspot users password list </td>
 
         <td>Hotspot users password list </td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>hotSpotUsersActive.0</td>
 
       <td>hotSpotUsersActive.0</td>
       <td>.1.3.6.1.4.1.48690.3.4.9.0</td>
+
       <td>.1.3.6.1.4.1.48690.3.1.9.0</td>
 
       <td>List of active Hotspot users</td>
 
       <td>List of active Hotspot users</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>hotSpotUsersMac.0</td>
 
       <td>hotSpotUsersMac.0</td>
       <td>.1.3.6.1.4.1.48690.3.4.10.0</td>
+
       <td>.1.3.6.1.4.1.48690.3.1.10.0</td>
 
       <td>Hotspot users MAC address list</td>
 
       <td>Hotspot users MAC address list</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotUsersIp.0</td>
 
     <td>hotSpotUsersIp.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.11.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.11.0</td>
 
         <td>Hotspot users IP address list</td>
 
         <td>Hotspot users IP address list</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotUsersStartTime.0</td>
 
     <td>hotSpotUsersStartTime.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.12.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.12.0</td>
 
         <td>Hotspot users log in time list</td>
 
         <td>Hotspot users log in time list</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>hotSpotUsersUseTime.0</td>
 
       <td>hotSpotUsersUseTime.0</td>
       <td>.1.3.6.1.4.1.48690.3.4.13.0</td>
+
       <td>.1.3.6.1.4.1.48690.3.1.13.0</td>
 
       <td>Hotspot users log in up-time list</td>
 
       <td>Hotspot users log in up-time list</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>hotSpotUsersDownload</td>
+
       <td>hotSpotUsersDownload.0</td>
       <td>.0.1.3.6.1.4.1.48690.3.4.14.0</td>
+
       <td>.1.3.6.1.4.1.48690.3.1.14.0</td>
 
       <td>Hotspot users downloaded data count</td>
 
       <td>Hotspot users downloaded data count</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotUsersUpload.0</td>
 
     <td>hotSpotUsersUpload.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.15.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.15.0</td>
 
         <td>Hotspot users uploaded data count</td>
 
         <td>Hotspot users uploaded data count</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>hotSpotEndTime.0</td>
 
     <td>hotSpotEndTime.0</td>
         <td>.1.3.6.1.4.1.48690.3.4.16.0</td>
+
         <td>.1.3.6.1.4.1.48690.3.1.16.0</td>
 
         <td>Hotspot</td>
 
         <td>Hotspot</td>
 +
    </tr>
 +
    <tr>
 +
    <th>Input/Output</th>
 +
        <th></th>
 +
        <th></th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 406: Line 475:  
       <td>.1.3.6.1.4.1.48690.5.6.0</td>
 
       <td>.1.3.6.1.4.1.48690.5.6.0</td>
 
       <td>Analog input value</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>
 
     <tr>
 
     <tr>
Line 432: Line 517:  
         <td>Number of GPS satelites</td>
 
         <td>Number of GPS satelites</td>
 
     </tr>
 
     </tr>
 +
|}}
 
</table>
 
</table>
   −
[[Category:{{{device_name}}} Services section]]
+
<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]]