Difference between revisions of "Template:Networking rutos manual snmp"
(→Trap Settings: Added RUT30X and RUT2 device input/output information.) |
|||
(46 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | <!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} | + | <!-- Template uses {{{name}}}, {{{series}}}, and if device doesn't have mobile then {{{mobile}}} = 0--> |
− | {{Template: | + | {{Template: Networking_rutos_manual_fw_disclosure |
− | + | | fw_version ={{Template: Networking_rutos_manual_latest_fw | |
− | |||
− | | fw_version ={{Template: | ||
| 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: | + | {{#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}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: | + | {{#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>|}} |
==Summary== | ==Summary== | ||
Line 16: | Line 14: | ||
<u><b> | <u><b> | ||
− | Note:</b> SNMP is additional software that can be installed from the <b> | + | Note:</b> SNMP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u> |
}} | }} | ||
Line 29: | Line 27: | ||
===SNMP agent settings=== | ===SNMP agent settings=== | ||
---- | ---- | ||
− | [[File: | + | [[File:Networking_rutos_manual_snmp_snmp_agent_settings.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 48: | Line 46: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>IP | + | <td>IP family</td> |
<td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td> | <td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td> | ||
− | <td>IP | + | <td>IP family used by SNMP.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 191: | Line 189: | ||
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: | + | [[File:Networking_rutos_manual_snmp_communities_edit_button.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 256: | Line 254: | ||
<b>SNMP Traps</b> 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. | <b>SNMP Traps</b> 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 - <b>Trap service settings</b> and <b>Trap rules</b>. Trap service settings lets you manage | + | Trap settings page is divided in two sections - <b>Trap service settings</b> and <b>Trap rules</b>. Trap service settings lets you manage the host which will get configured alert messages, Trap rules lets you manage rules which when triggered will send alerts. |
===Trap Service Settings=== | ===Trap Service Settings=== | ||
---- | ---- | ||
− | The <b>Trap Service Settings</b> is used to manage <b> | + | The <b>Trap Service Settings</b> is used to manage the <b>host</b> which will be alerted when an SNMP trap is triggered. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | [[File: | + | [[File:Networking_rutos_manual_snmp_trap_settings_trap_service_settings_v1.png]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 277: | Line 269: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Host | + | <td>Enable</td> |
+ | <td>off | on; default: <b>off</b></td> | ||
+ | <td>Turns the host on or off. SNMP traffic is only sent to the host if it is enabled.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Host</td> | ||
<td>url | ip; default: <b>none</b></td> | <td>url | ip; default: <b>none</b></td> | ||
<td>Hostname or IP address to transfer SNMP traffic to.</td> | <td>Hostname or IP address to transfer SNMP traffic to.</td> | ||
Line 283: | Line 280: | ||
<tr> | <tr> | ||
<td>Port</td> | <td>Port</td> | ||
− | <td>integer [ | + | <td>integer [1..65535]; default: <b>162</b></td> |
<td>Trap host's port number.</td> | <td>Trap host's port number.</td> | ||
</tr> | </tr> | ||
Line 290: | Line 287: | ||
<td>string; default: <b>Public</b></td> | <td>string; default: <b>Public</b></td> | ||
<td>Name of the community to which the trap belongs.</td> | <td>Name of the community to which the trap belongs.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
</table> | </table> | ||
Line 309: | Line 296: | ||
You can create a new trap rule by clicking the 'Add' button. | You can create a new trap rule by clicking the 'Add' button. | ||
− | [[File: | + | [[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_add_button_v1.png|border|class=tlt-border]] |
You should be redirected to the rule's configuration page which should look something like this: | 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]] | + | [[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_modify_trap_rule_mobile_{{{mobile}}}_v1.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. | 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. | 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. | ||
− | |||
{{#ifeq: {{{mobile}}} | 1 | | {{#ifeq: {{{mobile}}} | 1 | | ||
− | ==== | + | ====GSM==== |
---- | ---- | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 330: | Line 316: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>Trap type</td> |
− | <td> | + | <td>GSM <nowiki>|</nowiki> Input/Output; default: <b>GSM</b></td> |
− | <td> | + | <td>The type of SNMP Trap rule. In this case GSM.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>Trigger</td> |
− | <td>Signal strength | + | <td>Signal strength <nowiki>|</nowiki> Network type; default: <b>Signal strength</b></td> |
− | <td>Rule will be triggered if signal strength falls below specified number.</td> | + | <td>The trigger which invokes the rule. Possible triggers: |
+ | <ul> | ||
+ | <li><b>Signal strength</b> - Rule will be triggered if signal strength falls below specified number.</li> | ||
+ | <li><b>Network type</b> - Rule will be triggered if network connection type changes.</li> | ||
+ | </ul></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 346: | Line 336: | ||
</table> | </table> | ||
<br> | <br> | ||
− | ==== | + | |}} |
+ | ====Input/Output==== | ||
---- | ---- | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 356: | Line 347: | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
− | <td>off | + | <td>off | on; default: <b>off</b></td> |
<td>Enable or disable this rule.</td> | <td>Enable or disable this rule.</td> | ||
</tr> | </tr> | ||
− | |||
<tr> | <tr> | ||
− | <td> | + | <td>Trap type</td> |
− | <td> | + | <td>{{#ifeq: {{{mobile}}} | 1 |GSM <nowiki>|</nowiki> |}}Input/Output; default: {{#ifeq: {{{mobile}}} | 1 |<b>GSM</b>|<b>Input/Output</b>}}</td> |
− | <td> | + | <td>The type of SNMP Trap rule. In this case Input/Output.</td> |
</tr> | </tr> | ||
− | + | {{#switch:{{{series}}} | |
− | + | |RUTX|RUTM|RUT2 = | |
− | {{# | ||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
− | < | + | <td>Trigger</td> |
− | < | + | <td>Input(3) {{!}} Output(4); default: <b>Input(3)</b></td> |
− | < | + | <td>Which type of Inputs and Outputs to use in this rule.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
+ | |TRB2 = | ||
<tr> | <tr> | ||
− | <td> | + | <td>Trigger</td> |
− | <td>Input/Output | + | <td><span style="color:red">Analog input(11)</span> {{!}} Configurable Input/Output (2) {{!}} Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: Analog Input(11)</td> |
− | <td> | + | <td>Which type of Inputs and Outputs to use in this rule.</td> |
</tr> | </tr> | ||
− | |||
− | |||
<tr> | <tr> | ||
− | <td> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td><span style="color:red">Analog input(11):</span> State change</td> |
− | <td> | + | <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td><span style="color:red">Analog input(11):</span> Min voltage</td> |
− | <td> | + | <td>positive float; default: <b>none</b></td> |
− | <td> | + | <td>At which minimum voltage value will this rule be triggered.</td> |
</tr> | </tr> | ||
− | |||
<tr> | <tr> | ||
− | + | <td><span style="color:red">Analog input(11):</span> Max voltage</td> | |
− | <td><span style="color: | + | <td>positive float; default: <b>none</b></td> |
− | <td> | + | <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td> |
</tr> | </tr> | ||
+ | |TRB1 = | ||
+ | {{#ifeq:{{{name}}}|TRB141| | ||
<tr> | <tr> | ||
− | <td><span style="color: | + | <td>Trigger</td> |
− | + | <td><span style="color:red">Analog Current Loop (7)</span> {{!}} <span style="color:red">Analog Input (7)</span> {{!}} <span style="color:blue">Passive/Active input (Dry/Wet) (1)</span> {{!}} <span style="color:blue">Passive/Active input (Dry/Wet) (2)</span> {{!}} Configurable Input/Output (3) {{!}} Configurable Input/Output (4) {{!}} Isolated Input (8,16) {{!}} <span style="color:green">Relay (3,4,5)</span> {{!}} <span style="color:green">Latching Relay (11,12,13)</span>; default: <b>Analog Current Loop (7)</b></td> | |
<td>Which type of Inputs and Outputs to use in this rule.</td> | <td>Which type of Inputs and Outputs to use in this rule.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td | + | <td>State change</td> |
<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> | ||
<tr> | <tr> | ||
− | <td><span style="color:red"> | + | <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> State change</td> |
− | <td> | + | <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td><span style="color: | + | <td><span style="color:blue">Passive/Active input (Dry/Wet):</span> State change</td> |
− | <td> | + | <td>Rising {{!}} Falling {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
− | < | + | <td><span style="color:green">Relay (3,4,5), Latching Relay (11,12,13):</span> State change</td> |
− | < | + | <td>Open {{!}} Closed {{!}} Both; default: <b>Both</b></td> |
− | < | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>< | + | <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Min voltage</td> |
− | <td> | + | <td>positive float; default: <b>none</b></td> |
− | <td> | + | <td>At which minimum voltage value will this rule be triggered.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>< | + | <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Max voltage</td> |
− | <td> | + | <td>positive float; default: <b>none</b></td> |
− | <td> | + | <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td> |
</tr> | </tr> | ||
+ | | | ||
<tr> | <tr> | ||
− | <td>< | + | <td>Trigger</td> |
− | + | <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td> | |
− | <td> | + | <td>Which type of Inputs and Outputs to use in this rule.</td> |
− | </tr> | + | </tr> |
<tr> | <tr> | ||
− | <td> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
− | </tr> | + | </tr>}} |
+ | |RUT36X = | ||
<tr> | <tr> | ||
− | <td> | + | <td>Trigger</td> |
− | <td> | + | <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td> |
− | <td> | + | <td>Which type of Inputs and Outputs to use in this rule.</td> |
− | </tr> | + | </tr> |
<tr> | <tr> | ||
− | <td><b> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
− | </tr> | + | </tr> |
+ | |RUT9 = | ||
+ | {{#ifeq:{{{name}}}|RUT955| | ||
+ | <tr> | ||
+ | <td>Trigger</td> | ||
+ | <td><span style="color:red">Analog Current Loop (6,9)</span> {{!}} <span style="color:red">Analog Input (6,9)</span> {{!}} Input (3) {{!}} Digital Input (1) {{!}} Output (4) {{!}} Isolated output (3,4,8) {{!}} Isolated Input (2,7) {{!}} <span style="color:blue">Relay (5,10)</span>; default: <b>Analog Current Loop (6,9)</b></td> | ||
+ | <td>Which type of Inputs and Outputs to use in this rule.</td> | ||
+ | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
− | </tr> | + | </tr> |
<tr> | <tr> | ||
− | <td>< | + | <td><span style="color:red">Analog Current Loop (6,9), Analog Input (6,9):</span> State change</td> |
− | <td> | + | <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
− | </tr> | + | </tr> |
<tr> | <tr> | ||
− | <td>< | + | <td><span style="color:blue">Relay (5,10):</span> State change</td> |
− | <td> | + | <td>Open {{!}} Closed {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>< | + | <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Min voltage</td> |
− | <td> | + | <td>positive float; default: <b>none</b></td> |
− | <td> | + | <td>At which minimum voltage value will this rule be triggered.</td> |
− | </tr> | + | </tr> |
<tr> | <tr> | ||
− | <td>< | + | <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Max voltage</td> |
− | <td> | + | <td>positive float; default: <b>none</b></td> |
− | <td> | + | <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td> |
− | </tr> | + | </tr> |
+ | | | ||
<tr> | <tr> | ||
− | <td>< | + | <td>Trigger</td> |
− | + | <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td> | |
− | <td> | + | <td>Which type of Inputs and Outputs to use in this rule.</td> |
− | </tr> | + | </tr> |
<tr> | <tr> | ||
− | <td><b> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | <td> | + | <td>On which Input/Output state will this rule be triggered.</td> |
− | </tr> | + | </tr> |
+ | |}} | ||
+ | |RUT30X = | ||
+ | <tr> | ||
+ | <td>Trigger</td> | ||
+ | <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td> | ||
+ | <td>Which type of Inputs and Outputs to use in this rule.</td> | ||
+ | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>State change</td> |
− | <td> | + | <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td> |
− | + | <td>On which Input/Output state will this rule be triggered.</td> | |
− | + | </tr> | |
− | + | }} | |
− | + | ||
− | |||
− | <td> | ||
− | </tr> | ||
</table> | </table> | ||
− | |||
==SNMP variables list== | ==SNMP variables list== | ||
Line 688: | Line 530: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>routerName.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 711: | Line 553: | ||
<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>{{#ifeq: {{{mobile}}} | 1 | | </tr>{{#ifeq: {{{mobile}}} | 1 | | ||
<tr> | <tr> | ||
Line 731: | Line 563: | ||
<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> | ||
<tr> | <tr> | ||
Line 841: | Line 668: | ||
<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>|}}{{#ifeq: {{{gps}}} | 1 | | </tr>|}}{{#ifeq: {{{gps}}} | 1 | | ||
<tr> | <tr> | ||
Line 927: | Line 699: | ||
<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: {{{hotspot}}} | 1 | | </tr>|}}{{#ifeq: {{{hotspot}}} | 1 | | ||
<tr> | <tr> | ||
Line 1,137: | Line 799: | ||
<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>|}} | </tr>|}} | ||
</table> | </table> | ||
[[Category:{{{name}}} Services section]] | [[Category:{{{name}}} Services section]] |
Revision as of 07:56, 27 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:
- 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. |
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 the host 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 the host which will be alerted when an SNMP trap is triggered.
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Turns the host on or off. SNMP traffic is only sent to the host if it is enabled. |
Host | url | ip; default: none | Hostname or IP address to transfer SNMP traffic to. |
Port | integer [1..65535]; default: 162 | Trap host's port number. |
Community | string; default: Public | Name of the community to which the trap belongs. |
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}}}_v1.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 | Value | Description |
---|---|---|
Enable | off | on; default: off | Enable or disable this rule. |
Trap type | Input/Output; default: Input/Output | The type of SNMP Trap rule. In this case Input/Output. |
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]]