Template:Networking rutos manual snmp
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.
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. |
| Protocol | UDP | TCP; default: UDP | SNMP service's protocol. |
| 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:
- Enter a custom name for the new user in the 'Name' field.
- Click the 'Add' button.
- 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. |
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: on | 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 can then edit the trap rule by clicking the 'Edit' button next to it.
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 | value | description |
|---|---|---|
| Enable | off | on; default: on | 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 |
| Mobile | ||
| mIndex | .1.3.6.1.4.1.48690.2.2.1.1 | Available 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 | Modem description |
| mImei | .1.3.6.1.4.1.48690.2.2.1.3 | Modem IMEI |
| mModel | .1.3.6.1.4.1.48690.2.2.1.4 | Modem model |
| mManufacturer | .1.3.6.1.4.1.48690.2.2.1.5 | Modem manufacturer |
| mRevision | .1.3.6.1.4.1.48690.2.2.1.6 | Modem firmware version |
| mSerial | .1.3.6.1.4.1.48690.2.2.1.7 | Modem serial number |
| mIMSI | .1.3.6.1.4.1.48690.2.2.1.8 | Modem IMSI number |
| mSimState | .1.3.6.1.4.1.48690.2.2.1.9 | SIM card status |
| mPinState | .1.3.6.1.4.1.48690.2.2.1.10 | PIN status |
| mNetState | .1.3.6.1.4.1.48690.2.2.1.11 | Mobile network registration status |
| mSignal | .1.3.6.1.4.1.48690.2.2.1.12 | Signal strength level |
| mOperator | .1.3.6.1.4.1.48690.2.2.1.13 | Current mobile network operator |
| mOperatorNumber | .1.3.6.1.4.1.48690.2.2.1.14 | Mobile operator number (MCC+MNC) |
| mConnectionState | .1.3.6.1.4.1.48690.2.2.1.15 | Mobile data connection state |
| mConnectionType | .1.3.6.1.4.1.48690.2.2.1.16 | Mobile data connection type |
| mTemperature | .1.3.6.1.4.1.48690.2.2.1.17 | Modem's temperature in 0.1 degrees Celsius |
| mCellID | .1.3.6.1.4.1.48690.2.2.1.18 | Cell (Base transceiver station) ID |
| mSINR | .1.3.6.1.4.1.48690.2.2.1.19 | SINR value in dB |
| mRSRP | .1.3.6.1.4.1.48690.2.2.1.20 | RSRP value in dBm |
| mRSRQ | .1.3.6.1.4.1.48690.2.2.1.21 | RSRQ value in dB |
| GPS | ||
| latitude | .1.3.6.1.4.1.48690.3.1.0 | GPS Latitude value |
| longitude | .1.3.6.1.4.1.48690.3.2.0 | GPS Longitude value |
| accuracy | .1.3.6.1.4.1.48690.3.3.0 | GPS coordinate accuracy |
| datetime | .1.3.6.1.4.1.48690.3.4.0 | GPS coordinate fix time |
| numSatellites | .1.3.6.1.4.1.48690.3.5.0 | Number of available GPS satelites |
| Hotspot | ||
| hsState | .1.3.6.1.4.1.48690.5.1.0 | Current Hotspot state |
| hsIP | .1.3.6.1.4.1.48690.5.2.0 | Hotspot IP address |
| hsNet | .1.3.6.1.4.1.48690.5.3.0 | WiFi interface ID |
| hsAuth | .1.3.6.1.4.1.48690.5.4.0 | Hotspot authentication type |
| hsSessionCount | .1.3.6.1.4.1.48690.5.5.0 | Hotspot current active session (connected user) count |
| Hotspot Sessions | ||
| hssIndex | .1.3.6.1.4.1.48690.5.6.1.1 | Connected Hotspot user indexes |
| hssMAC | .1.3.6.1.4.1.48690.5.6.1.2 | Hotspot user MAC addresses |
| hssIP | .1.3.6.1.4.1.48690.5.6.1.3 | Hotspot user local IP addresses |
| hssID | .1.3.6.1.4.1.48690.5.6.1.4 | Hotspot user session unique IDs |
| hssUsername | .1.3.6.1.4.1.48690.5.6.1.5 | Hotspot connected user usernames |
| hssState | .1.3.6.1.4.1.48690.5.6.1.6 | Hotspot user session states |
| hssDwLimit | .1.3.6.1.4.1.48690.5.6.1.7 | Hotspot user download limits |
| hssUpLimit | .1.3.6.1.4.1.48690.5.6.1.8 | Hotspot user upload limits |
| hssTimeLimit | .1.3.6.1.4.1.48690.5.6.1.9 | Hotspot user session time limit |
| hssIdleTimeout | .1.3.6.1.4.1.48690.5.6.1.10 | Hotspot user maximum idle timeout values |
| hssDwBandwidth | .1.3.6.1.4.1.48690.5.6.1.11 | Hotspot user maximum download speed |
| hssUpBandwidth | .1.3.6.1.4.1.48690.5.6.1.12 | Hotspot user maximum upload speed |
| hssURL | .1.3.6.1.4.1.48690.5.6.1.13 | Hotspot URL |
[[Category:{{{name}}} Services section]]