Changes

no edit summary
Line 1: Line 1:  
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1) -->
 
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1) -->
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05.1
+
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series     = {{{series}}}
+
| series = {{{series}}}
 +
}}
 
}}
 
}}
 
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Events Log (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}}} Events Log (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==
   −
The <b>Events Reporting</b> feature provides the possibility to configure rules that inform of via {{#ifeq:{{{mobile}}}|0||SMS or }}email when certain trigger events occur.
+
The <b>Events Reporting</b> feature provides the possibility to configure rules that inform via {{#ifeq:{{{mobile}}}|0||SMS or }} email when certain trigger events occur.
    
This page is an overview of the Events Reporting section for {{{name}}} devices.
 
This page is an overview of the Events Reporting section for {{{name}}} devices.
Line 13: Line 15:  
==Events Reporting Rules==
 
==Events Reporting Rules==
   −
The <b>Events Reporting Rules</b> window section is used to manage existing Events Reporting rules and to add new ones. Events Reporting Rules trigger on certain, user specified events and send an {{#ifeq:{{{mobile}}}|0||SMS message or }}email to a specified number informing of the occurred event.
+
The <b>Events Reporting Rules</b> section is used to manage existing Events Reporting rules and to add new ones. Events Reporting Rules trigger on certain, user specified events and send an {{#ifeq:{{{mobile}}}|0||SMS message or}} email to a specified number informing of the occurred event.
    
All possible trigger events are listed in the table below.  
 
All possible trigger events are listed in the table below.  
Line 24: Line 26:  
     <tr>
 
     <tr>
 
         <td><b>Config change</b></td>
 
         <td><b>Config change</b></td>
         <td>Informs on changes to the device's configuration. Possible trigger are:
+
         <td>Informs on changes to the device's configuration. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>Any config change</li>
+
                 <li><i>Any config change</i></li>
                 <li>Specific config change</li>
+
                 <li><i>Specific config change</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 33: Line 35:  
     <tr>
 
     <tr>
 
         <td><b>GPS</b></td>
 
         <td><b>GPS</b></td>
         <td>Informs on when the device has entered or left a user defined geofence zone. Possible trigger are:
+
         <td>Informs on when the device has entered or left a user defined geofence zone. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>Entered geofence</i></li>
                 <li>Left geofence</li>
+
                 <li><i>Left geofence</i></li>
                 <li>Entered geofence</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
 
     </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
 
     </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
         <td><b>Mobile</b></td>
+
         <td><b>Mobile data</b></td>
         <td>Informs on changes to the state of the device's mobile connection. Possible trigger are:
+
         <td>Informs on changes to the state of the device's mobile connection. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>Connected</i></li>
                 <li>Connected</li>
+
                 <li><i>Disconnected</i></li>
                 <li>Disconnected</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 53: Line 55:  
     <tr>
 
     <tr>
 
         <td><b>New DHCP client</b></td>
 
         <td><b>New DHCP client</b></td>
         <td>Informs on new DHCP lease give outs. Possible values are:
+
         <td>Informs on new DHCP lease give outs. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>{{#ifeq: {{{wifi}}} | 1 |
+
                 <li><i>Connected from LAN</i></li>{{#ifeq: {{{wifi}}} | 1 |
                 <li>Connected from WiFi</li>|}}
+
                 <li><i>Connected from WiFi</i></li>|}}
                 <li>Connected from LAN</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 63: Line 65:  
     <tr>
 
     <tr>
 
         <td><b>Ports state</b></td>
 
         <td><b>Ports state</b></td>
         <td>Informs on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes. Possible values are:
+
         <td>Informs on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>Link speed</i></li>
                 <li>Link state</li>
+
                 <li><i>Link state</i></li>
                 <li>Link speed</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 73: Line 75:  
     <tr>
 
     <tr>
 
         <td><b>Reboot</b></td>
 
         <td><b>Reboot</b></td>
         <td>Informs after device reboot occurrences. Possible values are:
+
         <td>Informs after device reboot occurrences. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>From button</i></li>
                 <li>From WebUI</li>
+
                 <li><i>From Input/Output</i></li>
                 <li>From Input/Output</li>
+
                 <li><i>From Ping Reboot</i></li>
                 <li>From Ping Reboot</li>
+
                 <li><i>From Reboot Scheduler</i></li>
                 <li>From Reboot Scheduler</li>
+
                 <li><i>From WebUI</i></li>
                 <li>From button</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 86: Line 88:  
     <tr>
 
     <tr>
 
         <td><b>Signal strength</b></td>
 
         <td><b>Signal strength</b></td>
         <td>Informs on signal strength changes. Possible values are:
+
         <td>Informs on signal strength changes. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>- 121 dBm - 113 dBm</i></li>
                <li>- 121 dBm - 113 dBm</li>
+
                 <li><i>- 113 dBm - 98 dBm</i></li>
                 <li>- 113 dBm - 98 dBm</li>
+
                 <li><i>- 98 dBm - 93 dBm</i></li>
                 <li>- 98 dBm - 93 dBm</li>
+
                 <li><i>- 93 dBm - 75 dBm</i></li>
                 <li>- 93 dBm - 75 dBm</li>
+
                 <li><i>- 75 dBm - 60 dBm</i></li>
                 <li>- 75 dBm - 60 dBm</li>
+
                 <li><i>- 60 dBm - 50 dBm</i></li>
                 <li>- 60 dBm - 50 dBm</li>
+
                <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 100: Line 102:  
     <tr>
 
     <tr>
 
         <td><b>SMS</b></td>
 
         <td><b>SMS</b></td>
         <td>Informs on received SMS messages. Possible values are:
+
         <td>Informs on received SMS messages. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>SMS received</li>
+
                 <li><i>SMS received</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 108: Line 110:  
     <tr>
 
     <tr>
 
         <td><b>SSH</b></td>
 
         <td><b>SSH</b></td>
         <td>Informs on successful or unsuccessful SSH login attempts. Possible values are:
+
         <td>Informs on successful or unsuccessful SSH login attempts. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>Successful authentication</i></li>
                 <li>Successful authentication</li>
+
                 <li><i>Unsuccessful authentication</i></li>
                 <li>Unsuccessful authentication</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 118: Line 120:  
     <tr>
 
     <tr>
 
         <td><b>Topology state</b></td>
 
         <td><b>Topology state</b></td>
         <td>
+
         <td>Informs on changes to the device's network topology. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>Topology changes</li>
+
                 <li><i>Topology changes</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 126: Line 128:  
     <tr>
 
     <tr>
 
         <td><b>WAN failover</b></td>
 
         <td><b>WAN failover</b></td>
         <td>Informs on WAN failover occurrences. Possible values are:
+
         <td>Informs on WAN failover occurrences. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>Switched to failover</i></li>
                 <li>Switched to main</li>
+
                 <li><i>Switched to main</i></li>
                 <li>Switched to failover</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 136: Line 138:  
     <tr>
 
     <tr>
 
         <td><b>WebUI</b></td>
 
         <td><b>WebUI</b></td>
         <td>Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible values are:
+
         <td>Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible triggers are:
 
             <ul>
 
             <ul>
                 <li>All</li>
+
                 <li><i>Successful authentication</i></li>
                 <li>Successful authentication</li>
+
                 <li><i>Unsuccessful authentication</i></li>
                 <li>Unsuccessful authentication</li>
+
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 146: Line 148:  
</table>
 
</table>
    +
==Events Reporting Configuration==
   −
[[File:Networking_rutx_manual_events_reporting_rules_v3.png|border|class=tlt-border]]
  −
  −
  −
==Events Reporting Configuration==
  −
----
   
The Events Reporting Rules list is empty by default. Before you can begin configuration you must add at least one new rule. This can be done by clicking the 'Add' button:
 
The Events Reporting Rules list is empty by default. Before you can begin configuration you must add at least one new rule. This can be done by clicking the 'Add' button:
   Line 157: Line 155:     
After adding a rule you should be redirected to its configuration page.
 
After adding a rule you should be redirected to its configuration page.
{{#ifeq: {{{mobile}}} | 1 | <h3>Send SMS</h3>
+
{{#ifeq: {{{mobile}}} | 1 | ===Send SMS===
 
----
 
----
One of the two Events Reporting types is <b>via SMS messages</b>. When an Events Reporting rule is configured to send SMS, it will send out an SMS message from the currently active SIM card to the phone number specified in a rule's configuration.
+
One of the two Events Reporting types is <b>via SMS messages</b>. When an Events Reporting rule is configured to send SMS, the devices will send out an SMS message from the {{#ifeq:{{{dualmodem}}}|1| selected <b>Gateway modem</b>| currently active SIM card}} to the phone number specified in a rule's configuration.
   −
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_sms.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_sms_dual_modem_{{{dualmodem}}}.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 171: Line 169:  
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
       <td>off {{!}} on; default: <b>on</b></td>
+
       <td>off {{!}} on; default: <b>off</b></td>
 
       <td>Turns the rule on or off.</td>
 
       <td>Turns the rule on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Event</td>
 
         <td>Event</td>
         <td>Config change {{!}} New DHCP client {{#ifeq:{{{mobile}}}|1|{{!}} Mobile data {{!}} SMS}} {{!}} Signal Strength {{!}}|}} Reboot {{!}} SSH {{!}} WebUI {{#ifeq:{{{eth}}}|1|{{!}} Ports state {{!}} Topology changes |}}{{#ifeq:{{{failvoer}}}|{{!}} WAN Failover |}}{{#ifeq:{{{gps}}}|1| {{!}} GPS|}}; default: <b>Config change</b></td>
+
         <td>Config change {{!}} New DHCP client {{!}} Mobile data {{!}} Send SMS {{!}} Signal Strength {{!}} Reboot {{!}} SSH {{!}} WebUI {{#ifeq:{{{eth}}}|1|{{!}} Ports state {{!}} Topology changes |}}{{#ifeq:{{{failover}}}|1|{{!}} WAN Failover |}}{{#ifeq:{{{gps}}}|1|{{!}} GPS|}}; default: <b>Config change</b></td>
 
         <td>The event that you wish to receive notifications on.</td>
 
         <td>The event that you wish to receive notifications on.</td>
 
     </tr>
 
     </tr>
Line 188: Line 186:  
         <td>Send SMS {{!}} Send email; default: <b>Send SMS</b></td>
 
         <td>Send SMS {{!}} Send email; default: <b>Send SMS</b></td>
 
         <td>Selects the method of reporting on the specified event.</td>
 
         <td>Selects the method of reporting on the specified event.</td>
 +
    </tr>{{#ifeq:{{{dualmodem}}}| 1 |
 +
    <tr>
 +
        <td>Modem</td>
 +
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></td>
 +
        <td>Selects the modem which is used to get information from.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
        <td>Gateway modem</td>
 +
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></td>
 +
        <td>Selects the modem which is used to send SMS.</td>
 +
    </tr>|}}
 
     <tr>
 
     <tr>
 
         <td>Message text on Event</td>
 
         <td>Message text on Event</td>
 
         <td>string; default: <b>Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;</b></td>
 
         <td>string; default: <b>Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;</b></td>
         <td>Text to be included in the body of report message.</td>
+
         <td>Text to be included in the body of the report message.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 210: Line 218:  
When an Events Reporting rule is configured to <b>send emails</b>, the device (this {{{name}}}) will connect to an existing email account when a user specified trigger event occurs and send an email to another email address informing of the occurred event.
 
When an Events Reporting rule is configured to <b>send emails</b>, the device (this {{{name}}}) will connect to an existing email account when a user specified trigger event occurs and send an email to another email address informing of the occurred event.
   −
In order to send emails, the device requires access to an existing email account. You can configure email accounts in the <b>System → Administration → [[{{{name}}} Administration#Recipients|Recipients]] page. Allowing access to less secure apps may be required for some email service providers.
+
In order to send emails, the device requires access to an existing email account. You can configure email accounts in the <b>System → Administration → [[{{{name}}} Administration#Recipients|Recipients]]</b> page. Allowing access to less secure apps may be required for some email service providers.
 +
 
 +
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_email.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 225: Line 235:  
     <tr>
 
     <tr>
 
         <td>Event</td>
 
         <td>Event</td>
         <td>Config change {{!}} New DHCP client {{!}} Mobile data {{!}} SMS}} {{!}} Signal Strength {{!}} Reboot {{!}} SSH {{!}} WebUI {{#ifeq:{{{eth}}}|1|{{!}} Ports state {{!}} Topology changes |}}{{#ifeq:{{{failover}}}|{{!}} WAN Failover |}}{{#ifeq:{{{gps}}}|1|{{!}} GPS|}}; default: <b>Config change</b></td>
+
         <td>Config change {{!}} New DHCP client {{#ifeq:{{{mobile}}}|1|{{!}} Mobile data {{!}} Send SMS {{!}} Signal Strength {{!}}|{{!}}}} Reboot {{!}} SSH {{!}} WebUI {{#ifeq:{{{eth}}}|1|{{!}} Ports state {{!}} Topology changes |}}{{#ifeq:{{{failover}}}|1|{{!}} WAN Failover |}}{{#ifeq:{{{gps}}}|1|{{!}} GPS|}}; default: <b>Config change</b></td>
 
         <td>The event that you wish to receive notifications on.</td>
 
         <td>The event that you wish to receive notifications on.</td>
 
     </tr>
 
     </tr>
Line 235: Line 245:  
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>Send SMS {{!}} Send email; default: <b>Send SMS</b></td>
+
         <td>{{#ifeq:{{{mobile}}}|1|Send SMS {{!}} |}}Send email; default: <b>{{#ifeq:{{{mobile}}}|1|Send SMS|Send email}}</b></td>
 
         <td>Selects the method of reporting on the specified event.</td>
 
         <td>Selects the method of reporting on the specified event.</td>
 
     </tr>
 
     </tr>
Line 246: Line 256:  
         <td>Message text on Event</td>
 
         <td>Message text on Event</td>
 
         <td>string; default: <b>Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;</b></td>
 
         <td>string; default: <b>Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;</b></td>
         <td>Text to be included in the body of report email.</td>
+
         <td>Text to be included in the body of the report email.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>