Template:Networking rutos manual snmp: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wireless}}} (1), {{eth}} (1) -->
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wireless}}} (1), {{eth}} (1) -->
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
  | series = {{{series}}}
  | series = {{{series}}}
  | name  = {{{name}}}
  | name  = {{{name}}}
  }}
  }}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==


Line 14: Line 16:
<u><b>
<u><b>


Note:</b> SNMP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
Note:</b> SNMP is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
}}


Line 27: Line 29:
===SNMP agent settings===
===SNMP agent settings===
----
----
[[File:Networking_rutos_manual_snmp_snmp_agent_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_snmp_snmp_agent_settings_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 46: Line 48:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>IP family</td>
         <td>IP type</td>
         <td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td>
         <td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td>
         <td>IP family used by SNMP.</td>
         <td>IP type used by SNMP.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 189: Line 191:
The <b>SNMP Community</b> section is used to manage access rights. You can edit an SNMP community by clicking the 'Edit' button next to it:
The <b>SNMP Community</b> section is used to manage access rights. You can edit an SNMP community by clicking the 'Edit' button next to it:


[[File:Networking_rutos_manual_snmp_communities_edit_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_snmp_communities_edit_button_v1.png|border|class=tlt-border]]


This will redirect you to the community's configuration page.
This will redirect you to the community's configuration page.
Line 363: Line 365:
         <td>Rule will be triggered when connection type will change.</td>
         <td>Rule will be triggered when connection type will change.</td>
     </tr>
     </tr>
</table>
</table>|}}
<br>|}}
 


{{#ifeq: {{{io}}} | 1 |
====Input/Output====
====Input/Output====
----
----
Line 377: Line 378:
     <tr>
     <tr>
         <td>Enable</td>
         <td>Enable</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Enable or disable this rule.</td>
         <td>Enable or disable this rule.</td>
     </tr>
     </tr>
Line 402: Line 403:
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>On which Input/Output state will this rule be triggered.</td>
     </tr>
     </tr>
|TRB2 =
|TRB2|TRB2M =
     <tr>
     <tr>
         <td>Input/Output type</td>
         <td>Input/Output type</td>
Line 579: Line 580:
             <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
             <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
             <td>On which Input/Output state will this rule be triggered.</td>
             <td>On which Input/Output state will this rule be triggered.</td>
         </tr>
         </tr>}}}}
    |}}
</table>|}}
}}
 
</table>
 


====Events log====
====Events log====
Line 691: Line 688:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>routerName.0</td>
         <td>deviceName.0</td>
         <td>.1.3.6.1.4.1.48690.1.2.0</td>
         <td>.1.3.6.1.4.1.48690.1.2.0</td>
         <td>Device name</td>
         <td>Device name</td>
Line 714: Line 711:
         <td>.1.3.6.1.4.1.48690.1.6.0</td>
         <td>.1.3.6.1.4.1.48690.1.6.0</td>
         <td>Device RutOS firmware version</td>
         <td>Device RutOS firmware version</td>
    </tr>
    <tr>
        <td>deviceUptime</td>
        <td>.1.3.6.1.4.1.48690.1.7.0</td>
        <td>Device uptime</td>
    </tr>
    <tr>
        <td>cpuUsage</td>
        <td>.1.3.6.1.4.1.48690.1.8.0</td>
        <td>CPU usage</td>
     </tr>{{#ifeq: {{{mobile}}} | 1 |
     </tr>{{#ifeq: {{{mobile}}} | 1 |
     <tr>
     <tr>
Line 724: Line 731:
         <td>.1.3.6.1.4.1.48690.2.1.0</td>
         <td>.1.3.6.1.4.1.48690.2.1.0</td>
         <td>The number of modems (regardless of their current state) present on this system</td>
         <td>The number of modems (regardless of their current state) present on this system</td>
    </tr>
    <tr>
        <td>modemTable</td>
        <td>.1.3.6.1.4.1.48690.2.2.0</td>
        <td>A list of modem entries. The number of entries is given by the value of modemNum.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 879: Line 891:
         <td>.1.3.6.1.4.1.48690.2.2.1.31.1</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.31.1</td>
         <td>Bytes received this month</td>
         <td>Bytes received this month</td>
    </tr>
    <tr>
        <td>connectionUptime</td>
        <td>.1.3.6.1.4.1.48690.2.3.0</td>
        <td>Mobile connection uptime in seconds.</td>
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
     <tr>
     <tr>
Line 910: Line 927:
         <td>.1.3.6.1.4.1.48690.3.5.0</td>
         <td>.1.3.6.1.4.1.48690.3.5.0</td>
         <td>Number of available GPS satelites</td>
         <td>Number of available GPS satelites</td>
     </tr>|}}{{#ifeq: {{{notifications}}} | 1 | {{#ifeq: {{{mobile}}} | 1 |
     </tr>|}}{{#ifeq: {{{notifications}}} | 1 |
     <tr>
     <tr>
         <th>Mobile notifications</th>
         <th>Mobile notifications</th>
Line 925: Line 942:
         <td>.1.3.6.1.4.1.48690.4.1.2</td>
         <td>.1.3.6.1.4.1.48690.4.1.2</td>
         <td>Network type trap</td>
         <td>Network type trap</td>
     </tr>|}}
     </tr>|}}{{#switch:{{{name}}} | TCR100 | RUTXR1 | OTD140 | TAP100 | TAP200 = | #default =
     <tr>
     <tr>
         <th>Input/Output notifications</th>
         <th>Input/Output notifications</th>
         <th></th>
         <th></th>
         <th></th>
         <th></th>
     </tr>{{#switch:{{{name}}} |RUTX08|RUTX09|RUTX10|RUTX11|RUTX12|RUTX14|RUT950|RUT951|RUT952|RUT260|RUT955|RUT956|RUT240|RUT241|RUTX50|RUT901|RUT906|RUTM08|RUTM09|RUTM10|RUTM11|RUTM12|RUTM14 =
     </tr>}}{{#switch:{{{name}}} |RUTX08|RUTX09|RUTX10|RUTX11|RUTX12|RUTX14|RUT950|RUT951|RUT952|RUT260|RUT955|RUT956|RUT240|RUT241|RUTX50|RUT901|RUT906|RUTM08|RUTM09|RUTM10|RUTM11|RUTM12|RUTM14 =
     <tr>
     <tr>
         <td>digitalInputNotification</td>
         <td>digitalInputNotification</td>
Line 940: Line 957:
         <td>.1.3.6.1.4.1.48690.4.2.2</td>
         <td>.1.3.6.1.4.1.48690.4.2.2</td>
         <td>Digital output trap</td>
         <td>Digital output trap</td>
     </tr>| #default =}}{{#switch:{{{name}}} |RUT360|RUT361|RUT300|RUT301|TRB140|TRB141|TRB143|TRB500|TRB245|TRB255 =
     </tr>| #default =}}{{#switch:{{{name}}} |RUT360|RUT361|RUT300|RUT301|TRB140|TRB141|TRB143|TRB500|TRB245|TRB246|TRB255|TRB256|TRB160 =
     <tr>
     <tr>
         <td>digitalio0Notification</td>
         <td>digitalio0Notification</td>
Line 950: Line 967:
         <td>.1.3.6.1.4.1.48690.4.2.4</td>
         <td>.1.3.6.1.4.1.48690.4.2.4</td>
         <td>Digital I/O 1 trap</td>
         <td>Digital I/O 1 trap</td>
     </tr>| #default =}}{{#switch:{{{name}}} |TRB245|TRB255 =
     </tr>| #default =}}{{#switch:{{{name}}} |TRB245|TRB246|TRB255|TRB256 =
     <tr>
     <tr>
         <td>digitalio2Notification</td>
         <td>digitalio2Notification</td>
Line 980: Line 997:
         <td>.1.3.6.1.4.1.48690.4.2.10</td>
         <td>.1.3.6.1.4.1.48690.4.2.10</td>
         <td>ACL trap</td>
         <td>ACL trap</td>
     </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906|TRB245|TRB255|TRB141 =
     </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906|TRB245|TRB246|TRB255|TRB141|TRB256 =
     <tr>
     <tr>
         <td>adc0Notification</td>
         <td>adc0Notification</td>
Line 1,000: Line 1,017:
         <td>.1.3.6.1.4.1.48690.4.2.14</td>
         <td>.1.3.6.1.4.1.48690.4.2.14</td>
         <td>Digital output2 trap</td>
         <td>Digital output2 trap</td>
     </tr>| #default =}}|}}{{#ifeq: {{{hotspot}}} | 1 |
     </tr>| #default =}}{{#switch:{{{name}}}  |TRB160 =
    <tr>
        <td>powerVoltageNotification</td>
        <td>.1.3.6.1.4.1.48690.4.2.15</td>
        <td>Power voltage trap</td>
    </tr>| #default =}}{{#ifeq: {{{hotspot}}} | 1 |
    <tr>
        <th>Hotspot Notifications</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>clientConnectedNotification</td>
        <td>.1.3.6.1.4.1.48690.4.3.1</td>
        <td>Hotspot client connected trap</td>
    </tr>
    <tr>
        <td>clientDisconnectedNotification</td>
        <td>.1.3.6.1.4.1.48690.4.3.2</td>
        <td>Hotspot client disconnected trap</td>
    </tr>|}}{{#ifeq: {{{hotspot}}} | 1 |
     <tr>
     <tr>
         <th>Hotspot</th>
         <th>Hotspot</th>
Line 1,171: Line 1,208:
         <td>.1.3.6.1.4.1.48690.6.2.1.10</td>
         <td>.1.3.6.1.4.1.48690.6.2.1.10</td>
         <td>Percentage of ACL</td>
         <td>Percentage of ACL</td>
    </tr>
    <tr>
        <td> ioStateNumeric</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.11</td>
        <td>Numeric state of I/O</td>
     </tr>|}}{{#ifeq: {{{wireless}}} | 1 |
     </tr>|}}{{#ifeq: {{{wireless}}} | 1 |
     <tr>
     <tr>
Line 1,457: Line 1,499:
         <td>.1.3.6.1.4.1.48690.10.2.1.7</td>
         <td>.1.3.6.1.4.1.48690.10.2.1.7</td>
         <td>Boolean value whether port is duplex or not</td>
         <td>Boolean value whether port is duplex or not</td>
    </tr>|}}{{#ifeq: {{{mwan3}}} | 1 |
    <tr>
        <th>MultiWAN</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>mwan3Count</td>
        <td>.1.3.6.1.4.1.48690.12.1</td>
        <td>Count of Multiwan interfaces</td>
    </tr>
    <tr>
        <td>mwan3Table</td>
        <td>.1.3.6.1.4.1.48690.12.2</td>
        <td>A list of Multiwan interfaces. The number of entries is given by the value of mwan3Count</td>
    </tr>
    <tr>
        <td>mwan3Entry</td>
        <td>.1.3.6.1.4.1.48690.12.2.1</td>
        <td>An entry containing information of a particular Multiwan interface</td>
    </tr>
    <tr>
        <td>mwan3Index</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.1</td>
        <td>Unique value, greater than zero, for each session</td>
    </tr>
    <tr>
        <td>mwan3Name</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.2</td>
        <td>Name of Multiwan interface</td>
    </tr>
    <tr>
        <td>mwan3Enabled</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.3</td>
        <td>Numeric value indicating if interface is enabled or not</td>
    </tr>
    <tr>
        <td>mwan3Uptime</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.4</td>
        <td>Multiwan interface uptime</td>
    </tr>
    <tr>
        <td>mwan3Status</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.5</td>
        <td>Status of Multiwan interface</td>
    </tr>
    <tr>
        <td>mwan3Ip</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.6</td>
        <td>IP addresses that Multiwan interface tracks</td>
     </tr>|}}
     </tr>|}}
</table>
</table>


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

Latest revision as of 12:16, 4 September 2024

The information in this page is updated in accordance with firmware version .


Summary

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

Note: SNMP is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.

SNMP settings

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

SNMP agent settings

Field Value Description
Enable SNMP service off | on; default: off Run SNMP service on system's startup.
Enable remote access off | on; default: off Open port in firewall so that SNMP service may be reached from WAN.
IP type IPv4 | IPv6 | IPv4v6; default: IPv4 IP type used by SNMP.
Port integer [0..65535]; default: 161 SNMP service's port.
SNMP v1 Mode off | on; default: on Enable/disable SNMP v1 Mode.
SNMP v2c Mode off | on; default: on Enable/disable SNMP v2c Mode.
SNMP v3 Mode off | on; default: off Enable/disable SNMP v3 Mode.

SNMP System Summary

The SNMP System Summary section contains general information about SNMP on this device. You can also download this device's MIB file from this section.

Field Value Description
MIB file -(interactive button) Downloads the device's MIB file.
System OID 1.3.6.1.4.1.48690 OID or Object Identifier, is an identifier used to name and point to an object in the MIB hierarchy.
Location string; default: location Trap named sysLocation.
Contact string; default: [email protected] Trap named sysContact.
Name string; default: name Trap named sysName.

SNMP v3 users

The SNMP v3 users page is used to create and manage users, who can be authenticated using SNMP v3. To configure an SNMP user, you must first create it:

  1. Enter a custom name for the new user in the 'Name' field.
  2. Click the 'Add' button.
  3. Click the 'Edit' button next to the newly created user.

The SNMP user configuration window should look similar to this:

Note: this table has coloring scheme to indicate which fields can be seen with different configuration.

Field Value Description
Enable off | on; default: off Turns this SNMP user on or off.
Username string; default: none Set username to access SNMP.
Security level No authentication, no privacy | Authentication, no privacy | Authentication and privacy; default: No authentication, no privacy 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.
Authentication, no privacy | Authentication and privacy: Authentication type SHA | MD5; default: SHA Set authentication type to use with SNMP v3.
Authentication, no privacy | Authentication and privacy: Authentication passphrase string; default: none Set authentication passpharse to generate key for SNMP v3.
Authentication and privacy: Privacy type DES | AES; default: DES Set privacy type to use with SNMP v3.
Authentication and privacy: Privacy passphrase string; default: none Set privacy passpharse to generate key for SNMP v3.
Access Mode Read-Only | Read-Write; default: Read-Only 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.
MIB subtree string; default: none Leave empty to access full MIB tree.

Communities

The SNMP Community section is used to manage access rights. You can edit an SNMP community by clicking the 'Edit' button next to it:

This will redirect you to the community's configuration page.

Field Value Description
Community name string; default: none Name of the community.
IP Address ip; default: none IP address of the community.
IP Mask ip; default: none Netmask for IP of the community.
Access Mode Read-Only | Read-Write; default: Read-Only Access mode for current community.

SNMPv6 community configuration page:

Field Value Description
Community name string; default: public Name of the community.
Source ip6 | domain name; default: default Source of the community.
Access Mode Read-Only | Read-Write; default: Read-Only Access mode for current community.

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.

Trap Service Settings

The Trap Service Settings is used to manage hosts which will be alerted when an SNMP trap is triggered. The host list is empty by default thus, to begin configuration you must first create at least one host.

Click the 'Add' button at the bottom-right side of the table to create a new host.

The newly added Host configuration should look similar to this:

Field Value Description
Host/IP url | ip; default: none Hostname or IP address to transfer SNMP traffic to.
Port integer [0..65535]; default: 162 Trap host's port number.
Community string; default: Public Name of the community to which the trap belongs.
Delete - (interactive button) Deletes the host next to the button.
off/on slider off | on; default: off Turns the host on or off. SNMP traffic is only sent to enabled hosts.

Trap Rules

SNMP Trap Rules are alerts that trigger when certain user-specified events occur. When the trigger event happens, the trap will notify known SNMP hosts.

You can create a new trap rule by clicking the 'Add' button.

You should be redirected to the rule's configuration page which should look something like this:

[[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_modify_trap_rule_mobile_{{{mobile}}}.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.




Events log

Event Event subtype Description
Config change All | Specific config change; default: all Informs on changes to the device's configuration.
Reboot All | From Web UI | From ping reboot | From reboot scheduler | From button; default: All Informs on if the device was rebooted.
Startup Device startup completed Informs on when the device is fully booted.
New DHCP client All | Connected from LAN; default All Informs on new DHCP lease give outs.
Reboot All | From button | From Input/Output | From Ping Reboot | From Reboot Scheduler | From WebUI | From SMS; default: All Informs after device reboot occurrences.
SSH All | Successful authentication | Unsuccessful authentication; default: All Informs on successful or unsuccessful SSH login attempts.
WebUI ALL | Successful authentication | Unsuccessful authentication; default: All Informs on successful or unsuccessful HTTP/HTTPS login attempts.


SNMP variables list

Name OID Description
Device
serial .1.3.6.1.4.1.48690.1.1.0 Device serial number
deviceName.0 .1.3.6.1.4.1.48690.1.2.0 Device name
productCode .1.3.6.1.4.1.48690.1.3.0 Device product (ordering) code
batchNumber .1.3.6.1.4.1.48690.1.4.0 Device batch number
hardwareRevision .1.3.6.1.4.1.48690.1.5.0 Device hardware revision
fwVersion .1.3.6.1.4.1.48690.1.6.0 Device RutOS firmware version
deviceUptime .1.3.6.1.4.1.48690.1.7.0 Device uptime
cpuUsage .1.3.6.1.4.1.48690.1.8.0 CPU usage
Input/Output notifications

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

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_snmp&oldid=132147"