Template:Networking rutos manual snmp: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
(→‎Trap Rules: Added mobile RUTX12 modem select)
No edit summary
 
(42 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<!-- Template uses {{{name}}}, {{{series}}}, and if device doesn't have mobile then {{{mobile}}} = 0-->
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wireless}}} (1), {{eth}} (1) -->
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
  | 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: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#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_device_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: Networking_rutos_manual_latest_fw | series = RUT2XX}} 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: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==


Line 14: Line 16:
<u><b>
<u><b>


Note:</b> SNMP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
Note:</b> SNMP is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
}}


Line 27: Line 29:
===SNMP agent settings===
===SNMP agent settings===
----
----
[[File:Networking_rutos_manual_snmp_snmp_agent_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_snmp_snmp_agent_settings_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 46: Line 48:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>IP family</td>
         <td>IP type</td>
         <td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td>
         <td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td>
         <td>IP family used by SNMP.</td>
         <td>IP type used by SNMP.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 189: Line 191:
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:Networking_rutos_manual_snmp_communities_edit_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_snmp_communities_edit_button_v1.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 254: Line 256:
<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 the host which will get configured alert messages, Trap rules lets you manage rules which when triggered will send alerts.  
Trap settings page is divided in two sections - <b>Trap service settings</b> and <b>Trap rules</b>. 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===
===Trap Service Settings===
----
----
The <b>Trap Service Settings</b> is used to manage the <b>host</b> which will be alerted when an SNMP trap is triggered.  
The <b>Trap Service Settings</b> is used to manage <b>hosts</b> 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.
 
[[File:Networking_rutos_manual_snmp_trap_settings_trap_service_settings_add_button.png|border|class=tlt-border]]
 
The newly added Host configuration should look similar to this:


[[File:Networking_rutos_manual_snmp_trap_settings_trap_service_settings_v1.png]]
[[File:Networking_rutos_manual_snmp_trap_settings_trap_service_settings_configuration.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 269: Line 277:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Enable</td>
         <td>Host/IP</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 280: Line 283:
     <tr>
     <tr>
         <td>Port</td>
         <td>Port</td>
         <td>integer [1..65535]; default: <b>162</b></td>
         <td>integer [0..65535]; default: <b>162</b></td>
         <td>Trap host's port number.</td>
         <td>Trap host's port number.</td>
     </tr>
     </tr>
Line 287: Line 290:
         <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>
        <td>Delete</td>
        <td>- (interactive button)</td>
        <td>Deletes the host next to the button.</td>
    </tr>
    <tr>
        <td>off/on slider</td>
        <td>off | on; default: <b>off</b></td>
        <td>Turns the host on or off. SNMP traffic is only sent to enabled hosts.</td>
     </tr>
     </tr>
</table>
</table>
Line 296: Line 309:
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:Networking_rutos_manual_snmp_trap_settings_trap_rules_add_button_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_add_button.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}}}_v1.png|border|class=tlt-border]]
[[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.  
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====
====Signal strength====
----
----
<table class="nd-mantable">
<table class="nd-mantable">
Line 316: Line 330:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Trap type</td>
         <td>Enable</td>
         <td>GSM{{#switch: {{{name}}} | RUTXR1 | TCR100 =;| <nowiki>|</nowiki> Input/Output;}} default: <b>GSM</b></td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
         <td>The type of SNMP Trap rule. In this case GSM.</td>
         <td>Enable or disable this rule.</td>
     </tr>
     </tr>
    {{#ifeq: {{{name}}} | RUTX12 |
     <tr>
     <tr>
         <td>Modem</td>
         <td>Action</td>
        <td>Primary modem <nowiki>|</nowiki> Secondary modem; default: <b>Primary modem</b></td>
         <td>Signal strength trap</td>
        <td>The modem on which the SNMP trap rule will be set.</td>
         <td>Rule will be triggered if signal strength falls below specified number.</td>
    </tr>
    |}}
    <tr>
        <td>Trigger</td>
         <td>Signal strength <nowiki>|</nowiki> Network type; default: <b>Signal strength</b></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 343: Line 346:
</table>
</table>
<br>
<br>
|}}
====Connection type====
{{#switch: {{{name}}} | RUTXR1 | TCR100 = <br>| #default =
====Input/Output====
----
----
<table class="nd-mantable">
<table class="nd-mantable">
Line 358: Line 359:
         <td>Enable or disable this rule.</td>
         <td>Enable or disable this rule.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Trap type</td>
         <td>Action</td>
         <td>{{#ifeq: {{{mobile}}} | 1 |GSM <nowiki>|</nowiki> |}}Input/Output; default: {{#ifeq: {{{mobile}}} | 1 |<b>GSM</b>|<b>Input/Output</b>}}</td>
         <td>Connection type trap</td>
         <td>The type of SNMP Trap rule. In this case Input/Output.</td>
         <td>Rule will be triggered when connection type will change.</td>
     </tr>
     </tr>
{{#switch:{{{series}}}
</table>|}}
|RUTX|RUTM|RUT2|RUT2M =  
 
{{#ifeq: {{{io}}} | 1 |
====Input/Output====
----
<table class="nd-mantable">
     <tr>
     <tr>
         <td>Trigger</td>
         <th>field name</th>
         <td>Input(3) {{!}} Output(4); default: <b>Input(3)</b></td>
         <th>value1</th>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
         <th>description</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>State change</td>
         <td>Enable</td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Enable or disable this rule.</td>
     </tr>
     </tr>
|TRB2 =
     <tr>
     <tr>
         <td>Trigger</td>
         <td>Action</td>
         <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>Input/Output trap</td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
         <td>Rule will be triggered when specified input or output state will change.</td>
     </tr>
     </tr>
{{#switch:{{{series}}}
|RUTX|RUTM =
     <tr>
     <tr>
         <td>State change</td>
         <td>Input/Output type</td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>Input/Output; default: <b>Input/Output</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:red">Analog input(11):</span> State change</td>
         <td>Input/Output name</td>
        <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td>
         <td>Output(4) {{!}} Input(3); default: <b>Output(4)</b></td>
        <td>On which Input/Output state will this rule be triggered.</td>
    </tr>
    <tr>
        <td><span style="color:red">Analog input(11):</span> Min voltage</td>
        <td>positive float; default: <b>none</b></td>
        <td>At which minimum voltage value will this rule be triggered.</td>
    </tr>
    <tr>
        <td><span style="color:red">Analog input(11):</span> Max voltage</td>
        <td>positive float; default: <b>none</b></td>
        <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td>
    </tr>
|TRB1 =
    {{#ifeq:{{{name}}}|TRB141|
    <tr>
        <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>State change</td>
         <td>State change</td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>High level</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>
|TRB2|TRB2M =
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> State change</td>
        <td>Input/Output type</td>
        <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td>
         <td><span style="color:blue">Input/Output</span> {{!}} <span style="color:red">ADC</span>; default: <b>Input/Output</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:blue">Passive/Active input (Dry/Wet):</span> State change</td>
         <td><span style="color:blue">Input/Output:</span> Input/Output name</td>
         <td>Rising {{!}} Falling {{!}} Both; default: <b>Both</b></td>
         <td>Configurable Input/Output([2..4]); default: <b>Configurable Input/Output(2)</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:green">Relay (3,4,5), Latching Relay (11,12,13):</span> State change</td>
         <td><span style="color:blue">Input/Output:</span> State change</td>
         <td>Open {{!}} Closed {{!}} 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">Analog Current Loop (7), Analog Input (7):</span> Min voltage</td>
         <td><span style="color:red">ADC:</span> Input/Output name</td>
         <td>positive float; default: <b>none</b></td>
         <td>ADC; default: <b>ADC</b></td>
         <td>At which minimum voltage value will this rule be triggered.</td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Max voltage</td>
         <td><span style="color:red">ADC:</span> Voltage</td>
         <td>positive float; default: <b>none</b></td>
         <td>positive float [0..40]; default: <b>none</b></td>
         <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td>
         <td>At which voltage value will this rule be triggered.</td>
     </tr>
     </tr>
|TRB1 =
    {{#ifeq:{{{name}}}|TRB141|
        <tr>
            <td>Input/Output type</td>
            <td><span style="color:blue"><b>Input/Output</b></span> {{!}} <span style="color:dodgerblue"><b>Wet/Dry Input</b></span> {{!}} <span style="color:forestgreen"><b>Relay</b></span> {{!}} <span style="color:darkred"><b>4–20 mA Current Loop</b></span> {{!}} <span style="color:chocolate"><b>ADC</b></span>; default: <b>Input/Output</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:blue">Input/Output:</span> Input/Output name</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>
            <td><span style="color:blue">Input/Output:</span> State change</td>
            <td>High level {{!}} Low level {{!}} Both; default: <b>High level</b></td>
            <td>On which Input/Output state will this rule be triggered.</td>
        </tr>
        <tr>
            <td><span style="color:dodgerblue">Wet/Dry Input:</span> Input/Output name</td>
            <td>Wet/Dry Input(1) {{!}} Wet/Dry Input(2); default: <b>Wet/Dry Input(1)</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:dodgerblue">Wet/Dry Input:</span> State change</td>
            <td>Rising {{!}} Falling {{!}} Both; default: <b>Rising</b></td>
            <td>On which Input/Output state will this rule be triggered.</td>
        </tr>
        <tr>
            <td><span style="color:forestgreen">Relay:</span> Input/Output name</td>
            <td>Relay(3,4,5) {{!}} Latching relay(11,12,13); default: <b>Relay(3,4,5)</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:forestgreen">Relay:</span> State change</td>
            <td>Open {{!}} Closed {{!}} Both; default: <b>Open</b></td>
            <td>On which Input/Output state will this rule be triggered.</td>
        </tr>
        <tr>
            <td><span style="color:darkred">4–20 mA Current Loop:</span> Input/Output name</td>
            <td>4–20 mA Current Loop; default: <b>4–20 mA Current Loop</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:darkred">4–20 mA Current Loop:</span> Voltage</td>
            <td>positive float [0..40]; default: <b>none</b></td>
            <td>At which voltage value will this rule be triggered.</td>
        </tr>
        <tr>
            <td><span style="color:chocolate">ADC:</span> Input/Output name</td>
            <td>ADC; default: <b>ADC</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:chocolate">ADC:</span> Voltage</td>
            <td>positive float [0..40]; default: <b>none</b></td>
            <td>At which voltage value will this rule be triggered.</td>
        </tr>
     |
     |
    <tr>
        <tr>
        <td>Trigger</td>
            <td>Input/Output type</td>
         <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
            <td>Input/Output; default: <b>Input/Output</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>State change</td>
            <td>Input/Output name</td>
        <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
            <td>Input(3) {{!}} Output(4); default: <b>Input(3)</b></td>
        <td>On which Input/Output state will this rule be triggered.</td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
    </tr>}}
        </tr>
        <tr>
            <td>State change</td>
            <td>High level {{!}} Low level {{!}} Both; default: <b>High level</b></td>
            <td>On which Input/Output state will this rule be triggered.</td>
        </tr>}}
|RUT36X =
|RUT36X =
    <tr>
        <tr>
        <td>Trigger</td>
            <td>Input/Output type</td>
         <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
            <td>Input/Output; default: <b>Input/Output</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>State change</td>
            <td>Input/Output name</td>
        <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
            <td>Input(3) {{!}} Output(4); default: <b>Input(3)</b></td>
        <td>On which Input/Output state will this rule be triggered.</td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
    </tr>
        </tr>
        <tr>
            <td>State change</td>
            <td>High level {{!}} Low level {{!}} Both; default: <b>High level</b></td>
            <td>On which Input/Output state will this rule be triggered.</td>
        </tr>
|RUT9 =
|RUT9 =
     {{#ifeq:{{{name}}}|RUT955|
     {{#ifeq:{{{name}}}|RUT955|
    <tr>
        <tr>
        <td>Trigger</td>
            <td>Input/Output type</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><span style="color:blue">Input/Output</span> {{!}} <span style="color:forestgreen"><b>Relay</b></span> {{!}} <span style="color:darkred"><b>4–20 mA Current Loop</b></span> {{!}} <span style="color:chocolate">ADC</span>; default: <b>Input/Output</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>
            <td><span style="color:blue">Input/Output:</span> Input/Output name</td>
            <td>Input (3) {{!}} Input (1) {{!}} Output(4) {{!}} Isolated Output (3,4,8) {{!}} Isolate Input (2,7); default: <b>Input (3)</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:blue">Input/Output:</span> State change</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>
        <tr>
            <td><span style="color:forestgreen">Relay:</span> Input/Output name</td>
            <td>Relay(5,10); default: <b>Relay(5,10)</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:forestgreen">Relay:</span> State change</td>
            <td>Open {{!}} Closed {{!}} Both; default: <b>Open</b></td>
            <td>On which Input/Output state will this rule be triggered.</td>
        </tr>
        <tr>
            <td><span style="color:darkred">4–20 mA Current Loop:</span> Input/Output name</td>
            <td>Analog Current Loop (6,9); default: <b>Analog Current Loop (6,9)</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:darkred">4–20 mA Current Loop:</span> Voltage</td>
            <td>positive float [0..40]; default: <b>none</b></td>
            <td>At which voltage value will this rule be triggered.</td>
        </tr>
        <tr>
            <td><span style="color:chocolate">ADC:</span> Input/Output name</td>
            <td>Analog Input (6,9); default: <b>Analog Input (6,9)</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
        <tr>
            <td><span style="color:chocolate">ADC:</span> Voltage</td>
            <td>positive float [0..40]; default: <b>none</b></td>
            <td>At which voltage value will this rule be triggered.</td>
        </tr>
    |
        <tr>
            <td>Input/Output type</td>
            <td>Input/Output; default: <b>Input/Output</b></td>
            <td>Which type of Inputs and Outputs to use in this rule.</td>
        </tr>
         <tr>
            <td>Input/Output name</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>
            <td>State change</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>}}}}
</table>|}}
 
====Events log====
----
<table class="nd-mantable">
    <tr>
        <th>Event</th>
        <th>Event subtype</th>
        <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>State change</td>
         <td><b>Config change</b></td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>All | Specific config change; default: <b>all</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on changes to the device's configuration.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (6,9), Analog Input (6,9):</span> State change</td>
         <td><b>Reboot</b></td>
         <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td>
         <td>All | From Web UI | From ping reboot | From reboot scheduler | From button{{#ifeq: {{{mobile}}} | 1 | {{!}} From SMS|}}; default: <b>All</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on if the device was rebooted.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:blue">Relay (5,10):</span> State change</td>
         <td><b>Startup</b></td>
         <td>Open {{!}} Closed {{!}} Both; default: <b>Both</b></td>
         <td>Device startup completed</td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on when the device is fully booted.</td>
     </tr>
     </tr>{{#ifeq: {{{gps}}} | 1 |
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Min voltage</td>
         <td><b>GPS</b></td>
         <td>positive float; default: <b>none</b></td>
         <td>All {{!}} Entered geofence {{!}} Left geofence; default: <b>All</b></td>
         <td>At which minimum voltage value will this rule be triggered.</td>
         <td>Informs on when the device has entered or left a user defined geofence zone.</td>
     </tr>
     </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Max voltage</td>
         <td><b>Mobile data</b></td>
         <td>positive float; default: <b>none</b></td>
         <td>All {{!}} Connected {{!}} Disconnected; default <b>All</b></td>
         <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td>
         <td>Informs on changes to the state of the device's mobile connection.</td>
     </tr>
     </tr>|}}
  |
     <tr>
     <tr>
         <td>Trigger</td>
         <td><b>New DHCP client</b></td>
         <td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
         <td>All | Connected from LAN{{#ifeq: {{{wireless}}} | 1 | {{!}} Connected from WiFi|}}; default <b>All</b></td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
         <td>Informs on new DHCP lease give outs.</td>
     </tr>
     </tr>{{#ifeq: {{{eth}}} | 1 |
     <tr>
     <tr>
         <td>State change</td>
         <td><b>Ports state</b></td>
        <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>All {{!}} Link speed {{!}} Link state {{!}} Unplugged {{!}} Plugged in {{!}} Specific port; default: <b>All</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes.</td>
    </tr>
     </tr>|}}
    |}}
|RUT9M =
    {{#ifeq:{{{name}}}|RUT956|
    <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>State change</td>
         <td><b>Reboot</b></td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>All | From button | From Input/Output | From Ping Reboot | From Reboot Scheduler | From WebUI | From SMS; default: <b>All</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs after device reboot occurrences.</td>
     </tr>
     </tr>{{#ifeq: {{{mobile}}} | 1 |
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (6,9), Analog Input (6,9):</span> State change</td>
         <td><b>Signal strength</b></td>
         <td>In range {{!}} Out of range {{!}} Both; default: <b>Both</b></td>
         <td>All {{!}} - 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: <b>All</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on signal strength changes.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color:blue">Relay (5,10):</span> State change</td>
         <td><b>SMS</b></td>
         <td>Open {{!}} Closed {{!}} Both; default: <b>Both</b></td>
         <td>SMS received</td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on received SMS messages.</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Min voltage</td>
         <td><b>SSH</b></td>
         <td>positive float; default: <b>none</b></td>
         <td>All | Successful authentication | Unsuccessful authentication; default: <b>All</b></td>
         <td>At which minimum voltage value will this rule be triggered.</td>
         <td>Informs on successful or unsuccessful SSH login attempts.</td>
     </tr>
     </tr>{{#ifeq: {{{eth}}} | 1 |
     <tr>
     <tr>
         <td><span style="color:red">Analog Current Loop (7), Analog Input (7):</span> Max voltage</td>
         <td><b>Topology state</b></td>
         <td>positive float; default: <b>none</b></td>
         <td>Topology changes</td>
         <td>At which maximum voltage value will this rule be triggered. Must be higher than Min voltage.</td>
         <td>Informs on changes to the device's network topology.</td>
     </tr>
     </tr>|}}{{#ifeq: {{{failover}}} | 1 |
|
     <tr>
     <tr>
         <td>Trigger</td>
         <td><b>WAN failover</b></td>
         <td>Input (3) {{!}} Output (4); default: <b>Input (3)</b></td>
         <td>All {{!}} Switched to failover {{!}} Switched to main; default: <b>All</b></td>
         <td>Which type of Inputs and Outputs to use in this rule.</td>
         <td>Informs on WAN failover occurrences.</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
         <td>State change</td>
         <td><b>WebUI</b></td>
        <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>ALL | Successful authentication | Unsuccessful authentication; default: <b>All</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on successful or unsuccessful HTTP/HTTPS login attempts.</td>
    </tr>
     </tr>{{#ifeq:{{{wireless}}} | 1 |
    |}}
|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>State change</td>
         <td><b>New WiFi client</b></td>
         <td>High level {{!}} Low level {{!}} Both; default: <b>Both</b></td>
         <td>All {{!}} Connected {{!}} Disconnected; default: <b>All</b></td>
         <td>On which Input/Output state will this rule be triggered.</td>
         <td>Informs on new WiFi clients. Possible triggers are:</td>
     </tr>
     </tr>|}}
}}
</table>
</table>
<br>
 
}}


==SNMP variables list==
==SNMP variables list==
Line 583: Line 688:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>routerName.0</td>
         <td>deviceName.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 606: Line 711:
         <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>
    <tr>
        <td>deviceUptime</td>
        <td>.1.3.6.1.4.1.48690.1.7.0</td>
        <td>Device uptime</td>
    </tr>
    <tr>
        <td>cpuUsage</td>
        <td>.1.3.6.1.4.1.48690.1.8.0</td>
        <td>CPU usage</td>
     </tr>{{#ifeq: {{{mobile}}} | 1 |
     </tr>{{#ifeq: {{{mobile}}} | 1 |
     <tr>
     <tr>
Line 616: Line 731:
         <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>
        <td>modemTable</td>
        <td>.1.3.6.1.4.1.48690.2.2.0</td>
        <td>A list of modem entries. The number of entries is given by the value of modemNum.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 721: Line 841:
         <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>
      <tr>
        <td>mSentCurrentWeek</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.28.1</td>
        <td>Bytes sent this week</td>
    </tr>
      <tr>
        <td>mReceivedCurrentWeek</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.29.1</td>
        <td>Bytes received this week</td>
    </tr>
      <tr>
        <td>mSentCurrentMonth</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.30.1</td>
        <td>Bytes sent this month</td>
    </tr>
      <tr>
        <td>mReceivedCurrentMonth</td>
        <td>.1.3.6.1.4.1.48690.2.2.1.31.1</td>
        <td>Bytes received this month</td>
    </tr>
    <tr>
        <td>connectionUptime</td>
        <td>.1.3.6.1.4.1.48690.2.3.0</td>
        <td>Mobile connection uptime in seconds.</td>
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
     <tr>
     <tr>
Line 752: Line 927:
         <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: {{{notifications}}} | 1 |
    <tr>
        <th>Mobile notifications</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>signalChangeNotification</td>
        <td>.1.3.6.1.4.1.48690.4.1.1</td>
        <td>Signal strength trap</td>
    </tr>
    <tr>
        <td>networkTypeNotification</td>
        <td>.1.3.6.1.4.1.48690.4.1.2</td>
        <td>Network type trap</td>
    </tr>|}}{{#switch:{{{name}}} | TCR100 | RUTXR1 | OTD140 | TAP100 | TAP200 = | #default =
    <tr>
        <th>Input/Output notifications</th>
        <th></th>
        <th></th>
    </tr>}}{{#switch:{{{name}}} |RUTX08|RUTX09|RUTX10|RUTX11|RUTX12|RUTX14|RUT950|RUT951|RUT952|RUT260|RUT955|RUT956|RUT240|RUT241|RUTX50|RUT901|RUT906|RUTM08|RUTM09|RUTM10|RUTM11|RUTM12|RUTM14 =
    <tr>
        <td>digitalInputNotification</td>
        <td>.1.3.6.1.4.1.48690.4.2.1</td>
        <td>Digital input trap</td>
    </tr>
    <tr>
        <td>digitalOutputNotification</td>
        <td>.1.3.6.1.4.1.48690.4.2.2</td>
        <td>Digital output trap</td>
    </tr>| #default =}}{{#switch:{{{name}}} |RUT360|RUT361|RUT300|RUT301|TRB140|TRB141|TRB143|TRB500|TRB245|TRB246|TRB255|TRB256|TRB160 =
    <tr>
        <td>digitalio0Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.3</td>
        <td>Digital I/O 0 trap</td>
    </tr>
    <tr>
        <td>digitalio1Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.4</td>
        <td>Digital I/O 1 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}} |TRB245|TRB246|TRB255|TRB256 =
    <tr>
        <td>digitalio2Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.5</td>
        <td>Digital I/O 2 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}} |TRB141 =
    <tr>
        <td>drywetio0Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.6</td>
        <td>Dry/Wet I/O 0 trap</td>
    </tr>
    <tr>
        <td>drywetio1Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.7</td>
        <td>Dry/Wet I/O 1 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}} |RUT955|RUT956|RUT906|TRB141 =
    <tr>
        <td>relay0Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.8</td>
        <td>Relay 0 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |TRB141 =
    <tr>
        <td>relay1Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.9</td>
        <td>Relay 1 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906|TRB141 =
    <tr>
        <td>acl0Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.10</td>
        <td>ACL trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906|TRB245|TRB246|TRB255|TRB141|TRB256 =
    <tr>
        <td>adc0Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.11</td>
        <td>ADC trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906 =
    <tr>
        <td>digitalInput2Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.12</td>
        <td>Digital input2 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906|TRB141 =
    <tr>
        <td>digitalIioNotification</td>
        <td>.1.3.6.1.4.1.48690.4.2.13</td>
        <td>Isolated Input trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |RUT955|RUT956|RUT906 =
    <tr>
        <td>digitalOutput2Notification</td>
        <td>.1.3.6.1.4.1.48690.4.2.14</td>
        <td>Digital output2 trap</td>
    </tr>| #default =}}{{#switch:{{{name}}}  |TRB160 =
    <tr>
        <td>powerVoltageNotification</td>
        <td>.1.3.6.1.4.1.48690.4.2.15</td>
        <td>Power voltage trap</td>
    </tr>| #default =}}{{#ifeq: {{{hotspot}}} | 1 |
    <tr>
        <th>Hotspot Notifications</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>clientConnectedNotification</td>
        <td>.1.3.6.1.4.1.48690.4.3.1</td>
        <td>Hotspot client connected trap</td>
    </tr>
    <tr>
        <td>clientDisconnectedNotification</td>
        <td>.1.3.6.1.4.1.48690.4.3.2</td>
        <td>Hotspot client disconnected trap</td>
     </tr>|}}{{#ifeq: {{{hotspot}}} | 1 |
     </tr>|}}{{#ifeq: {{{hotspot}}} | 1 |
     <tr>
     <tr>
Line 852: Line 1,137:
         <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>
    <tr>
        <td> ioStateNumeric</td>
        <td>.1.3.6.1.4.1.48690.6.2.1.11</td>
        <td>Numeric state of I/O</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>
        <th>Port</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>portCount</td>
        <td>.1.3.6.1.4.1.48690.10.1.0</td>
        <td>Number of ports on device</td>
    </tr>
    <tr>
        <td>portTable</td>
        <td>.1.3.6.1.4.1.48690.10.2.0</td>
        <td>A list of port entries. The number of entries is given by the value of portCount</td>
    </tr>
    <tr>
        <td>portEntry</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.0</td>
        <td>An entry containing information of a particular port</td>
    </tr>
    <tr>
        <td>pIndex</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.1</td>
        <td>A unique value, greater than zero, for each port</td>
    </tr>
    <tr>
        <td>pName</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.2</td>
        <td>Port's name</td>
    </tr>
    <tr>
        <td>pNumber</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.3</td>
        <td>Port's number</td>
    </tr>
    <tr>
        <td>pPosition</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.4</td>
        <td>Port's physical position</td>
    </tr>
    <tr>
        <td>pState</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.5</td>
        <td>Port's state</td>
    </tr>
    <tr>
        <td>pSpeed</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.6</td>
        <td>Port's speed</td>
    </tr>
    <tr>
        <td>pDuplex</td>
        <td>.1.3.6.1.4.1.48690.10.2.1.7</td>
        <td>Boolean value whether port is duplex or not</td>
    </tr>|}}{{#ifeq: {{{mwan3}}} | 1 |
    <tr>
        <th>MultiWAN</th>
        <th></th>
        <th></th>
    </tr>
    <tr>
        <td>mwan3Count</td>
        <td>.1.3.6.1.4.1.48690.12.1</td>
        <td>Count of Multiwan interfaces</td>
    </tr>
    <tr>
        <td>mwan3Table</td>
        <td>.1.3.6.1.4.1.48690.12.2</td>
        <td>A list of Multiwan interfaces. The number of entries is given by the value of mwan3Count</td>
    </tr>
    <tr>
        <td>mwan3Entry</td>
        <td>.1.3.6.1.4.1.48690.12.2.1</td>
        <td>An entry containing information of a particular Multiwan interface</td>
    </tr>
    <tr>
        <td>mwan3Index</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.1</td>
        <td>Unique value, greater than zero, for each session</td>
    </tr>
    <tr>
        <td>mwan3Name</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.2</td>
        <td>Name of Multiwan interface</td>
    </tr>
    <tr>
        <td>mwan3Enabled</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.3</td>
        <td>Numeric value indicating if interface is enabled or not</td>
    </tr>
    <tr>
        <td>mwan3Uptime</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.4</td>
        <td>Multiwan interface uptime</td>
    </tr>
    <tr>
        <td>mwan3Status</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.5</td>
        <td>Status of Multiwan interface</td>
    </tr>
    <tr>
        <td>mwan3Ip</td>
        <td>.1.3.6.1.4.1.48690.12.2.1.6</td>
        <td>IP addresses that Multiwan interface tracks</td>
     </tr>|}}
     </tr>|}}
</table>
</table>


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

Latest revision as of 12:16, 4 September 2024

The information in this page is updated in accordance with firmware version .


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




Events log

Event Event subtype Description
Config change All | Specific config change; default: all Informs on changes to the device's configuration.
Reboot All | From Web UI | From ping reboot | From reboot scheduler | From button; default: All Informs on if the device was rebooted.
Startup Device startup completed Informs on when the device is fully booted.
New DHCP client All | Connected from LAN; default All Informs on new DHCP lease give outs.
Reboot All | From button | From Input/Output | From Ping Reboot | From Reboot Scheduler | From WebUI | From SMS; default: All Informs after device reboot occurrences.
SSH All | Successful authentication | Unsuccessful authentication; default: All Informs on successful or unsuccessful SSH login attempts.
WebUI ALL | Successful authentication | Unsuccessful authentication; default: All Informs on successful or unsuccessful HTTP/HTTPS login attempts.


SNMP variables list

Name OID Description
Device
serial .1.3.6.1.4.1.48690.1.1.0 Device serial number
deviceName.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
deviceUptime .1.3.6.1.4.1.48690.1.7.0 Device uptime
cpuUsage .1.3.6.1.4.1.48690.1.8.0 CPU usage
Input/Output notifications

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

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