Template:Networking rutos manual snmp: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
Tags: Mobile edit Mobile web edit
Line 738: Line 738:
         <td>.1.3.6.1.4.1.48690.2.2.1.21.1</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.21.1</td>
         <td>RSRQ value in dB</td>
         <td>RSRQ value in dB</td>
    </tr>
    <tr>
        <td>mSent</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.22.1</td>
        <td>Total bytes sent</td>
    </tr>
    <tr>
        <td>mReceived</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.23.1</td>
        <td>Total bytes received</td>
    </tr>
    <tr>
        <td>mIP</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.24.1</td>
        <td>Modem IP address(es)</td>
    </tr>
    <tr>
        <td>mSentToday</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.25.1</td>
        <td>Bytes sent today</td>
    </tr>
    <tr>
        <td>mReceivedToday</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.26.1</td>
        <td>Bytes received today</td>
    </tr>
    <tr>
        <td>mICCID</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.27.1</td>
        <td>SIM ICCID</td>
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
     <tr>
     <tr>
Line 869: Line 899:
         <td>.1.3.6.1.4.1.48690.5.6.1.13.1</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.13.1</td>
         <td>Hotspot URL</td>
         <td>Hotspot URL</td>
    </tr>|}}{{#ifeq: {{{io}}} | 1 |
    <tr>
        <th>Input/Output</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>ioCount</td>
        <td>.1.3.6.1.4.1.48690.6.1</td>
        <td>Count of I/O</td>
    </tr>
    <tr>
        <td>ioTable</td>
        <td>.1.3.6.1.4.1.48690.6.2</td>
        <td>A list of I/O. The number of entries is given by the value of ioCount</td>
    </tr>
    <tr>
        <td>ioEntry</td>
        <td>.1.3.6.1.4.1.48690.6.2.1</td>
        <td>An entry containing information of a particular I/O</td>
    </tr>
    <tr>
        <td>ioIndex</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.1</td>
        <td>A unique value, greater than zero, for each session</td>
    </tr>
    <tr>
        <td>ioSystemName</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.2</td>
        <td>The name of the I/O</td>
    </tr>
    <tr>
        <td>ioName</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.3</td>
        <td>The name of the I/O, as displayed in WebUI</td>
    </tr>
    <tr>
        <td>ioType</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.4</td>
        <td>A description of I/O type</td>
    </tr>
    <tr>
        <td>ioBidirectional</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.5</td>
        <td>Is I/O bidirectional?</td>
    </tr>
    <tr>
        <td>ioState</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.6</td>
        <td>State of I/O</td>
    </tr>
    <tr>
        <td>ioInput</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.7</td>
        <td>Is I/O an input?</td>
    </tr>
    <tr>
        <td>ioInverted</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.8</td>
        <td>Is value of I/O inverted?</td>
    </tr>
    <tr>
        <td>ioCurrent</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.9</td>
        <td>Current amount flowing though ACL</td>
    </tr>
    <tr>
        <td>ioPercentage</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.10</td>
        <td>Percentage of ACL</td>
    </tr>|}}{{#ifeq: {{{wireless}}} | 1 |
    <tr>
        <th>Wireless</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>radioCount</td>
        <td>.1.3.6.1.4.1.48690.7.1</td>
        <td>Amount of wireless radios</td>
    </tr>
    <tr>
        <td>radioTable</td>
        <td>.1.3.6.1.4.1.48690.7.2</td>
        <td>A list of wireless radios</td>
    </tr>
    <tr>
        <td>radioEntry</td>
        <td>.1.3.6.1.4.1.48690.7.2.1</td>
        <td>An entry containing information of a particular wireless radio</td>
    </tr>
    <tr>
        <td>radioIndex</td>
        <td>.1.3.6.1.4.1.48690.7.2.1.1</td>
        <td>A unique value, greater than zero, for each wireless radio</td>
    </tr>
    <tr>
        <td>radioName</td>
        <td>.1.3.6.1.4.1.48690.7.2.1.2</td>
        <td>The name of the wireless radio</td>
    </tr>
    <tr>
        <td>radioUpState</td>
        <td>.1.3.6.1.4.1.48690.7.2.1.3</td>
        <td>Is the radio currently turned on?</td>
    </tr>
    <tr>
        <td>radioDisabledState</td>
        <td>.1.3.6.1.4.1.48690.7.2.1.4</td>
        <td>Is the radio currently disabled?</td>
    </tr>
    <tr>
        <td>radioChannel</td>
        <td>.1.3.6.1.4.1.48690.7.2.1.5</td>
        <td>Current active channel of the wireless radio</td>
    </tr>
    <tr>
        <td>wIfaceCount</td>
        <td>.1.3.6.1.4.1.48690.7.3</td>
        <td>Amount of wireless interfaces</td>
    </tr>
    <tr>
        <td>wIfaceTable</td>
        <td>.1.3.6.1.4.1.48690.7.4</td>
        <td>A list of wireless interfaces</td>
    </tr>
    <tr>
        <td>wIfaceEntry</td>
        <td>.1.3.6.1.4.1.48690.7.4.1</td>
        <td>An entry containing information of a particular wireless interface</td>
    </tr>
    <tr>
        <td>wIfaceIndex</td>
        <td>.1.3.6.1.4.1.48690.7.4.1.1</td>
        <td>The SSID of a wireless interface</td>
    </tr>
    <tr>
        <td>wIfaceSSID</td>
        <td>.1.3.6.1.4.1.48690.7.4.1.2</td>
        <td>The SSID of a wireless interface</td>
    </tr>
    <tr>
        <td>wIfaceHidden</td>
        <td>.1.3.6.1.4.1.48690.7.4.1.3</td>
        <td>Is the wireless interface hidden?</td>
    </tr>
    <tr>
        <td>wIfaceEncryption</td>
        <td>.1.3.6.1.4.1.48690.7.4.1.4</td>
        <td>The encryption used by the wireless interface</td>
    </tr>
    <tr>
        <td>wIfaceMode</td>
        <td>.1.3.6.1.4.1.48690.7.4.1.5</td>
        <td>The mode of the wireless interface</td>
    </tr>|}}{{#ifeq: {{{pvlan}}} | 1 |
    <tr>
        <th>Port based vlan</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>pVlanCount</td>
        <td>.1.3.6.1.4.1.48690.8.1</td>
        <td>Amount of port-based virtual networks</td>
    </tr>
    <tr>
        <td>pVlanTable</td>
        <td>.1.3.6.1.4.1.48690.8.2</td>
        <td>A list port-based virtual networks</td>
    </tr>
    <tr>
        <td>pVlanEntry</td>
        <td>.1.3.6.1.4.1.48690.8.2.1</td>
        <td>An entry containing information about a port-based VLAN</td>
    </tr>
    <tr>
        <td>pVlanIndex</td>
        <td>.1.3.6.1.4.1.48690.8.2.1.1</td>
        <td>The index of the port-based VLAN</td>
    </tr>
    <tr>
        <td>pVlanNum</td>
        <td>.1.3.6.1.4.1.48690.8.2.1.2</td>
        <td>The vlan number of the port-based VLAN</td>
    </tr>
    <tr>
        <td>pVlanPorts</td>
        <td>.1.3.6.1.4.1.48690.8.2.1.3</td>
        <td>The assigned ports of the port-based VLAN</td>
    </tr>
    <tr>
        <td>pVlanVID</td>
        <td>.1.3.6.1.4.1.48690.8.2.1.4</td>
        <td>The vlan ID of the port-based VLAN</td>
    </tr>|}}{{#ifeq: {{{ivlan}}} | 1 |
    <tr>
        <th>Interface based vlan</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>iVlanCount</td>
        <td>.1.3.6.1.4.1.48690.8.3</td>
        <td>Amount of interface-based virtual networks</td>
    </tr>
    <tr>
        <td>iVlanTable</td>
        <td>.1.3.6.1.4.1.48690.8.4</td>
        <td>A list interface-based virtual networks</td>
    </tr>
    <tr>
        <td>iVlanEntry</td>
        <td>.1.3.6.1.4.1.48690.8.4.1</td>
        <td>An entry containing information about an interface-based VLAN</td>
    </tr>
    <tr>
        <td>iVlanIndex</td>
        <td>.1.3.6.1.4.1.48690.8.4.1.1</td>
        <td>The index of an iface-based VLAN</td>
    </tr>
    <tr>
        <td>iVlanName</td>
        <td>.1.3.6.1.4.1.48690.8.4.1.2</td>
        <td>The name of an iface-based VLAN</td>
    </tr>
    <tr>
        <td>iVlanType</td>
        <td>.1.3.6.1.4.1.48690.8.4.1.3</td>
        <td>The type of an iface-based VLAN</td>
    </tr>
    <tr>
        <td>iVlanIfName</td>
        <td>.1.3.6.1.4.1.48690.8.4.1.4</td>
        <td>The interface name of an iface-based VLAN</td>
    </tr>
    <tr>
        <td>iVlanVID</td>
        <td>.1.3.6.1.4.1.48690.8.4.1.5</td>
        <td>The VLAN ID of an iface-based VLAN</td>
    </tr>|}}{{#ifeq: {{{sqm}}} | 1 |
    <tr>
        <th>Smart Queue Management</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>queueCount</td>
        <td>.1.3.6.1.4.1.48690.9.1</td>
        <td>Amount of traffic shaping configs</td>
    </tr>
    <tr>
        <td>queueTable</td>
        <td>.1.3.6.1.4.1.48690.9.2</td>
        <td>A list of traffic shaping configs</td>
    </tr>
    <tr>
        <td>queueEntry</td>
        <td>.1.3.6.1.4.1.48690.9.2.1</td>
        <td>Entry containg info of a traffic shaping config</td>
    </tr>
    <tr>
        <td>queueIndex</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.1</td>
        <td>The index of the queue</td>
    </tr>
    <tr>
        <td>queueName</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.2</td>
        <td>The internal name of the queue</td>
    </tr>
    <tr>
        <td>queueEnabled</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.3</td>
        <td>Is the queue enabled?</td>
    </tr>
    <tr>
        <td>queueIface</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.4</td>
        <td>The assigned interface of the queue</td>
    </tr>
    <tr>
        <td>queueDownLimit</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.5</td>
        <td>The download limit of the queue</td>
    </tr>
    <tr>
        <td>queueUpLimit</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.6</td>
        <td>The upload limit of the queue</td>
    </tr>
    <tr>
        <td>queueQdisk</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.7</td>
        <td>The queuing discipline in use for this queue</td>
    </tr>
    <tr>
        <td>queueScript</td>
        <td>.1.3.6.1.4.1.48690.9.2.1.8</td>
        <td>The queuing discipline setup script used in this queue</td>
     </tr>|}}{{#ifeq: {{{port}}} | 1 |
     </tr>|}}{{#ifeq: {{{port}}} | 1 |
     <tr>
     <tr>

Revision as of 10:25, 30 March 2023

Template:Networking rutos manual fw disclosure


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 Services → [[{{{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 family IPv4 | IPv6 | IPv4v6; default: IPv4 IP family 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.

Input/Output

field name value1 description
Enable off | on; default: off Enable or disable this rule.
Action Input/Output trap Rule will be triggered when specified input or output state will change.

SNMP variables list

Name OID Description
Device
serial .1.3.6.1.4.1.48690.1.1.0 Device serial number
routerName.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

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

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