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

From Teltonika Networks Wiki
(change template)
Line 1: Line 1:
==Summary==
+
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wireless}}} (1) -->
 +
{{Template:Networking_rutos_manual_fw_disclosure
 +
| fw_version = {{{series}}}_R_00.02.03
 +
| series = {{{series}}}
 +
}}
  
The '''Events Reporting''' section gives you the ability to configure rules that will inform you via SMS or email when certain events occur on your device. These events can be almost anything – configuration changes, reboots, new connections, various status updates, SIM switches, etc. This page is an overview of the Events Reporting section for {{{name}}} devices.
+
__TOC__
  
<span style="color: red;">The information in this page is updated in accordance with the <span style="color: #0054A6;"><b>[[Media:{{{fw_version}}}_single.bin|{{{fw_version}}}]]</b></span> firmware version.</span>
+
==Summary==
  
==Events Reporting Rules==
+
The '''Events Reporting''' section gives you the ability to configure rules that will inform
 +
you via {{#ifeq:{{{mobile}}}|0||SMS or}} email when certain events occur on your device. These events can be almost anything –
 +
configuration changes, reboots, new connections, various status updates, etc.
 +
This page is an overview of the Events Reporting section for {{{name}}} devices.
  
'''Events Reporting Rules''' window display rules that you set up for such events as logins, reboots, resets, connections, configuration changes and more, that you want to be informed about, through SMS messages or emails. Click the '''Add''' button, it will redirect to '''[[{{{name}}} Events Reporting#Events Reporting Configuration|Events Reporting Configuration]]''' window for new rule, and click on '''Edit''' button [[File:Networking_rutx_manual_edit_button_v1.png]] to modify already existing rule.
+
===Events Reporting Rules===
 +
----
 +
'''Events Reporting Rules''' window display rules that you set up for such events as logins,  
 +
reboots, resets, connections, configuration changes and more, that you want to be informed about,  
 +
through {{#ifeq:{{{mobile}}}|0||SMS messages or}} emails. Click the '''Add''' button, it will redirect to  
 +
'''[[{{{name}}} Events Reporting#Events Reporting Configuration|Events Reporting Configuration]]'''  
 +
window for new rule, and click on '''Edit''' button [[File:Networking_rutx_manual_edit_button_v1.png]] to modify already existing rule.
  
[[File:Networking_rutx_manual_events_reporting_rules_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutx_manual_events_reporting_rules_v3.png|border|class=tlt-border]]
  
  
==Events Reporting Configuration==
+
===Events Reporting Configuration===
 +
----
 +
'''Events Reporting Configuration''' is used to customize Events Reporting rules.
 +
Here you can specify any event and type, you want to be informed about by your chosen message type.
  
'''Events Reporting Configuration''' is used to customize Events Reporting rules. Here you can specify any event type and subtype, you want to be informed about by your chosen message type.
+
{{#ifeq:{{{mobile}}}|0|[[File:Networking_rutx10_manual_events_reporting_configuration_v1.png|border|class=tlt-border]]|
 
+
[[File:Networking_rutx09_manual_events_reporting_configuration_v1.png|border|class=tlt-border]]}}
[[File:Networking_rutx_manual_events_reporting_configuration_v2.png|border|class=tlt-border]]
+
<b>Note</b>: device values below <b>Message text on Event</b> field may be different on your device, this is an example of configuration window in RutOS devices.
  
  
Line 27: Line 43:
 
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
       <td>off | on; Default: '''on'''</td>
+
       <td>off {{!}} on; default: '''on'''</td>
       <td>Toggles the rule ON or OFF</td>
+
       <td>Toggles the rule ON or OFF.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Event type</td>
+
         <td>Event</td>
         <td>Config change | New DHCP client | Mobile data | SMS | Signal Strength | Reboot | SSH | WebUI | Ports state | Topology changes | WAN Failover | GPS; Default: '''Config change'''</td>
+
         <td>Config change {{!}} New DHCP client {{#ifeq:{{{mobile}}}|0||{{!}} Mobile data {{!}} SMS}} {{!}} Signal Strength {{!}} Reboot {{!}} SSH {{!}} WebUI {{!}} Ports state {{!}} Topology changes {{#ifeq:{{{series}}}|RUTX|{{!}} WAN Failover|}} {{#ifeq:{{{gps}}}|1|{{!}} GPS|}}; default: '''Config change'''</td>
         <td>The type of event that you wish to receive information about</td>
+
         <td>The event that you wish to receive information about.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Event subtype</td>
+
         <td>Event type</td>
         <td>'''Sample:''' All</td>
+
         <td>Varies</td>
         <td>Specified event's sub-type. This field changes in accordance with '''Event type'''</td>
+
         <td>Specified event's type. This field changes in accordance with '''Event'''.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>Send SMS | Send email; Default: '''Send email'''</td>
+
        {{#ifeq:{{{mobile}}}|0|
         <td>Action that is to be taken after the specified event occurs</td>
+
        <td>Send email; default: '''Send email'''</td>
 +
        |
 +
         <td>Send SMS {{!}} Send email; default: '''Send SMS'''</td>
 +
        }}
 +
         <td>Action that is to be taken after the specified event occurs.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Message text on Event</td>
 
         <td>Message text on Event</td>
         <td>string; Default: '''device name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;'''</td>
+
         <td>string; default: '''Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;'''</td>
         <td>Specifies the text that the message will contain</td>
+
         <td>Specifies the text that the message will contain.</td>
 
     </tr>
 
     </tr>
 +
{{#ifeq:{{{mobile}}}|0||
 
     <tr>
 
     <tr>
         <td><span style="color: #0054a6;">Send SMS: Recipients</td>
+
         <td><span style="color: #0054a6;">Send SMS:</span> Recipients</td>
         <td>Single number | Group; Default: '''Single number'''</td>
+
         <td>Single number {{!}} Group; default: '''Single number'''</td>
 
         <td>Specifies the intended recipient, or user group. A guide on how to create a User group can be found in the SMS Utilities chapter, '''[[SMS_Utilities#User_Groups| User Groups]]''' section.</td>
 
         <td>Specifies the intended recipient, or user group. A guide on how to create a User group can be found in the SMS Utilities chapter, '''[[SMS_Utilities#User_Groups| User Groups]]''' section.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: #0054a6;">Send SMS: Recipient's phone number</td>
+
         <td><span style="color: #0054a6;">Send SMS:</span> Recipient's phone number</td>
         <td>phone number; Default: " "</td>
+
         <td>phone number; default: <b>none</b></td>
 
         <td>The intended recipient's phone number. The phone number must be entered in the international format, but without dash symbols or spaces, e.g., '''+37061234567'''</td>
 
         <td>The intended recipient's phone number. The phone number must be entered in the international format, but without dash symbols or spaces, e.g., '''+37061234567'''</td>
 
     </tr>
 
     </tr>
 +
}}
 
     <tr>
 
     <tr>
         <td><span style="color: red;">Send email: Subject</td>
+
         <td><span style="color: red;">Send email:</span> Subject</td>
         <td>string; Default: " "</td>
+
         <td>string; default: <b>none</b></td>
 
         <td>Subject of an email. Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )</td>
 
         <td>Subject of an email. Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: red;">Send email: Email user</td>
+
         <td><span style="color: red;">Send email:</span> Email user</td>
 
         <td>Previously created Email user</td>
 
         <td>Previously created Email user</td>
 
         <td>Choose non empty email configuration from email groups. Emails can be configured in '''[[Administration#Users_&_Recipients| Users & Recipients]]''' section.</td>
 
         <td>Choose non empty email configuration from email groups. Emails can be configured in '''[[Administration#Users_&_Recipients| Users & Recipients]]''' section.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: red;">Send email: Recipient's email address</td>
+
         <td><span style="color: red;">Send email:</span> Recipient's email address</td>
         <td>Email address; Default: " "</td>
+
         <td>Email address; default: <b>none</b></td>
 
         <td>The intended recipient's email address. Allowed characters (a-zA-Z0-9._%+@-)</td>
 
         <td>The intended recipient's email address. Allowed characters (a-zA-Z0-9._%+@-)</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: red;">Send email: Send test email</td>
+
         <td><span style="color: red;">Send email:</span> Send test email</td>
         <td>Interactive button</td>
+
         <td>-(interactive button)</td>
 
         <td>Sends test email to chosen recipient.</td>
 
         <td>Sends test email to chosen recipient.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
===Event Types and Sub-types===
+
====Event Types and Sub-types====
 
----
 
----
The example provided above is concerning the '''GPS''' Event type and '''Left geofence''' sub-type. This section is an overview of all other Event type and sub-types.
+
The example provided above is concerning the '''Config change''' Event and '''All''' Event types. This section is an overview of all other Event type and sub-types.
  
====Config change====
+
=====Config change=====
 
----
 
----
  
Line 102: Line 124:
 
         <td>Sends a report message when any '''[[{{{name}}} VPN#OpenVPN|OpenVPN]]''' configuration changes are applied. For example, whenever a new OpenVPN instance is created, an OpenVPN instance gets disabled/enabled, an OpenVPN instance's protocol is changed from UDP to TCP or vice versa, etc.</td>
 
         <td>Sends a report message when any '''[[{{{name}}} VPN#OpenVPN|OpenVPN]]''' configuration changes are applied. For example, whenever a new OpenVPN instance is created, an OpenVPN instance gets disabled/enabled, an OpenVPN instance's protocol is changed from UDP to TCP or vice versa, etc.</td>
 
     </tr>
 
     </tr>
 +
{{#ifeq:{{{mobile}}}|0||
 
     <tr>
 
     <tr>
 
         <td>SMS</td>
 
         <td>SMS</td>
Line 118: Line 141:
 
         <td>Sends a report message when any '''[[{{{name}}} Mobile#Mobile_Data_Limit|Mobile Data Limit]]''' configuration changes are applied. For example, whenever new data limit is configured, data limit gets disabled/enabled on SIM1/SIM2, data limit period is changed, etc.</td>
 
         <td>Sends a report message when any '''[[{{{name}}} Mobile#Mobile_Data_Limit|Mobile Data Limit]]''' configuration changes are applied. For example, whenever new data limit is configured, data limit gets disabled/enabled on SIM1/SIM2, data limit period is changed, etc.</td>
 
     </tr>
 
     </tr>
 +
}}
 +
{{#ifeq:{{{gps}}}|1|
 
     <tr>
 
     <tr>
 
         <td>GPS</td>
 
         <td>GPS</td>
 
         <td>Sends a report message when any configuration changes concerning '''[[{{{name}}} GPS]]''' are applied. For example, whenever GPS gets enabled/disabled, Remote host/IP address is changed, new '''[[{{{name}}} GPS#GPS_Geofencing|Geofencing]]''' area is defined, etc.</td>
 
         <td>Sends a report message when any configuration changes concerning '''[[{{{name}}} GPS]]''' are applied. For example, whenever GPS gets enabled/disabled, Remote host/IP address is changed, new '''[[{{{name}}} GPS#GPS_Geofencing|Geofencing]]''' area is defined, etc.</td>
 
     </tr>
 
     </tr>
 +
|}}
 
     <tr>
 
     <tr>
 
         <td>Events reporting</td>
 
         <td>Events reporting</td>
Line 138: Line 164:
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Auto_Reboot#Ping_Reboot|Ping Reboot]]''' are applied. For example, whenever Ping Reboot gets enabled/disabled, host to ping has changed, etc.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Auto_Reboot#Ping_Reboot|Ping Reboot]]''' are applied. For example, whenever Ping Reboot gets enabled/disabled, host to ping has changed, etc.</td>
 
     </tr>
 
     </tr>
 +
{{#ifeq:{{{series}}}|RUTX|
 
     <tr>
 
     <tr>
 
         <td>Site blocking</td>
 
         <td>Site blocking</td>
 
         <td> Sends a report message when any configuration changes to '''[[{{{name}}} Web_Filter#Site_Blocking|Site Blocking]]''' are applied. For example, whenever Whitelist is changed to Blacklist or vice versa, a new entry is added to Blacklist/Whitelist, etc.</td>
 
         <td> Sends a report message when any configuration changes to '''[[{{{name}}} Web_Filter#Site_Blocking|Site Blocking]]''' are applied. For example, whenever Whitelist is changed to Blacklist or vice versa, a new entry is added to Blacklist/Whitelist, etc.</td>
 
     </tr>
 
     </tr>
{{#ifeq: {{{name}}}|RUTX11|
+
    <tr>
 +
        <td>Content blocker</td>
 +
        <td>Sends a report message when any configuration changes to '''[[{{{name}}} Web_Filter#Proxy_Based_Content_Blocker|Proxy Based Content Blocker]]''' are applied. For example, whenever Whitelist is changed to Blacklist or vice versa, a new entry is added to Blacklist/Whitelist, etc.</td>
 +
    </tr>
 +
|}}
 +
{{#ifeq: {{{wireless}}}|1|
 
     <tr>
 
     <tr>
 
         <td>Hotspot</td>
 
         <td>Hotspot</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Hotspot]]''' are applied. For example, whenever Hotspot SSID was changed, Radius server was changed, Hotspot was enabled/disabled, etc.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Hotspot]]''' are applied. For example, whenever Hotspot SSID was changed, Radius server was changed, Hotspot was enabled/disabled, etc.</td>
     </tr>||
+
     </tr>
}}
+
|}}
 
     <tr>
 
     <tr>
         <td>Content blocker</td>
+
         <td>Input/Output</td>
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Web_Filter#Proxy_Based_Content_Blocker|Proxy Based Content Blocker]]''' are applied. For example, whenever Whitelist is changed to Blacklist or vice versa, a new entry is added to Blacklist/Whitelist, etc.</td>
+
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Input/Output|Input/Output]]''' are applied. For example, whenever scheduler is changed, etc.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 168: Line 200:
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} LAN|DHCP]]''' are applied. For example, whenever DHCP Server is enabled/disabled, DHCP address range is changed.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} LAN|DHCP]]''' are applied. For example, whenever DHCP Server is enabled/disabled, DHCP address range is changed.</td>
 
     </tr>
 
     </tr>
 +
{{#ifeq:{{{series}}}|RUTX|
 
     <tr>
 
     <tr>
 
         <td>VRRP</td>
 
         <td>VRRP</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} VRRP]]''' are applied. For example, whenever VRRP is enabled/disabled, VRRP IP address is changed, etc.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} VRRP]]''' are applied. For example, whenever VRRP is enabled/disabled, VRRP IP address is changed, etc.</td>
 
     </tr>
 
     </tr>
 +
|}}
 
     <tr>
 
     <tr>
 
         <td>SSH</td>
 
         <td>SSH</td>
Line 180: Line 214:
 
         <td>Sends a report message when any Network related configuration changes are applied. For example, whenever Main WAN is changed, LAN IP address is changed, a Wi-Fi Access Point is enabled/disabled, etc.</td>
 
         <td>Sends a report message when any Network related configuration changes are applied. For example, whenever Main WAN is changed, LAN IP address is changed, a Wi-Fi Access Point is enabled/disabled, etc.</td>
 
     </tr>
 
     </tr>
{{#ifeq: {{{name}}}|RUTX11|
+
{{#ifeq:{{{wireless}}}|1|
 
     <tr>
 
     <tr>
 
         <td>Wireless</td>
 
         <td>Wireless</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Wireless]]''' are applied. For example, a new Wi-Fi Access point is created, deleted, enabled/disabled, SSID is changed, etc.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} Wireless]]''' are applied. For example, a new Wi-Fi Access point is created, deleted, enabled/disabled, SSID is changed, etc.</td>
     </tr>||
+
     </tr>
}}
+
|}}
 
     <tr>
 
     <tr>
 
         <td>Firewall</td>
 
         <td>Firewall</td>
Line 194: Line 228:
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} NTP]]''' are applied. For example, whenever NTP is enabled/disabled, Time zone is changed, etc.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} NTP]]''' are applied. For example, whenever NTP is enabled/disabled, Time zone is changed, etc.</td>
 
     </tr>
 
     </tr>
 +
{{#ifeq:{{{series}}}|RUTX|
 
     <tr>
 
     <tr>
 
         <td>UPNP</td>
 
         <td>UPNP</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} UPNP]]''' are applied. For example, whenever usable port range is changed, etc.</td>
 
         <td>Sends a report message when any configuration changes to '''[[{{{name}}} UPNP]]''' are applied. For example, whenever usable port range is changed, etc.</td>
 
     </tr>
 
     </tr>
 +
|}}
 
</table>
 
</table>
  
====New DHCP client====
+
=====New DHCP client=====
 
----
 
----
  
Line 212: Line 248:
 
       <td>Sends a report message when a new devices is connected to the device either via LAN or Wi-Fi.</td>
 
       <td>Sends a report message when a new devices is connected to the device either via LAN or Wi-Fi.</td>
 
     </tr>
 
     </tr>
 +
{{#ifeq:{{{wireless}}}|1|
 
     <tr>
 
     <tr>
 
       <td>Connected from WiFi</td>
 
       <td>Connected from WiFi</td>
 
       <td>Sends a report message when a new device is connected to the device via Wi-Fi.</td>
 
       <td>Sends a report message when a new device is connected to the device via Wi-Fi.</td>
 
     </tr>
 
     </tr>
 +
}}
 
     <tr>
 
     <tr>
 
       <td>Connected from LAN</td>
 
       <td>Connected from LAN</td>
Line 222: Line 260:
 
</table>
 
</table>
  
====Mobile Data====
+
{{#ifeq:{{{mobile}}}|0||
 +
=====Mobile Data=====
 
----
 
----
  
Line 244: Line 283:
 
</table>
 
</table>
  
====SMS====
+
=====SMS=====
 
----
 
----
  
Line 258: Line 297:
 
</table>
 
</table>
  
====Signal Strength====
+
=====Signal Strength=====
 
----
 
----
  
Line 268: Line 307:
 
     <tr>
 
     <tr>
 
       <td>All</td>
 
       <td>All</td>
       <td>Sends a report message when the device's '''[[RSSI]]''' value leaves any one of the below specified ranges.</td>
+
       <td>Sends a report message when the device '''[[RSSI]]''' value leaves any one of the below specified ranges.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>-121 dBm -113 dBm</td>
 
       <td>-121 dBm -113 dBm</td>
       <td>Sends a report message when the device's RSSI value leaves the -121 dBm to -113 dBm range.</td>
+
       <td>Sends a report message when the device RSSI value leaves the -121 dBm to -113 dBm range.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>-113 dBm -98 dBm</td>
 
       <td>-113 dBm -98 dBm</td>
       <td>Sends a report message when the device's RSSI value leaves the -113 dBm to -98 dBm range.</td>
+
       <td>Sends a report message when the device RSSI value leaves the -113 dBm to -98 dBm range.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>-98 dBm -93 dBm</td>
 
       <td>-98 dBm -93 dBm</td>
       <td>Sends a report message when the device's RSSI value leaves the -98 dBm to -93 dBm range.</td>
+
       <td>Sends a report message when the device RSSI value leaves the -98 dBm to -93 dBm range.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>-93 dBm -75 dBm</td>
 
       <td>-93 dBm -75 dBm</td>
       <td>Sends a report message when the device's RSSI value leaves the -93 dBm to -75 dBm range.</td>
+
       <td>Sends a report message when the device RSSI value leaves the -93 dBm to -75 dBm range.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>-75 dBm -60 dBm</td>
 
       <td>-75 dBm -60 dBm</td>
       <td>Sends a report message when the device's RSSI value leaves the -75 dBm to -60 dBm range.</td>
+
       <td>Sends a report message when the device RSSI value leaves the -75 dBm to -60 dBm range.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>-60 dBm -50 dBm</td>
 
       <td>-60 dBm -50 dBm</td>
       <td>Sends a report message when the device's RSSI value leaves the -60 dBm to -50 dBm range.</td>
+
       <td>Sends a report message when the device RSSI value leaves the -60 dBm to -50 dBm range.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
}}
  
====Reboot====
+
=====Reboot=====
 
----
 
----
  
Line 309: Line 349:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>From WebUI</td>
+
       <td>From Web UI</td>
       <td>Sends a report message when the device starts up after a reboot command is initiated from the device's WebUI Administration->Reboot section.</td>
+
       <td>Sends a report message when the device starts up after a reboot command is initiated from the device WebUI Administration->Reboot section.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>From Input/Output</td>
+
       <td>From input/output</td>
 
       <td>Sends a report message when the device starts up after a reboot command is initiated via Input/Output.</td>
 
       <td>Sends a report message when the device starts up after a reboot command is initiated via Input/Output.</td>
 
     </tr>
 
     </tr>
Line 330: Line 370:
 
</table>
 
</table>
  
====SSH====
+
=====SSH=====
 
----
 
----
  
Line 352: Line 392:
 
</table>
 
</table>
  
====WebUI====
+
=====WebUI=====
 
----
 
----
  
Line 374: Line 414:
 
</table>
 
</table>
  
====Ports State====
+
{{#ifeq:{{{series}}}|TRB14X||
 +
=====Ports State=====
 
----
 
----
  
Line 384: Line 425:
 
     <tr>
 
     <tr>
 
       <td>All</td>
 
       <td>All</td>
       <td>Sends a report message when a device is either plugged in or unplugged from one of the device's LAN ports.</td>
+
       <td>Sends a report message when a device is either plugged in or unplugged from one of the device LAN ports.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Link state</td>
 
       <td>Link state</td>
       <td>Sends a report message when a device is plugged or unplugged from one of the device's Ethernet ports.</td>
+
       <td>Sends a report message when a device is plugged or unplugged from one of the device Ethernet ports.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 396: Line 437:
 
</table>
 
</table>
  
====Topology state====
+
=====Topology state=====
 
----
 
----
 +
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 408: Line 450:
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
}}
  
 +
{{#ifeq:{{{series}}}|RUTX|
 +
=====WAN Failover=====
 +
----
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th style="width: 250px">event sub-type</th>
 +
      <th style="width: 904px">description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>All</td>
 +
      <td>Sends a report message when device WAN switches to Failover or back to main WAN.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Switches to main</td>
 +
      <td>Sends a report message when device switches from failover to main WAN.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Switches to failover</td>
 +
      <td>Sends a report message when device switches to failover WAN.</td>
 +
    </tr>
 +
</table>
 +
|}}
 +
 +
{{#ifeq:{{{gps}}}|1|
 +
=====GPS=====
 +
----
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th style="width: 250px">event sub-type</th>
 +
      <th style="width: 904px">description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>All</td>
 +
      <td>Sends a report message when the device moves in and out of the GPS Geofence area.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Left geofence</td>
 +
      <td>Sends a report message when the device leaves the GPS Geofence area.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Entered geofence</td>
 +
      <td>Sends a report message when the device enter the GPS Geofence area.</td>
 +
    </tr>
 +
</table>
 +
|}}
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Revision as of 13:39, 13 May 2020

The information in this page is updated in accordance with firmware version [[Media:{{{series}}}_R_00.02.03_WEBUI.bin|{{{series}}}_R_00.02.03]].

Summary

The Events Reporting section gives you the ability to configure rules that will inform you via SMS or email when certain events occur on your device. These events can be almost anything – configuration changes, reboots, new connections, various status updates, etc. This page is an overview of the Events Reporting section for {{{name}}} devices.

Events Reporting Rules


Events Reporting Rules window display rules that you set up for such events as logins, reboots, resets, connections, configuration changes and more, that you want to be informed about, through SMS messages or emails. Click the Add button, it will redirect to [[{{{name}}} Events Reporting#Events Reporting Configuration|Events Reporting Configuration]] window for new rule, and click on Edit button Networking rutx manual edit button v1.png to modify already existing rule.

File:Networking rutx manual events reporting rules v3.png


Events Reporting Configuration


Events Reporting Configuration is used to customize Events Reporting rules. Here you can specify any event and type, you want to be informed about by your chosen message type.

Networking rutx09 manual events reporting configuration v1.png Note: device values below Message text on Event field may be different on your device, this is an example of configuration window in RutOS devices.


field name value description
Enable off | on; default: on Toggles the rule ON or OFF.
Event Config change | New DHCP client | Mobile data | SMS | Signal Strength | Reboot | SSH | WebUI | Ports state | Topology changes ; default: Config change The event that you wish to receive information about.
Event type Varies Specified event's type. This field changes in accordance with Event.
Action Send SMS | Send email; default: Send SMS Action that is to be taken after the specified event occurs.
Message text on Event string; default: Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts; Specifies the text that the message will contain.
Send SMS: Recipients Single number | Group; default: Single number Specifies the intended recipient, or user group. A guide on how to create a User group can be found in the SMS Utilities chapter, User Groups section.
Send SMS: Recipient's phone number phone number; default: none The intended recipient's phone number. The phone number must be entered in the international format, but without dash symbols or spaces, e.g., +37061234567
Send email: Subject string; default: none Subject of an email. Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )
Send email: Email user Previously created Email user Choose non empty email configuration from email groups. Emails can be configured in Users & Recipients section.
Send email: Recipient's email address Email address; default: none The intended recipient's email address. Allowed characters (a-zA-Z0-9._%+@-)
Send email: Send test email -(interactive button) Sends test email to chosen recipient.

Event Types and Sub-types


The example provided above is concerning the Config change Event and All Event types. This section is an overview of all other Event type and sub-types.

Config change

event sub-type description
All Sends a report message when any type of configuration changes are applied
OpenVPN Sends a report message when any [[{{{name}}} VPN#OpenVPN|OpenVPN]] configuration changes are applied. For example, whenever a new OpenVPN instance is created, an OpenVPN instance gets disabled/enabled, an OpenVPN instance's protocol is changed from UDP to TCP or vice versa, etc.
SMS Sends a report message when any SMS related configuration changes are applied. For example, whenever a new [[{{{name}}}_Mobile_Utilities#SMS_Utilities|SMS Utilities]] rule is created or changed, changes are made to [[{{{name}}}_Mobile_Utilities#SMS_Gateway#Auto_Reply|Auto Reply]], etc.
Multiwan Sends a report message when changes to WAN [[{{{name}}} WAN#Backup_Configuration|Backup]] configuration are applied. For example, whenever a switch from using Wired as main WAN to backup WAN occurs, Wireless is added as a Backup WAN, Health monitor configurations are changed, etc.
Mobile Sends a report message when any [[{{{name}}} Mobile]] configuration changes are applied. For example, whenever Service mode, APN, Connection type is changed, etc.
Data limit Sends a report message when any [[{{{name}}} Mobile#Mobile_Data_Limit|Mobile Data Limit]] configuration changes are applied. For example, whenever new data limit is configured, data limit gets disabled/enabled on SIM1/SIM2, data limit period is changed, etc.
Events reporting Sends a report message when any configuration changes to Events Reporting are applied. For example, whenever a new Events Reporting Rule is created, changed, deleted, etc.
Periodic reboot Sends a report message when any configuration changes to [[{{{name}}} Auto_Reboot#Periodic_Reboot|Periodic Reboot]] are applied. For example, whenever Periodic Reboot gets enabled/disabled, Periodic Reboot interval is changed, etc.
SNMP Sends a report message when any configuration changes to [[{{{name}}} SNMP]] are applied. For example, whenever SNMP service is enabled/disabled, SNMP remote access is enabled/disabled, SNMP port is changed, etc.
Ping reboot Sends a report message when any configuration changes to [[{{{name}}} Auto_Reboot#Ping_Reboot|Ping Reboot]] are applied. For example, whenever Ping Reboot gets enabled/disabled, host to ping has changed, etc.
Input/Output Sends a report message when any configuration changes to [[{{{name}}} Input/Output|Input/Output]] are applied. For example, whenever scheduler is changed, etc.
Profiles Sends a report message when a new [[{{{name}}} Profiles|Profile]] is added or deleted.
DDNS Sends a report message when any configuration changes to [[{{{name}}} Dynamic DNS|Dynamic DNS]] are applied. For example, whenever a new DDNS instance is created, changed, deleted or edited.
IPsec Sends a report message when any configuration changes to [[{{{name}}} VPN#IPsec|IPsec]] are applied. For example, a new IPsec instance is created, changed, deleted, etc.
DHCP Sends a report message when any configuration changes to [[{{{name}}} LAN|DHCP]] are applied. For example, whenever DHCP Server is enabled/disabled, DHCP address range is changed.
SSH Sends a report message when any configuration changes to SSH are applied.
Network Sends a report message when any Network related configuration changes are applied. For example, whenever Main WAN is changed, LAN IP address is changed, a Wi-Fi Access Point is enabled/disabled, etc.
Firewall Sends a report message when any configuration changes to [[{{{name}}} Firewall]] are applied. For example, a new Traffic rule is added, a new SNAT rule is added, a rule is disabled/enabled, etc.
NTP Sends a report message when any configuration changes to [[{{{name}}} NTP]] are applied. For example, whenever NTP is enabled/disabled, Time zone is changed, etc.
New DHCP client

event sub-type description
All Sends a report message when a new devices is connected to the device either via LAN or Wi-Fi.
Connected from LAN Sends a report message when a new device is connected to the device via LAN port.
Mobile Data

event sub-type description
All Sends a report message when mobile data connection is achieved or lost.
Connected Sends a report message when mobile data connection is achieved.
Disconnected Sends a report message when mobile data connection is lost.
SMS

event sub-type description
SMS received Sends a report message when the device receives a new SMS message.
Signal Strength

event sub-type description
All Sends a report message when the device RSSI value leaves any one of the below specified ranges.
-121 dBm -113 dBm Sends a report message when the device RSSI value leaves the -121 dBm to -113 dBm range.
-113 dBm -98 dBm Sends a report message when the device RSSI value leaves the -113 dBm to -98 dBm range.
-98 dBm -93 dBm Sends a report message when the device RSSI value leaves the -98 dBm to -93 dBm range.
-93 dBm -75 dBm Sends a report message when the device RSSI value leaves the -93 dBm to -75 dBm range.
-75 dBm -60 dBm Sends a report message when the device RSSI value leaves the -75 dBm to -60 dBm range.
-60 dBm -50 dBm Sends a report message when the device RSSI value leaves the -60 dBm to -50 dBm range.
Reboot

event sub-type description
All Sends a report message when the device starts up after any type of reboot (except factory reset).
From Web UI Sends a report message when the device starts up after a reboot command is initiated from the device WebUI Administration->Reboot section.
From input/output Sends a report message when the device starts up after a reboot command is initiated via Input/Output.
From ping reboot Sends a report message when the device starts up after a reboot command is initiated by the Ping Reboot function.
From periodic reboot Sends a report message when the device starts up after a reboot command is initiated by the Periodic Reboot function.
From button Sends a report message when the device starts up after being restarted by the press of the physical button located on the device.
SSH

event sub-type description
All Sends a report message when someone connects to the device via SSH (either successfully or unsuccessfully).
Successful authentication Sends a report message when someone successfully connects to the device via SSH.
Unsuccessful authentication Sends a report message when someone unsuccessfully tries to connect to the device via SSH.
WebUI

event sub-type description
All Sends a report message when someone connects to the device via HTTP or HTTPS (either successfully or unsuccessfully).
Successful authentication Sends a report message when someone successfully connects to the device via HTTP or HTTPS.
Unsuccessful authentication Sends a report message when someone unsuccessfully tries to connect to the device via HTTP or HTTPS.
Ports State

event sub-type description
All Sends a report message when a device is either plugged in or unplugged from one of the device LAN ports.
Link state Sends a report message when a device is plugged or unplugged from one of the device Ethernet ports.
Link speed Sends a report message when Port Link speed is decided.
Topology state

event sub-type description
Topology changes Sends a report message when there are changes in network topology.



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