Template:Networking rutos manual events reporting: Difference between revisions
No edit summary |
No edit summary |
||
| (33 intermediate revisions by 7 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 | ||
| | | series = {{{series}}} | ||
| series | | name = {{{name}}} | ||
| 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 | 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 18: | ||
==Events Reporting Rules== | ==Events Reporting Rules== | ||
The <b>Events Reporting Rules</b> | 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 20: | 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> | ||
<td><b>Config change</b></td> | <td><b>Config change</b></td> | ||
<td>Informs on changes to the device's configuration. Possible | <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 38: | ||
<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 | <td>Informs on when the device has entered or left a user defined geofence zone. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>Entered geofence</i></li> | ||
<li>Left geofence</li> | <li><i>Left geofence</i></li> | ||
<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 | <td>Informs on changes to the state of the device's mobile connection. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>Connected</i></li> | ||
<li> | <li><i>Disconnected</i></li> | ||
<li> | <li><i>All</i></li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
| Line 53: | Line 58: | ||
<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 | <td>Informs on new DHCP lease give outs. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>Connected from LAN</i></li>{{#ifeq: {{{wifi}}} | 1 | | ||
<li>Connected from WiFi</li>|}} | <li><i>Connected from WiFi</i></li>|}} | ||
</ul> | </ul> | ||
</td> | </td> | ||
| Line 63: | Line 67: | ||
<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 | <td>Informs on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>Link speed</i></li> | ||
<li>Link state</li> | <li><i>Link state</i></li> | ||
<li> | <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 73: | Line 89: | ||
<tr> | <tr> | ||
<td><b>Reboot</b></td> | <td><b>Reboot</b></td> | ||
<td>Informs after device reboot occurrences. Possible | <td>Informs after device reboot occurrences. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>From button</i></li> | ||
<li>From | <li><i>From Input/Output</i></li> | ||
<li>From | <li><i>From Ping Reboot</i></li> | ||
<li>From | <li><i>From wget Reboot</i></li> | ||
<li>From Reboot Scheduler</li> | <li><i>From Reboot Scheduler</i></li> | ||
<li>From | <li><i>From WebUI</i></li> | ||
<li><i>From SMS</i></li> | |||
<li><i>All</i></li> | |||
</ul> | </ul> | ||
</td> | </td> | ||
</tr>{{#ifeq: {{{ | </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> | |||
</td> | |||
</tr>{{#ifeq: {{{mobile}}} | 1 | | |||
<tr> | <tr> | ||
<td><b>Signal strength</b></td> | <td><b>Signal strength</b></td> | ||
<td>Informs on signal strength changes. Possible | <td>Informs on signal strength changes. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>- 121 dBm - 113 dBm</i></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> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b>SMS</b></td> | <td><b>SMS</b></td> | ||
<td>Informs on received SMS messages. Possible | <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> | ||
</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> | ||
<td>Informs on successful or unsuccessful SSH login attempts. Possible | <td>Informs on successful or unsuccessful SSH login attempts. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>Successful authentication</i></li> | ||
<li> | <li><i>Unsuccessful authentication</i></li> | ||
<li> | <li><i>All</i></li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
</tr>{{#ifeq: {{{eth}}} | 1 | | </tr>{{#ifeq: {{{eth}}} | 1 | | ||
<tr> | <tr> | ||
<td><b>Topology | <td><b>Topology changes</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 163: | ||
<tr> | <tr> | ||
<td><b>WAN failover</b></td> | <td><b>WAN failover</b></td> | ||
<td>Informs on WAN failover occurrences. Possible | <td>Informs on WAN failover occurrences. Possible triggers are: | ||
<ul> | <ul> | ||
<li> | <li><i>Switched to failover</i></li> | ||
<li>Switched to main</li> | <li><i>Switched to main</i></li> | ||
<li> | <li><i>All</i></li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
| Line 136: | Line 173: | ||
<tr> | <tr> | ||
<td><b>WebUI</b></td> | <td><b>WebUI</b></td> | ||
<td>Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible | <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> | <ul> | ||
<li> | <li><i>Connected</i></li> | ||
<li> | <li><i>Disconnected</i></li> | ||
<li> | <li><i>All</i></li> | ||
</ul> | |||
</td> | |||
</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> | </ul> | ||
</td> | </td> | ||
| Line 153: | Line 208: | ||
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 | | {{#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, | 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: | [[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_sms_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]] | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 167: | Line 222: | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
<td>off {{!}} on; default: <b> | <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 type</td> | ||
<td>Config change {{!}} New DHCP client {{ | <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> | |||
<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> | ||
<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 206: | Line 271: | ||
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_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]] | |||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 220: | Line 287: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Event</td> | <td>Event type</td> | ||
<td>Config change {{!}} New DHCP client {{!}} Mobile data {{!}} SMS}} {{!}} | <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>Send SMS {{!}} Send email; default: <b>Send | <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> | </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> | <tr> | ||
<td>Subject</td> | <td>Subject</td> | ||
| Line 242: | Line 314: | ||
<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> | ||
Latest revision as of 10: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]]