RUT240 SNMP

Wiki mirrorView source
The information in this page is updated in accordance with firmware version RUT2_R_00.07.06.21.

Note: click here for the old style WebUI (FW version RUT2XX_R_00.01.14.7 and earlier) user manual page.

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 RUT240 devices.
Note: SNMP is additional software that can be installed from the System → 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

FieldValueDescription
Enable SNMP serviceoff | on; default: offRun SNMP service on system's startup.
Enable remote accessoff | on; default: offOpen port in firewall so that SNMP service may be reached from WAN.
IP typeIPv4 | IPv6 | IPv4v6; default: IPv4IP type used by SNMP.
Portinteger [0..65535]; default: 161SNMP service's port.
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.

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)Downloads the device's MIB file.
System OID1.3.6.1.4.1.48690OID or Object Identifier, is an identifier used to name and point to an object in the MIB hierarchy.
Locationstring; default: locationTrap named sysLocation.
Contactstring; default: [email protected]Trap named sysContact.
Namestring; default: nameTrap 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.
FieldValueDescription
Enable off | on; default: offTurns this SNMP user on or off.
Usernamestring; default: none Set username to access SNMP.
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 typeSHA | MD5; default: SHASet 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 | AES; 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-OnlyThe 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 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: noneName of the community.
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 for current community.
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 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:
FieldValueDescription
Host/IPurl | ip; default: noneHostname or IP address to transfer SNMP traffic to.
Portinteger [0..65535]; default: 162Trap host's port number.
Communitystring; default: PublicName of the community to which the trap belongs.
Delete- (interactive button)Deletes the host next to the button.
off/on slideroff | on; default: offTurns 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:
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

FieldValueDescription
Enableoff | on; default: offEnable or disable this rule.
ActionSignal strength trapRule will be triggered if signal strength falls below specified number.
Signal strengthinteger [-130..0]; default: noneGSM signal's strength value in dBm, e.g. -85

Connection type

FieldValueDescription
Enableoff | on; default: offEnable or disable this rule.
ActionConnection type trapRule will be triggered when connection type will change.

Input/Output

field namevalue1description
Enableoff | on; default: offEnable or disable this rule.
ActionInput/Output trapRule will be triggered when specified input or output state will change.

Events log

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| From SMS; default: AllInforms on if the device was rebooted.
StartupDevice startup completedInforms on when the device is fully booted.
Mobile dataAll | Connected | Disconnected; default AllInforms on changes to the state of the device's mobile connection.
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 Reboot Scheduler | From WebUI | From SMS; default: AllInforms after device reboot occurrences.
Signal strengthAll | - 121 dBm - 113 dBm | - 113 dBm - 98 dBm | - 98 dBm - 93 dBm | - 93 dBm - 75 dBm | - 75 dBm - 60 dBm | - 60 dBm - 50 dBm; default: AllInforms on signal strength changes.
SMSSMS receivedInforms on received SMS messages.
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.
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:

SNMP variables list

NameOIDDescriptionDeviceMobileMobile notificationsInput/Output notificationsHotspot NotificationsHotspotHotspot SessionsInput/OutputWirelessInterface based vlanSmart Queue ManagementPort
serial.1.3.6.1.4.1.48690.1.1.0Device serial number
routerName.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
modemNum.1.3.6.1.4.1.48690.2.1.0The number of modems (regardless of their current state) present on this system
mIndex.1.3.6.1.4.1.48690.2.2.1.1.1Available modem indexes; used to index OIDs between when the device has multiple modems
mDescr.1.3.6.1.4.1.48690.2.2.1.2.1Modem description
mImei.1.3.6.1.4.1.48690.2.2.1.3.1Modem IMEI
mModel.1.3.6.1.4.1.48690.2.2.1.4.1Modem model
mManufacturer.1.3.6.1.4.1.48690.2.2.1.5.1Modem manufacturer
mRevision.1.3.6.1.4.1.48690.2.2.1.6.1Modem firmware version
mSerial.1.3.6.1.4.1.48690.2.2.1.7.1Modem serial number
mIMSI.1.3.6.1.4.1.48690.2.2.1.8.1Modem IMSI number
mSimState.1.3.6.1.4.1.48690.2.2.1.9.1SIM card status
mPinState.1.3.6.1.4.1.48690.2.2.1.10.1PIN status
mNetState.1.3.6.1.4.1.48690.2.2.1.11.1Mobile network registration status
mSignal.1.3.6.1.4.1.48690.2.2.1.12.1Signal strength level
mOperator.1.3.6.1.4.1.48690.2.2.1.13.1Current mobile network operator
mOperatorNumber.1.3.6.1.4.1.48690.2.2.1.14.1Mobile operator number (MCC+MNC)
mConnectionState.1.3.6.1.4.1.48690.2.2.1.15.1Mobile data connection state
mConnectionType.1.3.6.1.4.1.48690.2.2.1.16.1Mobile data connection type
mTemperature.1.3.6.1.4.1.48690.2.2.1.17.1Modem's temperature in 0.1 degrees Celsius
mCellID.1.3.6.1.4.1.48690.2.2.1.18.1Cell (Base transceiver station) ID
mSINR.1.3.6.1.4.1.48690.2.2.1.19.1SINR value in dB
mRSRP.1.3.6.1.4.1.48690.2.2.1.20.1RSRP value in dBm
mRSRQ.1.3.6.1.4.1.48690.2.2.1.21.1RSRQ value in dB
mSent.1.3.6.1.4.1.48690.2.2.1.22.1Total bytes sent
mReceived.1.3.6.1.4.1.48690.2.2.1.23.1Total bytes received
mIP.1.3.6.1.4.1.48690.2.2.1.24.1Modem IP address(es)
mSentToday.1.3.6.1.4.1.48690.2.2.1.25.1Bytes sent today
mReceivedToday.1.3.6.1.4.1.48690.2.2.1.26.1Bytes received today
mICCID.1.3.6.1.4.1.48690.2.2.1.27.1SIM ICCID
mSentCurrentWeek.1.3.6.1.4.1.48690.2.2.1.28.1Bytes sent this week
mReceivedCurrentWeek.1.3.6.1.4.1.48690.2.2.1.29.1Bytes received this week
mSentCurrentMonth.1.3.6.1.4.1.48690.2.2.1.30.1Bytes sent this month
mReceivedCurrentMonth.1.3.6.1.4.1.48690.2.2.1.31.1Bytes received this month
connectionUptime.1.3.6.1.4.1.48690.2.3.0.1Mobile connection uptime
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
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