Changes

24,728 bytes added , 14:16, 11 May 2020

change template

{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03
| series = {{{series}}}
}}

__TOC__

==Summary==

Simple Network Management Protocol (SNMP) is a popular protocol for network management.
It is used for collecting information, and configuring, network devices.
This section is an overview of the SNMP function in {{{name}}} devices.

You can download MIB file for each device in their SNMP settings page, at SNMP System Summary section.

{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer}}

==SNMP settings==

The SNMP settings page is used to configure SNMP accessibility and general information in your device.

===SNMP agent settings===
----
[[File:Networking rutx manual snmp agent settings v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable SNMP service</td>
<td>off | on; default: '''off'''</td>
<td>Run SNMP service on system's startup.</td>
</tr>
<tr>
<td>Enable remote access</td>
<td>off | on; default: '''off'''</td>
<td>Open port in firewall so that SNMP service may be reached from WAN.</td>
</tr>
<tr>
<td>Protocol</td>
<td>UDP | TCP; default: '''UDP'''</td>
<td>SNMP service's protocol.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: '''161'''</td>
<td>SNMP service's port.</td>
</tr>
<tr>
<td>SNMP v1 Mode</td>
<td>off | on; default: '''on'''</td>
<td>Enable/disable SNMP v1 Mode.</td>
</tr>
<tr>
<td>SNMP v2c Mode</td>
<td>off | on; default: '''on'''</td>
<td>Enable/disable SNMP v2c Mode.</td>
</tr>
<tr>
<td>SNMP v3 Mode</td>
<td>off | on; default: '''off'''</td>
<td>Enable/disable SNMP v3 Mode.</td>
</tr>
</table>
===SNMP system summary===
----
[[File:Networking rutx manual snmp system summary v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>MIB file</td>
<td>-(interactive button)</td>
<td>Downloads device MIB file.</td>
</tr>
<tr>
<td>System OID</td>
<td>1.3.6.1.4.1.48690</td>
<td>OID or Object Identifier, is an identifier used to name and point to an object in the MIB hierarchy.</td>
</tr>
<tr>
<td>Location</td>
<td>string; default: '''location'''</td>
<td>Trap named sysLocation.</td>
</tr>
<tr>
<td>Contact</td>
<td>string; default: '''[email protected]'''</td>
<td>Trap named sysContact.</td>
</tr>
<tr>
<td>Name</td>
<td>string; default: '''name'''</td>
<td>Trap named sysName.</td>
</tr>
</table>
==SNMP v3 users==

The SNMP v3 users page is used to create and manage users, who can be authenticated using SNMP v3.
Create a User by simply writing a name and pressing '''Add''' button.

[[File:Networking rutx manual snmp users v2.png|border|class=tlt-border]]

You can modify User settings by pressing [[File:Networking_rutx_manual_edit_button_v1.png]] '''Edit''' button.

[[File:Networking rutx manual snmp user edit v2.png|border|class=tlt-border]]<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable </td>
<td>off | on; default: '''off'''</td>
<td>Enable or disable user.</td>
</tr>
<tr>
<td>Username</td>
<td>string; default: none </td>
<td>Set username to access SNMP.</td>
</tr>
<tr>
<td>Security level</td>
<td>No authentication, no privacy | Authentication, no privacy | Authentication and privacy;
default: '''No authentication, no privacy'''</td>
<td>A security level is an authentication strategy that is set up for the user.
No authentication, no privacy - authenticates with a username.
Authentication - provides MD5 or SHA algorithms for authentication.
Privacy - Provides DES or AES encryption.</td>
</tr>
<tr>
<td>Authentication type</td>
<td>SHA | MD5; default: '''SHA'''</td>
<td>Set authentication type to use with SNMP v3.</td>
</tr>
<tr>
<td>Authentication passphrase</td>
<td>string; default: '''none'''</td>
<td>Set authentication passpharse to generate key for SNMP v3.</td>
</tr>
<tr>
<td>Privacy type</td>
<td>DES | AES; default: '''DES'''</td>
<td>Set privacy type to use with SNMP v3.</td>
</tr>
<tr>
<td>Privacy passphrase</td>
<td>string; default: '''none'''</td>
<td>Set privacy passpharse to generate key for SNMP v3.</td>
</tr>
<tr>
<td>Access Mode</td>
<td>Read-Only | Read-Write; default: '''Read-Only'''</td>
<td>The access mode specifies the access the hosts in the community are allowed with respect to retrieving and modifying the MIB variables from a specific SNMP agent.</td>
</tr>
<tr>
<td>MIB subtree</td>
<td>string; default: '''none'''</td>
<td>Leave empty to access full MIB tree.</td>
</tr>
</table>

==Communities==

In SNMP community page you can manage access rights.

[[File:Networking rutx manual snmp community v2.png|border|class=tlt-border]]

You can access SNMP community settings by pressing [[File:Networking_rutx_manual_edit_button_v1.png]] '''Edit''' button.

[[File:Networking rutx manual snmp community edit v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Community name</td>
<td>string; default: none</td>
<td>Name of the community.</td>
</tr>
<tr>
<td>IP Address</td>
<td>ip; default: none</td>
<td>IP address of the community.</td>
</tr>
<tr>
<td>IP Mask</td>
<td>ip; default: none</td>
<td>Netmask for IP of the community.</td>
</tr>
<tr>
<td>Access Mode</td>
<td>Read-Only | Read-Write; default: '''Read-Only'''</td>
<td>Access mode for current community.</td>
</tr>
</table>
==Trap settings==

SNMP Traps are used to send alert messages to a central collector, the “SNMP manager” when an important event happens. A
benefit of using Traps for reporting alarms is that they trigger instantaneously, rather than waiting for a status
request from the manager.

Trap settings page is divided in two sections - Trap service settings and Trap rules. Trap service settings
lets you manage hosts which will get configured alert messages, Trap rules lets you manage rules which when triggered will send alerts.

[[File:Networking rutx manual snmp trap settings v1.png|border|class=tlt-border]]

===Configure Trap Service Settings===
----

To add another host click '''Add''' button at the right side of this table.

[[File:Networking rutx manual snmp trap settings trap service v1.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Host/IP</td>
<td>url | ip; default: none</td>
<td>Host to transfer SNMP traffic to.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: '''162'''</td>
<td>Port for trap's host.</td>
</tr>
<tr>
<td>Community</td>
<td>string; default: Public </td>
<td>Community name.</td>
</tr>
</table>

===Configure Trap Rules===
----

You can edit Trap rule by pressing [[File:Networking_rutx_manual_edit_button_v1.png]] '''Edit''' button in Trap settings page on preferred rule.

{{#ifeq:{{{mobile}}}|0|
[[File:Networking rutx10 manual snmp trap settings trap rule edit v1.png|border|class=tlt-border]] 
|
[[File:Networking rutx manual snmp trap settings trap rule edit v1.png|border|class=tlt-border]] 
}}

Above is an example of what rule configuration window looks like.
Below is a table with detailed explanations on how to configure the rule and what each of the fields mean.
To avoid redundancy, screenshots for the other rules will not be provided, since the structures,
syntax and the overall look of the configuration windows for each rule are very similar.
Instead, only tables containing information on how to edit each rule will be provided.

====Signal strength====
----
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: '''on'''</td>
<td>Enable or disable this rule.</td>
</tr>
<tr>
<td>Action</td>
<td>Signal strength trap</td>
<td>Rule will be triggered if signal strength falls below specified number.</td>
</tr>
<tr>
<td>Signal strength</td>
<td>integer [-130..0]; default: none</td>
<td>GSM signal's strength value in dBm, e.g. -85</td>
</tr>
</table>

====Connection type====
----
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: '''on'''</td>
<td>Enable or disable this rule.</td>
</tr>

<tr>
<td>Action</td>
<td>Connection type trap</td>
<td>Rule will be triggered when connection type will change.</td>
</tr>
</table>

====Input/Output====
----
<table class="nd-mantable">
<tr>
<th>field name</th>
<th>value</th>
<th>description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: '''on'''</td>
<td>Enable or disable this rule.</td>
</tr>
<tr>
<td>Action</td>
<td>Input/Output trap</td>
<td>Rule will be triggered when specified input or output state will change.</td>
</tr>
{{#switch:{{{series}}}
|RUTX =
<tr>
<td>Input/Output type</td>
<td>Input/Output; default: Input/Output</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>Input(3) {{!}} Output(4); default: Input(3)</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>State change</td>
<td>Active {{!}} Inactive {{!}} Both; default: Active</td>
<td>On which Input/Output state will this rule be triggered.</td>
</tr>
|TRB2XX =
<tr>
<td>Input/Output type</td>
<td>Input/Output {{!}} ADC; default: Input/Output</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>Configurable Input/Output([2..4]); default: Configurable Input/Output(2)</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>State change</td>
<td>Active {{!}} Inactive {{!}} Both; default: Active</td>
<td>On which Input/Output state will this rule be triggered.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>ADC; default: ADC</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Voltage</td>
<td>positive float [0..40]; default: none</td>
<td>At which voltage value will this rule be triggered.</td>
</tr>
|TRB14X =
{{#ifeq:{{{name}}}|TRB141|
<tr>
<td>Input/Output type</td>
<td>Input/Output {{!}} Wet/Dry Input {{!}} Relay {{!}} 4–20 mA Current Loop {{!}} ADC; default: Input/Output</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>Configurable Input/Output(3) {{!}} Configurable Input/Output(4); default: Configurable Input/Output(3)</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>State change</td>
<td>Active {{!}} Inactive {{!}} Both; default: Active</td>
<td>On which Input/Output state will this rule be triggered.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>Wet/Dry Input(1) {{!}} Wet/Dry Input(2); default: Wet/Dry Input(1)</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>State change</td>
<td>Rising {{!}} Falling {{!}} Both; default: Rising</td>
<td>On which Input/Output state will this rule be triggered.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>Relay(3,4,5) {{!}} Latching relay(11,12,13); default: Relay(3,4,5)</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>State change</td>
<td>Open {{!}} Closed {{!}} Both; default: Open</td>
<td>On which Input/Output state will this rule be triggered.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>4–20 mA Current Loop; default: 4–20 mA Current Loop</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Voltage</td>
<td>positive float [0..40]; default: none</td>
<td>At which voltage value will this rule be triggered.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>ADC; default: ADC</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Voltage</td>
<td>positive float [0..40]; default: none</td>
<td>At which voltage value will this rule be triggered.</td>
</tr>
|
<tr>
<td>Input/Output type</td>
<td>Input/Output; default: Input/Output</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>Input/Output name</td>
<td>Input(3) {{!}} Output(4); default: Input(3)</td>
<td>Which type of Inputs and Outputs to use in this rule.</td>
</tr>
<tr>
<td>State change</td>
<td>Active {{!}} Inactive {{!}} Both; default: Active</td>
<td>On which Input/Output state will this rule be triggered.</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>
<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>
<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</td>
<td>.1.3.6.1.4.1.48690.2.10.0</td>
<td>Tee current day's RX packet count</td>
</tr>
<tr>
<td>SentToday.0</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</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</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</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</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>hotSpotId.0</td>
<td>.1.3.6.1.4.1.48690.3.4.1.0</td>
<td>Hotspot ID</td>
</tr>
<tr>
<td>hotSpotSsid.0</td>
<td>.1.3.6.1.4.1.48690.3.4.2.0</td>
<td>Hotspot SSID</td>
</tr>
<tr>
<td>hotSpotEnableState.0</td>
<td>.1.3.6.1.4.1.48690.3.4.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.4.4.0</td>
<td>Hotspot interface IP address</td>
</tr>
<tr>
<td>hotSpotDownloadBandWidth.0</td>
<td>.1.3.6.1.4.1.48690.3.4.5.0</td>
<td>Hotspot download bandwidth</td>
</tr>
<tr>
<td>hotSpotUploadBandWidth.0</td>
<td>.1.3.6.1.4.1.48690.3.4.6.0</td>
<td>Hotspot upload bandwidth</td>
</tr>
<tr>
<td>hotSpotUsers.0</td>
<td>.1.3.6.1.4.1.48690.3.4.7.0</td>
<td>Hotspot users list</td>
</tr>
<tr>
<td>hotSpotUsersPass.0</td>
<td>.1.3.6.1.4.1.48690.3.4.8.0 </td>
<td>Hotspot users password list </td>
</tr>
<tr>
<td>hotSpotUsersActive.0</td>
<td>.1.3.6.1.4.1.48690.3.4.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.4.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.4.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.4.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.4.13.0</td>
<td>Hotspot users log in up-time list</td>
</tr>
<tr>
<td>hotSpotUsersDownload</td>
<td>.0.1.3.6.1.4.1.48690.3.4.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.4.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.4.16.0</td>
<td>Hotspot</td>
</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>
<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>
[[Category:{{{name}}} Services section]]

Lorurn

0

edits

Namespaces

Variants

Views

More

Search

Changes

Template:Networking rutos manual snmp (view source)

Revision as of 14:16, 11 May 2020

Navigation menu

Personal tools

NAVIGATION

Tools

Categories