Difference between revisions of "Template:Networking rutos manual events reporting"
Gytispieze (talk | contribs) |
|||
(12 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | <!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1) --> | + | <!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1), {{eth}} (1), {{simswitch}} --> |
− | {{Template: | + | {{Template: Networking_device_manual_fw_disclosure |
− | | fw_version ={{Template: | + | | series = {{{series}}} |
+ | | name = {{{name}}} | ||
+ | | fw_version ={{Template: Networking_device_manual_latest_fw | ||
| series = {{{series}}} | | 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: | + | {{#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: | + | {{#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== | ||
Line 22: | Line 25: | ||
<tr> | <tr> | ||
<th width=35%>Event</th> | <th width=35%>Event</th> | ||
− | <th width=65%> | + | <th width=65%>Event subtype</th> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 59: | Line 62: | ||
<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>|}} | ||
− | |||
</ul> | </ul> | ||
</td> | </td> | ||
Line 69: | Line 71: | ||
<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> | + | <li><i>Unplugged</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 | TRB2M | 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 80: | Line 94: | ||
<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> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td><b>Startup</b></td> | ||
+ | <td>Informs when device startup completed. Possible triggers are: | ||
+ | <ul> | ||
+ | <li><i>Device startup completed</i></li> | ||
+ | <li><i>After unexpected shutdown</i></li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
Line 107: | Line 132: | ||
</ul> | </ul> | ||
</td> | </td> | ||
− | </tr>|}} | + | </tr>{{#ifeq: {{{simswitch}}} | 1 | |
+ | <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 119: | Line 154: | ||
</tr>{{#ifeq: {{{eth}}} | 1 | | </tr>{{#ifeq: {{{eth}}} | 1 | | ||
<tr> | <tr> | ||
− | <td><b>Topology | + | <td><b>Topology changes</b></td> |
<td>Informs on changes to the device's network topology. Possible triggers are: | <td>Informs on changes to the device's network topology. Possible triggers are: | ||
<ul> | <ul> | ||
Line 156: | Line 191: | ||
</td> | </td> | ||
</tr>|}} | </tr>|}} | ||
+ | <tr> | ||
+ | <td><b>FOTA</b></td> | ||
+ | <td>Informs about a new Firmware update. Possible triggers are: | ||
+ | <ul> | ||
+ | <li><i>Firmware update is now available</i></li> | ||
+ | </ul> | ||
+ | </td> | ||
+ | </tr> | ||
</table> | </table> | ||
Line 183: | Line 226: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event</td> | + | <td>Event type</td> |
− | <td>Config change {{!}} New DHCP client {{!}} Mobile data {{!}} | + | <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|}} {{!}} FOTA; default: <b>Config change</b></td> |
− | <td> | + | <td>Event that will trigger the rule.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event | + | <td>Event subtype</td> |
<td>Varies</td> | <td>Varies</td> | ||
− | <td> | + | <td>More specific event type that will trigger the rule.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Action</td> | <td>Action</td> | ||
− | <td>Send SMS {{!}} Send email; default: <b>Send | + | <td>Send SMS {{!}} Send email; default: <b>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>{{#ifeq:{{{dualmodem}}}| 1 | | ||
Line 214: | Line 257: | ||
<tr> | <tr> | ||
<td>Recipients</td> | <td>Recipients</td> | ||
− | <td>Single | + | <td>Single {{!}} Group; default: <b>Single</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 244: | Line 287: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event</td> | + | <td>Event type</td> |
− | <td>Config change {{!}} New DHCP client {{#ifeq:{{{mobile}}}|1|{{!}} Mobile data {{!}} | + | <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|}} {{!}} FOTA; default: <b>Config change</b></td> |
− | <td> | + | <td>Event that will trigger the rule.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event | + | <td>Event subtype</td> |
<td>Varies</td> | <td>Varies</td> | ||
− | <td> | + | <td>More specific event type that will trigger the rule.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Action</td> | <td>Action</td> | ||
− | <td>{{#ifeq:{{{mobile}}}|1|Send SMS {{!}} |}}Send email; default: <b> | + | <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> | <td>Selects the method of reporting on the specified event.</td> | ||
</tr>{{#ifeq:{{{dualmodem}}}|1| | </tr>{{#ifeq:{{{dualmodem}}}|1| |
Latest revision as of 11:11, 26 August 2024
The information in this page is updated in accordance with firmware version .
Summary
The Events Reporting feature provides the possibility to configure rules that inform via 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 Events Reporting Rules 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 or email to a specified number informing of the occurred event.
All possible trigger events are listed in the table below.
Event | Event subtype |
---|---|
Config change | Informs on changes to the device's configuration. Possible triggers are:
|
New DHCP client | Informs on new DHCP lease give outs. Possible triggers are:
|
Reboot | Informs after device reboot occurrences. Possible triggers are:
|
Startup | Informs when device startup completed. Possible triggers are:
|
SSH | Informs on successful or unsuccessful SSH login attempts. Possible triggers are:
|
WebUI | Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible triggers are:
|
FOTA | Informs about a new Firmware update. Possible triggers are:
|
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:
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_email_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]]
Field | Value | Description |
---|---|---|
Enable | off | on; default: on | Turns the rule on or off. |
Event type | Config change | Startup | New DHCP client | Reboot | SSH | WebUI | FOTA; default: Config change | Event that will trigger the rule. |
Event subtype | Varies | More specific event type that will trigger the rule. |
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 the 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]]