View source for Template:Networking rutos manual events reporting

<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1) -->
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_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_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==

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.

==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.

All possible trigger events are listed in the table below. 

<table class="nd-othertables_2" style="width: 100%;">
    <tr>
        <th width=35%>Event</th>
        <th width=65%>Description</th>
    </tr>
    <tr>
        <td><b>Config change</b></td>
        <td>Informs on changes to the device's configuration. Possible triggers are:
            <ul>
                <li><i>Any config change</i></li>
                <li><i>Specific config change</i></li>
            </ul>
        </td>
    </tr>{{#ifeq: {{{gps}}} | 1 |
    <tr>
        <td><b>GPS</b></td>
        <td>Informs on when the device has entered or left a user defined geofence zone. Possible triggers are:
            <ul>
                <li><i>Entered geofence</i></li>
                <li><i>Left geofence</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
    <tr>
        <td><b>Mobile data</b></td>
        <td>Informs on changes to the state of the device's mobile connection. Possible triggers are:
            <ul>
                <li><i>Connected</i></li>
                <li><i>Disconnected</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>|}}
    <tr>
        <td><b>New DHCP client</b></td>
        <td>Informs on new DHCP lease give outs. Possible triggers are:
            <ul>
                <li><i>Connected from LAN</i></li>{{#ifeq: {{{wifi}}} | 1 |
                <li><i>Connected from WiFi</i></li>|}}
            </ul>
        </td>
    </tr>{{#ifeq: {{{eth}}} | 1 |
    <tr>
        <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 triggers are:
            <ul>
                <li><i>Link speed</i></li>
                <li><i>Link state</i></li>
                <li><i>Unplugged</i></li>
                <li><i>Plugged in</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>|}}
    <tr>
        <td><b>Reboot</b></td>
        <td>Informs after device reboot occurrences. Possible triggers are:
            <ul>
                <li><i>From button</i></li>
                <li><i>From Input/Output</i></li>
                <li><i>From Ping Reboot</i></li>
                <li><i>From Reboot Scheduler</i></li>
                <li><i>From WebUI</i></li>
                <li><i>From SMS</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>{{#ifeq: {{{mobile}}} | 1 |
    <tr>
        <td><b>Signal strength</b></td>
        <td>Informs on signal strength changes. Possible triggers are:
            <ul>
                <li><i>- 121 dBm - 113 dBm</i></li>
                <li><i>- 113 dBm - 98 dBm</i></li>
                <li><i>- 98 dBm - 93 dBm</i></li>
                <li><i>- 93 dBm - 75 dBm</i></li>
                <li><i>- 75 dBm - 60 dBm</i></li>
                <li><i>- 60 dBm - 50 dBm</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>
    <tr>
        <td><b>SMS</b></td>
        <td>Informs on received SMS messages. Possible triggers are:
            <ul>
                <li><i>SMS received</i></li>
            </ul>
        </td>
    </tr>|}}
    <tr>
        <td><b>SSH</b></td>
        <td>Informs on successful or unsuccessful SSH login attempts. Possible triggers are:
            <ul>
                <li><i>Successful authentication</i></li>
                <li><i>Unsuccessful authentication</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>{{#ifeq: {{{eth}}} | 1 |
    <tr>
        <td><b>Topology state</b></td>
        <td>Informs on changes to the device's network topology. Possible triggers are:
            <ul>
                <li><i>Topology changes</i></li>
            </ul>
        </td>
    </tr>|}}{{#ifeq: {{{failover}}} | 1 |
    <tr>
        <td><b>WAN failover</b></td>
        <td>Informs on WAN failover occurrences. Possible triggers are:
            <ul>
                <li><i>Switched to failover</i></li>
                <li><i>Switched to main</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>|}}
    <tr>
        <td><b>WebUI</b></td>
        <td>Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible triggers are:
            <ul>
                <li><i>Successful authentication</i></li>
                <li><i>Unsuccessful authentication</i></li>
                <li><i>All</i></li>
            </ul>
        </td>
    </tr>{{#ifeq:{{{wifi}}} | 1 |
    <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>

==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:

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

After adding a rule you should be redirected to its configuration page.
{{#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.

[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_sms_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]]

<table class="nd-mantable">
    <tr>
        <th>Field</th>
       	<th>Value</th>
       	<th>Description</th>
    </tr>
    <tr>
      	<td>Enable</td>
       	<td>off {{!}} on; default: <b>off</b></td>
       	<td>Turns the rule on or off.</td>
    </tr>
    <tr>
        <td>Event</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>
    </tr>
    <tr>
        <td>Event type</td>
        <td>Varies</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>
        <td>Action</td>
        <td>Send SMS {{!}} Send email; default: <b>Send Email</b></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>
        <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>
        <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>Text to be included in the body of the report message.</td>
    </tr>
    <tr>
        <td>Recipients</td>
        <td>Single {{!}} Group; default: <b>Single</b></td>
        <td>Specifies whether the recipient should be a single number or a group of numbers.</td>
    </tr>
    <tr>
        <td>Recipient's phone number</td>
        <td>phone number; default: <b>none</b></td>
        <td>Phone number of the recipient. The phone number must be entered in the international format, without spaces or other symbols (for example: <i>+37068163951</i>)</td>
    </tr>
</table>
|}}
<h3>Send email</h3>
----
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]]</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]]

<table class="nd-mantable">
    <tr>
        <th>Field</th>
       	<th>Value</th>
       	<th>Description</th>
    </tr>
    <tr>
      	<td>Enable</td>
       	<td>off | on; default: <b>on</b></td>
       	<td>Turns the rule on or off.</td>
    </tr>
    <tr>
        <td>Event</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>
    </tr>
    <tr>
        <td>Event type</td>
        <td>Varies</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>
        <td>Action</td>
        <td>{{#ifeq:{{{mobile}}}|1|Send SMS {{!}} |}}Send email; default: <b>Send email</b></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>Specifies which modem to get information from.</td>
    </tr>|}}
    <tr>
        <td>Subject</td>
        <td>string; default: <b>none</b></td>
        <td>Subject of the sent email.</td>
    </tr>
    <tr>
        <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>Text to be included in the body of the report email.</td>
    </tr>
    <tr>
        <td>Email account</td>
        <td>email account; default: <b>none</b></td>
        <td>The account that will be used to send an email.</td>
    </tr>
    <tr>
        <td>Recipient's email address</td>
        <td>email address; default: <b>none</b></td>
        <td>Email address of the recipient.</td>
    </tr>
    <tr>
        <td>Send test email</td>
        <td>- (interactive button)</td>
        <td>Sends an email based on the current configuration. This is used to test whether the configuration works as intended.</td>
    </tr>
</table>

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