Difference between revisions of "Template:Networking rutos manual events reporting"

From Teltonika Networks Wiki
(21 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1), {{eth}} (1), {{simswitch}} -->
+
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1) -->
{{Template: Networking_device_manual_fw_disclosure
+
{{Template:Networking_rutos_manual_fw_disclosure
| series = {{{series}}}
+
| fw_version = {{{series}}}_R_00.02.05.1
| name  = {{{name}}}
+
| series     = {{{series}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
 
| series = {{{series}}}
 
| name  = {{{name}}}
 
}}
 
 
}}
 
}}
{{#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_device_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_device_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 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 of 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 18: Line 13:
 
==Events Reporting Rules==
 
==Events Reporting Rules==
  
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.
+
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.
  
 
All possible trigger events are listed in the table below.  
 
All possible trigger events are listed in the table below.  
Line 25: Line 20:
 
     <tr>
 
     <tr>
 
         <th width=35%>Event</th>
 
         <th width=35%>Event</th>
         <th width=65%>Event subtype</th>
+
         <th width=65%>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 47: Line 42:
 
     </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
 
     </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
         <td><b>Mobile data</b></td>
+
         <td><b>Mobile</b></td>
 
         <td>Informs on changes to the state of the device's mobile connection. Possible triggers are:
 
         <td>Informs on changes to the state of the device's mobile connection. Possible triggers are:
 
             <ul>
 
             <ul>
Line 62: Line 57:
 
                 <li><i>Connected from LAN</i></li>{{#ifeq: {{{wifi}}} | 1 |
 
                 <li><i>Connected from LAN</i></li>{{#ifeq: {{{wifi}}} | 1 |
 
                 <li><i>Connected from WiFi</i></li>|}}
 
                 <li><i>Connected from WiFi</i></li>|}}
 +
                <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 71: Line 67:
 
                 <li><i>Link speed</i></li>
 
                 <li><i>Link speed</i></li>
 
                 <li><i>Link state</i></li>
 
                 <li><i>Link state</i></li>
                 <li><i>Unplugged</i></li>
+
                 <li><i>All</i></li>
                <li><i>Plugged in</i></li>{{#switch: {{{series}}} | RUTX | RUTM | RUT30X | #default =
 
                <li><i>LAN1</i></li>
 
                <li><i>LAN2</i></li>
 
                <li><i>LAN3</i></li>
 
                <li><i>LAN4</i></li>
 
                <li><i>WAN</i></li>| RUT2 | RUT2M | RUT36X | TCR1 | TRB1 | TRB2 | TRB5 =
 
                <li><i>LAN1</i></li>
 
                <li><i>WAN</i></li>| RUT9 | RUT9M =
 
                <li><i>LAN1</i></li>
 
                <li><i>LAN2</i></li>
 
                <li><i>LAN3</i></li>
 
                <li><i>WAN</i></li>}}
 
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 94: Line 78:
 
                 <li><i>From Input/Output</i></li>
 
                 <li><i>From Input/Output</i></li>
 
                 <li><i>From Ping Reboot</i></li>
 
                 <li><i>From Ping Reboot</i></li>
                <li><i>From wget Reboot</i></li>
 
 
                 <li><i>From Reboot Scheduler</i></li>
 
                 <li><i>From Reboot Scheduler</i></li>
 
                 <li><i>From WebUI</i></li>
 
                 <li><i>From WebUI</i></li>
                <li><i>From SMS</i></li>
 
 
                 <li><i>All</i></li>
 
                 <li><i>All</i></li>
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
    </tr>
+
     </tr>{{#ifeq: {{{wifi}}} | 1 |
    <tr>
 
        <td><b>Startup</b></td>
 
        <td>Informs when device startup completed. Possible triggers are:
 
            <ul>
 
                <li><i>Device startup completed</i></li>
 
            </ul>
 
        </td>
 
     </tr>{{#ifeq: {{{mobile}}} | 1 |
 
 
     <tr>
 
     <tr>
 
         <td><b>Signal strength</b></td>
 
         <td><b>Signal strength</b></td>
Line 123: Line 97:
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
     </tr>
+
     </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
 
         <td><b>SMS</b></td>
 
         <td><b>SMS</b></td>
Line 131: Line 105:
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
     </tr>{{#ifeq: {{{simswitch}}} | 1 |
+
     </tr>|}}
    <tr>
 
        <td><b>Sim switch</b></td>
 
        <td>Informs on sim switch changes. Possible triggers are:
 
            <ul>
 
                <li><i>Changing to SIM1</i></li>
 
                <li><i>Changing to SIM2</i></li>
 
                <li><i>All</i></li>
 
            </ul>
 
        </td>
 
    </tr>|}}|}}
 
 
     <tr>
 
     <tr>
 
         <td><b>SSH</b></td>
 
         <td><b>SSH</b></td>
Line 179: Line 143:
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
     </tr>{{#ifeq:{{{wifi}}} | 1 |
+
     </tr>
    <tr>
 
        <td><b>New WiFi client</b></td>
 
        <td>Informs on new WiFi clients. Possible triggers are:
 
            <ul>
 
                <li><i>Connected</i></li>
 
                <li><i>Disconnected</i></li>
 
                <li><i>All</i></li>
 
            </ul>
 
        </td>
 
    </tr>|}}
 
 
</table>
 
</table>
  
Line 201: Line 155:
 
{{#ifeq: {{{mobile}}} | 1 | ===Send SMS===
 
{{#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, 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.
+
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 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_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_sms.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 213: Line 167:
 
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
       <td>off {{!}} on; default: <b>off</b></td>
+
       <td>off {{!}} on; default: <b>on</b></td>
 
       <td>Turns the rule on or off.</td>
 
       <td>Turns the rule on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Event type</td>
+
         <td>Event</td>
         <td>Config change {{!}} New DHCP client {{!}} Startup {{!}} Mobile data {{!}} SMS {{!}} Signal Strength {{!}} Reboot {{!}} SSH {{!}} WebUI {{#ifeq:{{{simswitch}}}|1|{{!}} Sim witch|}}{{#ifeq:{{{wifi}}}|1|{{!}} New WiFi client|}}{{#ifeq:{{{eth}}}|1|{{!}} Ports state {{!}} Topology changes |}}{{#ifeq:{{{failover}}}|1|{{!}} 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>Event that will trigger the rule.</td>
+
         <td>The event that you wish to receive notifications on.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Event subtype</td>
+
         <td>Event type</td>
 
         <td>Varies</td>
 
         <td>Varies</td>
         <td>More specific event type that will trigger the rule.</td>
+
         <td>Specific event sub-type that will trigger the rule. The value of this field changes in accordance with the selection of the 'Event' field.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>Send SMS {{!}} Send email; default: <b>Send Email</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 the report message.</td>
+
         <td>Text to be included in the body of report message.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Recipients</td>
 
         <td>Recipients</td>
         <td>Single {{!}} Group; default: <b>Single</b></td>
+
         <td>Single number {{!}} Group; default: <b>Single number</b></td>
 
         <td>Specifies whether the recipient should be a single number or a group of numbers.</td>
 
         <td>Specifies whether the recipient should be a single number or a group of numbers.</td>
 
     </tr>
 
     </tr>
Line 264: Line 208:
 
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.
 
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_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_emai.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 278: Line 222:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Event type</td>
+
         <td>Event</td>
         <td>Config change {{!}} Startup {{!}} New DHCP client {{#ifeq:{{{mobile}}}|1|{{!}} Mobile data {{!}} SMS {{!}} Signal Strength {{!}}|{{!}}}} Reboot {{!}} SSH {{!}} WebUI {{#ifeq:{{{eth}}}|1|{{!}} Ports state {{!}} Topology changes |}}{{#ifeq:{{{failover}}}|1|{{!}} WAN Failover |}}{{#ifeq:{{{gps}}}|1|{{!}} GPS|}}{{#ifeq:{{{wifi}}}|1|{{!}} New WiFi client|}}{{#ifeq:{{{simswitch}}}|1|{{!}} Sim switch|}}; 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>Event that will trigger the rule.</td>
+
         <td>The event that you wish to receive notifications on.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Event subtype</td>
+
         <td>Event type</td>
 
         <td>Varies</td>
 
         <td>Varies</td>
         <td>More specific event type that will trigger the rule.</td>
+
         <td>Specific event sub-type that will trigger the rule. The value of this field changes in accordance with the selection of the 'Event' field.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>{{#ifeq:{{{mobile}}}|1|Send SMS {{!}} |}}Send email; default: <b>Send email</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>{{#ifeq:{{{dualmodem}}}|1|
+
     </tr>
    <tr>
 
        <td>Modem</td>
 
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary Modem</b></td>
 
        <td>Specifies which modem to get information from.</td>
 
    </tr>|}}
 
 
     <tr>
 
     <tr>
 
         <td>Subject</td>
 
         <td>Subject</td>
Line 305: Line 244:
 
         <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 the report email.</td>
+
         <td>Text to be included in the body of report email.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>

Revision as of 10:12, 12 October 2020

Template:Networking rutos manual fw disclosure

Summary

The Events Reporting feature provides the possibility to configure rules that inform of via SMS oremail when certain trigger events occur.

This page is an overview of the Events Reporting section for {{{name}}} devices.

Events Reporting Rules

The Events Reporting Rules 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 SMS message oremail to a specified number informing of the occurred event.

All possible trigger events are listed in the table below.

Event Description
Config change Informs on changes to the device's configuration. Possible triggers are:
  • Any config change
  • Specific config change
New DHCP client Informs on new DHCP lease give outs. Possible triggers are:
  • Connected from LAN
  • All
Reboot Informs after device reboot occurrences. Possible triggers are:
  • From button
  • From Input/Output
  • From Ping Reboot
  • From Reboot Scheduler
  • From WebUI
  • All
SSH Informs on successful or unsuccessful SSH login attempts. Possible triggers are:
  • Successful authentication
  • Unsuccessful authentication
  • All
WebUI Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible triggers are:
  • Successful authentication
  • Unsuccessful authentication
  • All

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:

Networking rutos manual events reporting events reporting rules add button.png

After adding a rule you should be redirected to its configuration page.

Send email


When an Events Reporting rule is configured to send emails, 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 System → Administration → [[{{{name}}} Administration#Recipients|Recipients]] 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 emai.png

Field Value Description
Enable off | on; default: on Turns the rule on or off.
Event Config change | New DHCP client | Reboot | SSH | WebUI ; default: Config change The event that you wish to receive notifications on.
Event type Varies Specific event sub-type that will trigger the rule. The value of this field changes in accordance with the selection of the 'Event' field.
Action Send email; default: Send email Selects the method of reporting on the specified event.
Subject string; default: none Subject of the sent email.
Message text on Event string; default: Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts; Text to be included in the body of report email.
Email account email account; default: none The account that will be used to send an email.
Recipient's email address email address; default: none Email address of the recipient.
Send test email - (interactive button) Sends an email based on the current configuration. This is used to test whether the configuration works as intended.

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