Difference between revisions of "Template:Networking rutos manual events reporting"
(32 intermediate revisions by 6 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) --> |
− | {{Template: | + | {{Template:Networking_rutos_manual_fw_disclosure |
− | | | + | | fw_version = {{{series}}}_R_00.02.05.1 |
− | + | | series = {{{series}}} | |
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | + | ||
− | |||
==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%> | + | <th width=65%>Description</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 trigger are: |
<ul> | <ul> | ||
− | <li | + | <li>Any config change</li> |
− | <li | + | <li>Specific config change</li> |
</ul> | </ul> | ||
</td> | </td> | ||
Line 38: | Line 33: | ||
<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 trigger are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li | + | <li>Left geofence</li> |
− | <li> | + | <li>Entered geofence</li> |
</ul> | </ul> | ||
</td> | </td> | ||
</tr>|}}{{#ifeq: {{{mobile}}} | 1 | | </tr>|}}{{#ifeq: {{{mobile}}} | 1 | | ||
<tr> | <tr> | ||
− | <td><b>Mobile | + | <td><b>Mobile</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 trigger are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li> | + | <li>Connected</li> |
− | <li> | + | <li>Disconnected</li> |
</ul> | </ul> | ||
</td> | </td> | ||
Line 58: | Line 53: | ||
<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 values are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li>{{#ifeq: {{{wifi}}} | 1 | |
− | <li | + | <li>Connected from WiFi</li>|}} |
+ | <li>Connected from LAN</li> | ||
</ul> | </ul> | ||
</td> | </td> | ||
Line 67: | Line 63: | ||
<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 values are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li | + | <li>Link state</li> |
− | <li> | + | <li>Link speed</li> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</ul> | </ul> | ||
</td> | </td> | ||
Line 89: | Line 73: | ||
<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 values are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li | + | <li>From WebUI</li> |
− | <li | + | <li>From Input/Output</li> |
− | <li | + | <li>From Ping Reboot</li> |
− | <li | + | <li>From Reboot Scheduler</li> |
− | <li | + | <li>From button</li> |
− | |||
− | |||
</ul> | </ul> | ||
</td> | </td> | ||
− | + | </tr>{{#ifeq: {{{wifi}}} | 1 | | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | </tr>{{#ifeq: {{{ | ||
<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 values are: |
<ul> | <ul> | ||
− | <li>< | + | <li>All</li> |
− | <li | + | <li>- 121 dBm - 113 dBm</li> |
− | <li | + | <li>- 113 dBm - 98 dBm</li> |
− | <li | + | <li>- 98 dBm - 93 dBm</li> |
− | <li | + | <li>- 93 dBm - 75 dBm</li> |
− | <li | + | <li>- 75 dBm - 60 dBm</li> |
− | + | <li>- 60 dBm - 50 dBm</li> | |
</ul> | </ul> | ||
</td> | </td> | ||
− | </tr> | + | </tr>|}}{{#ifeq: {{{mobile}}} | 1 | |
<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 values are: |
<ul> | <ul> | ||
− | <li | + | <li>SMS received</li> |
</ul> | </ul> | ||
</td> | </td> | ||
− | </tr> | + | </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 values are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li> | + | <li>Successful authentication</li> |
− | <li> | + | <li>Unsuccessful authentication</li> |
</ul> | </ul> | ||
</td> | </td> | ||
</tr>{{#ifeq: {{{eth}}} | 1 | | </tr>{{#ifeq: {{{eth}}} | 1 | | ||
<tr> | <tr> | ||
− | <td><b>Topology | + | <td><b>Topology state</b></td> |
− | <td> | + | <td> |
<ul> | <ul> | ||
− | <li | + | <li>Topology changes</li> |
</ul> | </ul> | ||
</td> | </td> | ||
Line 162: | Line 126: | ||
<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 values are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li | + | <li>Switched to main</li> |
− | <li> | + | <li>Switched to failover</li> |
</ul> | </ul> | ||
</td> | </td> | ||
Line 172: | Line 136: | ||
<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 values are: |
<ul> | <ul> | ||
− | <li> | + | <li>All</li> |
− | <li> | + | <li>Successful authentication</li> |
− | <li> | + | <li>Unsuccessful authentication</li> |
</ul> | </ul> | ||
</td> | </td> | ||
− | </tr> | + | </tr> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</table> | </table> | ||
+ | |||
+ | |||
+ | [[File:Networking_rutx_manual_events_reporting_rules_v3.png|border|class=tlt-border]] | ||
+ | |||
==Events Reporting Configuration== | ==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 199: | Line 157: | ||
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 | <h3>Send SMS</h3> |
---- | ---- | ||
− | 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, it will send out an SMS message from the 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.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 213: | Line 171: | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
− | <td>off {{!}} on; default: <b> | + | <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 | + | <td>Event</td> |
− | <td>Config change {{!}} New DHCP client {{ | + | <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> | + | <td>The event that you wish to receive notifications on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event | + | <td>Event type</td> |
<td>Varies</td> | <td>Varies</td> | ||
− | <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 | + | <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> | </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 | + | <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 262: | Line 210: | ||
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]] | + | 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. |
− | |||
− | |||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 278: | Line 224: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event | + | <td>Event</td> |
− | <td>Config change | + | <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> | + | <td>The event that you wish to receive notifications on.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Event | + | <td>Event type</td> |
<td>Varies</td> | <td>Varies</td> | ||
− | <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> | + | <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> | + | </tr> |
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
<td>Subject</td> | <td>Subject</td> | ||
Line 305: | Line 246: | ||
<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 | + | <td>Text to be included in the body of report email.</td> |
</tr> | </tr> | ||
<tr> | <tr> |
Revision as of 10:42, 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 trigger are:
|
New DHCP client | Informs on new DHCP lease give outs. Possible values are:
|
Reboot | Informs after device reboot occurrences. Possible values are:
|
SSH | Informs on successful or unsuccessful SSH login attempts. Possible values are:
|
WebUI | Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible values are:
|
File:Networking rutx manual events reporting rules v3.png
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.
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 SMS | Send email; default: Send SMS Selects the method of reporting on the specified event. 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 message. Recipients Single number | Group; default: Single number Specifies whether the recipient should be a single number or a group of numbers. Recipient's phone number phone number; default: none Phone number of the recipient. The phone number must be entered in the international format, without spaces or other symbols (for example: +37068163951)
|}}
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.
Field | Value | Description |
---|---|---|
Enable | off | on; default: on | Turns the rule on or off. |
Event | Config change | New DHCP client | Mobile data | SMS}} | Signal Strength | 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 SMS | Send email; default: Send SMS | 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]]