RUTX10 SNMP

Wiki mirrorView source
The information in this page is updated in accordance with firmware version RUTX_R_00.07.22.1.

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

SNMP settings

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

SNMP agent settings

FieldValueDescription
Enable SNMP serviceoff | on; default: offEnable SNMP (Simple Network Management Protocol) service on system startup.
Enable remote accessoff | on; default: offCreate a firewall rule that allows access to SNMP for remote hosts.
IP typeIPv4 | IPv6 | IPv4v6; default: IPv4IP type used by SNMP.
Portinteger [0..65535]; default: 161TCP/UDP port number used for the connection.
SNMP v1 Modeoff | on; default: onEnable/disable SNMP v1 Mode.
SNMP v2c Modeoff | on; default: onEnable/disable SNMP v2c Mode.
SNMP v3 Modeoff | on; default: offEnable/disable SNMP v3 Mode.
Persistent ifIndexoff | on; default: offMake ifIndex values persistent.

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.
FieldValueDescription
MIB file-(interactive button)Download the MIB file containing custom Teltonika module tree for this device.
Teltonika OID path1.3.6.1.4.1.48690The OID path containing Teltonika IANA Private Enterprise Number (PEN). All custom private SNMP modules are referenced under this OID path.
Locationstring; default: locationLocation of the system. If the field is empty, the option will have read-write permissions. If not, the option will become read-only.
Contactstring; default: [email protected]Contact information. If the field is empty, the option will have read-write permissions. If not, the option will become read-only.
Namestring; default: nameName of the system. If the field is empty, the option will have read-write permissions. If not, the option will become read-only.

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, press 'Add' button.
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.
FieldValueDescription
Enable off | on; default: offTurns this SNMP user on or off.
Usernamestring; default: none Name of the SNMP user configuration.
Security levelNo authentication, no privacy | Authentication, no privacy | Authentication and privacy; default: No authentication, no privacyA 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 typeSHA1 | MD5 | SHA256 | SHA512; default: SHA1Set authentication type to use with SNMP v3.
Authentication, no privacy | Authentication and privacy: Authentication passphrasestring; default: noneSet authentication passpharse to generate key for SNMP v3.
Authentication and privacy: Privacy typeDES | AES128; default: DESSet privacy type to use with SNMP v3.
Authentication and privacy: Privacy passphrasestring; default: noneSet privacy passpharse to generate key for SNMP v3.
Access ModeRead-Only | Read-Write; default: Read-OnlyAccess mode specifies which access the host has in the community and if they are allowed to retrieve and modify MIB variables from a specific SNMP agent.
MIB subtreestring; default: noneLeave 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.
FieldValueDescription
Community namestring; default: noneSNMP community name is an ID that allows access to a routers SNMP data.
IP Addressip; default: noneIP address of the community.
IP Maskip; default: noneNetmask for IP of the community.
Access ModeRead-Only | Read-Write; default: Read-OnlyAccess mode specifies if you can only read or read and write information from and to the device.
SNMPv6 community configuration page:
FieldValueDescription
Community namestring; default: publicName of the community.
Sourceip6 | domain name; default: defaultSource of the community.
Access ModeRead-Only | Read-Write; default: Read-OnlyAccess 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 host which will be alerted when an SNMP trap is triggered
FieldValueDescription
Enableoff | on; default: offEnables Trap service.
Destination addresshostname and port [0..65535]; default: 192.168.1.1:162Destination address to which SNMP (Simple Network Management Protocol) trap messages are sent.
Communitystring; default: publicThe SNMP (Simple Network Management Protocol) community is an ID that allows access to a routers SNMP data.

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:
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 Trap type

field namevaluedescription
TriggerInput(3) | Output(4); default: Input(3)The trigger which invokes the rule.
State changeHigh level | Low level | Both; default: BothSelects which pin state will trigger the SNMP trap.

Events log Trap type

EventEvent subtypeDescription
Config changeAll | Specific config change; default: allInforms on changes to the device's configuration.
RebootAll | From Web UI | From ping reboot | From reboot scheduler | From button; default: AllInforms on if the device was rebooted.
StartupDevice startup completed | After unexpected shutdownInforms on when the device is fully booted.
New DHCP clientAll | Connected from LAN| Connected from WiFi; default AllInforms on new DHCP lease give outs.
Ports stateAll | Link speed | Link state | Unplugged | Plugged in | Specific port; default: AllInforms on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes.
RebootAll | From button | From Input/Output | From Ping Reboot | From wget Reboot | From Reboot Scheduler | From WebUI; default: AllInforms after device reboot occurrences.
SSHAll | Successful authentication | Unsuccessful authentication; default: AllInforms on successful or unsuccessful SSH login attempts.
Topology stateTopology changesInforms on changes to the device's network topology.
WAN failoverAll | Switched to failover | Switched to main; default: AllInforms on WAN failover occurrences.
WebUIALL | Successful authentication | Unsuccessful authentication; default: AllInforms on successful or unsuccessful HTTP/HTTPS login attempts.
New WiFi clientAll | Connected | Disconnected; default: AllInforms on new WiFi clients. Possible triggers are:
FotaFirmware update is now availableInforms if firmware update is now available

Hotspot client Trap type

FieldValueDescription
TriggerConnected | Disconnected; default: ConnectedThe trigger which invokes the rule.

SNMP variables list

NameOIDDescriptionDeviceMobile notificationsInput/Output notificationsHotspot NotificationsHotspotHotspot SessionsInput/OutputWirelessPort based vlanInterface based vlanSmart Queue ManagementPortMultiWANUniversal Gateway
serial.1.3.6.1.4.1.48690.1.1.0Device serial number
deviceName.0.1.3.6.1.4.1.48690.1.2.0Device name
productCode.1.3.6.1.4.1.48690.1.3.0Device product (ordering) code
batchNumber.1.3.6.1.4.1.48690.1.4.0Device batch number
hardwareRevision.1.3.6.1.4.1.48690.1.5.0Device hardware revision
fwVersion.1.3.6.1.4.1.48690.1.6.0Device RutOS firmware version
deviceUptime.1.3.6.1.4.1.48690.1.7.0Device uptime
cpuUsage.1.3.6.1.4.1.48690.1.8.0CPU usage
signalChangeNotification.1.3.6.1.4.1.48690.4.1.1Signal strength trap
networkTypeNotification.1.3.6.1.4.1.48690.4.1.2Network type trap
digitalInputNotification.1.3.6.1.4.1.48690.4.2.1Digital input trap
digitalOutputNotification.1.3.6.1.4.1.48690.4.2.2Digital output trap
clientConnectedNotification.1.3.6.1.4.1.48690.4.3.1Hotspot client connected trap
clientDisconnectedNotification.1.3.6.1.4.1.48690.4.3.2Hotspot client disconnected trap
hsState.1.3.6.1.4.1.48690.5.1.0Current Hotspot state
hsIP.1.3.6.1.4.1.48690.5.2.0Hotspot IP address
hsNet.1.3.6.1.4.1.48690.5.3.0WiFi interface ID
hsAuth.1.3.6.1.4.1.48690.5.4.0Hotspot authentication type
hsSessionCount.1.3.6.1.4.1.48690.5.5.0Hotspot current active session (connected user) count
hssIndex.1.3.6.1.4.1.48690.5.6.1.1.1Connected Hotspot user indexes
hssMAC.1.3.6.1.4.1.48690.5.6.1.2.1Hotspot user MAC addresses
hssIP.1.3.6.1.4.1.48690.5.6.1.3.1Hotspot user local IP addresses
hssID.1.3.6.1.4.1.48690.5.6.1.4.1Hotspot user session unique IDs
hssUsername.1.3.6.1.4.1.48690.5.6.1.5.1Hotspot connected user usernames
hssState.1.3.6.1.4.1.48690.5.6.1.6.1Hotspot user session states
hssDwLimit.1.3.6.1.4.1.48690.5.6.1.7.1Hotspot user download limits
hssUpLimit.1.3.6.1.4.1.48690.5.6.1.8.1Hotspot user upload limits
hssTimeLimit.1.3.6.1.4.1.48690.5.6.1.9.1Hotspot user session time limit
hssIdleTimeout.1.3.6.1.4.1.48690.5.6.1.10.1Hotspot user maximum idle timeout values
hssDwBandwidth.1.3.6.1.4.1.48690.5.6.1.11.1Hotspot user maximum download speed
hssUpBandwidth.1.3.6.1.4.1.48690.5.6.1.12.1Hotspot user maximum upload speed
hssURL.1.3.6.1.4.1.48690.5.6.1.13.1Hotspot URL
ioCount.1.3.6.1.4.1.48690.6.1Count of I/O
ioTable.1.3.6.1.4.1.48690.6.2A list of I/O. The number of entries is given by the value of ioCount
ioEntry.1.3.6.1.4.1.48690.6.2.1An entry containing information of a particular I/O
ioIndex.1.3.6.1.4.1.48690.6.2.1.1A unique value, greater than zero, for each session
ioSystemName.1.3.6.1.4.1.48690.6.2.1.2The name of the I/O
ioName.1.3.6.1.4.1.48690.6.2.1.3The name of the I/O, as displayed in WebUI
ioType.1.3.6.1.4.1.48690.6.2.1.4A description of I/O type
ioBidirectional.1.3.6.1.4.1.48690.6.2.1.5Is I/O bidirectional?
ioState.1.3.6.1.4.1.48690.6.2.1.6State of I/O
ioInput.1.3.6.1.4.1.48690.6.2.1.7Is I/O an input?
ioInverted.1.3.6.1.4.1.48690.6.2.1.8Is value of I/O inverted?
ioCurrent.1.3.6.1.4.1.48690.6.2.1.9Current amount flowing though ACL
ioPercentage.1.3.6.1.4.1.48690.6.2.1.10Percentage of ACL
ioStateNumeric.1.3.6.1.4.1.48690.6.2.1.11Numeric state of I/O
radioCount.1.3.6.1.4.1.48690.7.1Amount of wireless radios
radioTable.1.3.6.1.4.1.48690.7.2A list of wireless radios
radioEntry.1.3.6.1.4.1.48690.7.2.1An entry containing information of a particular wireless radio
radioIndex.1.3.6.1.4.1.48690.7.2.1.1A unique value, greater than zero, for each wireless radio
radioName.1.3.6.1.4.1.48690.7.2.1.2The name of the wireless radio
radioUpState.1.3.6.1.4.1.48690.7.2.1.3Is the radio currently turned on?
radioDisabledState.1.3.6.1.4.1.48690.7.2.1.4Is the radio currently disabled?
radioChannel.1.3.6.1.4.1.48690.7.2.1.5Current active channel of the wireless radio
wIfaceCount.1.3.6.1.4.1.48690.7.3Amount of wireless interfaces
wIfaceTable.1.3.6.1.4.1.48690.7.4A list of wireless interfaces
wIfaceEntry.1.3.6.1.4.1.48690.7.4.1An entry containing information of a particular wireless interface
wIfaceIndex.1.3.6.1.4.1.48690.7.4.1.1The SSID of a wireless interface
wIfaceSSID.1.3.6.1.4.1.48690.7.4.1.2The SSID of a wireless interface
wIfaceHidden.1.3.6.1.4.1.48690.7.4.1.3Is the wireless interface hidden?
wIfaceEncryption.1.3.6.1.4.1.48690.7.4.1.4The encryption used by the wireless interface
wIfaceMode.1.3.6.1.4.1.48690.7.4.1.5The mode of the wireless interface
pVlanCount.1.3.6.1.4.1.48690.8.1Amount of port-based virtual networks
pVlanTable.1.3.6.1.4.1.48690.8.2A list port-based virtual networks
pVlanEntry.1.3.6.1.4.1.48690.8.2.1An entry containing information about a port-based VLAN
pVlanIndex.1.3.6.1.4.1.48690.8.2.1.1The index of the port-based VLAN
pVlanNum.1.3.6.1.4.1.48690.8.2.1.2The vlan number of the port-based VLAN
pVlanPorts.1.3.6.1.4.1.48690.8.2.1.3The assigned ports of the port-based VLAN
pVlanVID.1.3.6.1.4.1.48690.8.2.1.4The vlan ID of the port-based VLAN
iVlanCount.1.3.6.1.4.1.48690.8.3Amount of interface-based virtual networks
iVlanTable.1.3.6.1.4.1.48690.8.4A list interface-based virtual networks
iVlanEntry.1.3.6.1.4.1.48690.8.4.1An entry containing information about an interface-based VLAN
iVlanIndex.1.3.6.1.4.1.48690.8.4.1.1The index of an iface-based VLAN
iVlanName.1.3.6.1.4.1.48690.8.4.1.2The name of an iface-based VLAN
iVlanType.1.3.6.1.4.1.48690.8.4.1.3The type of an iface-based VLAN
iVlanIfName.1.3.6.1.4.1.48690.8.4.1.4The interface name of an iface-based VLAN
iVlanVID.1.3.6.1.4.1.48690.8.4.1.5The VLAN ID of an iface-based VLAN
queueCount.1.3.6.1.4.1.48690.9.1Amount of traffic shaping configs
queueTable.1.3.6.1.4.1.48690.9.2A list of traffic shaping configs
queueEntry.1.3.6.1.4.1.48690.9.2.1Entry containg info of a traffic shaping config
queueIndex.1.3.6.1.4.1.48690.9.2.1.1The index of the queue
queueName.1.3.6.1.4.1.48690.9.2.1.2The internal name of the queue
queueEnabled.1.3.6.1.4.1.48690.9.2.1.3Is the queue enabled?
queueIface.1.3.6.1.4.1.48690.9.2.1.4The assigned interface of the queue
queueDownLimit.1.3.6.1.4.1.48690.9.2.1.5The download limit of the queue
queueUpLimit.1.3.6.1.4.1.48690.9.2.1.6The upload limit of the queue
queueQdisk.1.3.6.1.4.1.48690.9.2.1.7The queuing discipline in use for this queue
queueScript.1.3.6.1.4.1.48690.9.2.1.8The queuing discipline setup script used in this queue
portCount.1.3.6.1.4.1.48690.10.1.0Number of ports on device
portTable.1.3.6.1.4.1.48690.10.2.0A list of port entries. The number of entries is given by the value of portCount
portEntry.1.3.6.1.4.1.48690.10.2.1.0An entry containing information of a particular port
pIndex.1.3.6.1.4.1.48690.10.2.1.1A unique value, greater than zero, for each port
pName.1.3.6.1.4.1.48690.10.2.1.2Port's name
pNumber.1.3.6.1.4.1.48690.10.2.1.3Port's number
pPosition.1.3.6.1.4.1.48690.10.2.1.4Port's physical position
pState.1.3.6.1.4.1.48690.10.2.1.5Port's state
pSpeed.1.3.6.1.4.1.48690.10.2.1.6Port's speed
pDuplex.1.3.6.1.4.1.48690.10.2.1.7Boolean value whether port is duplex or not
mwan3Count.1.3.6.1.4.1.48690.12.1Count of Multiwan interfaces
mwan3Table.1.3.6.1.4.1.48690.12.2A list of Multiwan interfaces. The number of entries is given by the value of mwan3Count
mwan3Entry.1.3.6.1.4.1.48690.12.2.1An entry containing information of a particular Multiwan interface
mwan3Index.1.3.6.1.4.1.48690.12.2.1.1Unique value, greater than zero, for each session
mwan3Name.1.3.6.1.4.1.48690.12.2.1.2Name of Multiwan interface
mwan3Enabled.1.3.6.1.4.1.48690.12.2.1.3Numeric value indicating if interface is enabled or not
mwan3Uptime.1.3.6.1.4.1.48690.12.2.1.4Multiwan interface uptime
mwan3Status.1.3.6.1.4.1.48690.12.2.1.5Status of Multiwan interface
mwan3Ip.1.3.6.1.4.1.48690.12.2.1.6IP addresses that Multiwan interface tracks
tagTable.1.3.6.1.4.1.48690.20.1Tag table represents all resolved tags currently for modbus and mbus.
tagEntry.1.3.6.1.4.1.48690.20.1.1An entry containing information of a particular tag.
tagIndex.1.3.6.1.4.1.48690.20.1.1.1Unique index for the tag entry.
tagId.1.3.6.1.4.1.48690.20.1.1.2Identifier for the tag.
tagPrettyName.1.3.6.1.4.1.48690.20.1.1.3Tag pretty name.
tagSource.1.3.6.1.4.1.48690.20.1.1.4Source protocol of the tag.
tagPermissions.1.3.6.1.4.1.48690.20.1.1.5Permissions for the tag.
tagType.1.3.6.1.4.1.48690.20.1.1.6Data type of the 'tagValue' object.
tagValueSize.1.3.6.1.4.1.48690.20.1.1.7Number of values in this tag. This is mainly used to see how many values are stored in the 'tagValueTable' for this tag, though it is not guaranteed that the number of values in the table matches this count, as with some data types such as string there will be only one 'tagValueTable' entry.
tagTimestamp.1.3.6.1.4.1.48690.20.1.1.8The Unix timestamp of the last time the tag information was updated. This is mainly intended to see when the tagValueTable of this tag was last updated.
tagValueTable.1.3.6.1.4.1.48690.20.2This table holds information about tag values of each tag.
tagValueEntry.1.3.6.1.4.1.48690.20.2.1An entry containing information of a particular tag value. Each tag can have multiple values, which are stored in this table. Each value is usually indexed by unique ID 'tagValueIndex' which is unique for each tag, starting from 0. The 'tagValue' object contains the raw value of the tag, which can be of different data types as specified by the 'tagType' object in the tag entry.
tagValueIndex.1.3.6.1.4.1.48690.20.2.1.1Unique index for the tag value entry.
tagValue.1.3.6.1.4.1.48690.20.2.1.2Raw value of the tag value, refer to 'tagType' object for the data type. (Note: Universal Gateway supports SET commands for tagValue table entries)

SNMP Data Sources

SNMP Data sources transmit data from one or more data sources (can be a Modbus client, DNP3 client) and assign them SNMP OID.
To add new data source, press `Add` button:
Object configuration:
FieldValueDescription
Enableoff | on; default: offTurns Object configuration on or off.
Object namestring; default: noneName of the object.
Object sourcelist; default: noneClient service which will be sending requests.
Object valuelist and permissions type; default: noneRequest value and its permissions (Read-Only, Write-Only or Read-Write).
Object rangeinteger [1..65535]; default: noneSpecify the start index and count for the range.
Object typeBinary | String | Bool | INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | FLOAT32 | FLOAT64; default: BinaryValue data type.
SNMP OIDunsigned integer; default: 0OID at which the value will be accessible via SNMP.