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

From Teltonika Networks Wiki
(37 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wifi}}} (1), {{eth}} (1), {{simswitch}} -->
+
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{gps}}} (1), {{{wireless}}} (1) -->
−
{{Template: Networking_device_manual_fw_disclosure
+
{{Template:Networking_rutos_manual_fw_disclosure
−
| series = {{{series}}}
+
| fw_version = {{{series}}}_R_00.02.04.1
−
| name  = {{{name}}}
+
| series     = {{{series}}}
−
| 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 via {{#ifeq:{{{mobile}}}|0||SMS or }} email when certain trigger events occur.
+
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.
 
This page is an overview of the Events Reporting section for {{{name}}} devices.
  
−
==Events Reporting Rules==
+
===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_v3.png|border|class=tlt-border]]
  
−
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.  
+
===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.
  
−
<table class="nd-othertables_2" style="width: 100%;">
+
{{#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]]}}
 +
<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.
 +
 
 +
 
 +
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th width=35%>Event</th>
+
         <th>field name</th>
−
        <th width=65%>Event subtype</th>
+
      <th>value</th>
 +
      <th>description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td><b>Config change</b></td>
+
      <td>Enable</td>
−
        <td>Informs on changes to the device's configuration. Possible triggers are:
+
      <td>off {{!}} on; default: '''on'''</td>
−
            <ul>
+
      <td>Toggles the rule ON or OFF.</td>
−
                <li><i>Any config change</i></li>
+
     </tr>
−
                <li><i>Specific config change</i></li>
 
−
            </ul>
 
−
        </td>
 
−
     </tr>{{#ifeq: {{{gps}}} | 1 |
 
 
     <tr>
 
     <tr>
−
         <td><b>GPS</b></td>
+
         <td>Event</td>
−
         <td>Informs on when the device has entered or left a user defined geofence zone. Possible triggers are:
+
         <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>
−
            <ul>
+
        <td>The event that you wish to receive information about.</td>
−
                <li><i>Entered geofence</i></li>
+
    </tr>
−
                <li><i>Left geofence</i></li>
 
−
                <li><i>All</i></li>
 
−
            </ul>
 
−
        </td>
 
−
    </tr>|}}{{#ifeq: {{{mobile}}} | 1 |
 
 
     <tr>
 
     <tr>
−
         <td><b>Mobile data</b></td>
+
         <td>Event type</td>
−
         <td>Informs on changes to the state of the device's mobile connection. Possible triggers are:
+
        <td>Varies</td>
−
            <ul>
+
         <td>Specified event's type. This field changes in accordance with '''Event'''.</td>
−
                <li><i>Connected</i></li>
+
     </tr>
−
                <li><i>Disconnected</i></li>
 
−
                <li><i>All</i></li>
 
−
            </ul>
 
−
        </td>
 
−
     </tr>|}}
 
 
     <tr>
 
     <tr>
−
         <td><b>New DHCP client</b></td>
+
         <td>Action</td>
−
         <td>Informs on new DHCP lease give outs. Possible triggers are:
+
         {{#ifeq:{{{mobile}}}|0|
−
            <ul>
+
        <td>Send email; default: '''Send email'''</td>
−
                <li><i>Connected from LAN</i></li>{{#ifeq: {{{wifi}}} | 1 |
+
        |
−
                <li><i>Connected from WiFi</i></li>|}}
+
        <td>Send SMS {{!}} Send email; default: '''Send SMS'''</td>
−
            </ul>
+
        }}
−
        </td>
+
        <td>Action that is to be taken after the specified event occurs.</td>
−
     </tr>{{#ifeq: {{{eth}}} | 1 |
+
     </tr>
 
     <tr>
 
     <tr>
−
         <td><b>Ports state</b></td>
+
         <td>Message text on Event</td>
−
         <td>Informs on Ethernet port state (plugged in or unplugged) or speed (100 Mbps or 1000 Mbps) changes. Possible triggers are:
+
         <td>string; default: '''Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;'''</td>
−
            <ul>
+
        <td>Specifies the text that the message will contain.</td>
−
                <li><i>Link speed</i></li>
+
    </tr>
−
                <li><i>Link state</i></li>
+
{{#ifeq:{{{mobile}}}|0||
−
                <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>
 
−
        </td>
 
−
    </tr>|}}
 
 
     <tr>
 
     <tr>
−
         <td><b>Reboot</b></td>
+
         <td><span style="color: #0054a6;">Send SMS:</span> Recipients</td>
−
         <td>Informs after device reboot occurrences. Possible triggers are:
+
         <td>Single number {{!}} Group; default: '''Single number'''</td>
−
            <ul>
+
        <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>
−
                <li><i>From button</i></li>
 
−
                <li><i>From Input/Output</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 WebUI</i></li>
 
−
                <li><i>From SMS</i></li>
 
−
                <li><i>All</i></li>
 
−
            </ul>
 
−
        </td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td><b>Startup</b></td>
+
         <td><span style="color: #0054a6;">Send SMS:</span> Recipient's phone number</td>
−
         <td>Informs when device startup completed. Possible triggers are:
+
         <td>phone number; default: <b>none</b></td>
−
            <ul>
+
        <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>
−
                <li><i>Device startup completed</i></li>
+
     </tr>
−
            </ul>
+
}}
−
        </td>
 
−
     </tr>{{#ifeq: {{{mobile}}} | 1 |
 
 
     <tr>
 
     <tr>
−
         <td><b>Signal strength</b></td>
+
         <td><span style="color: red;">Send email:</span> Subject</td>
−
         <td>Informs on signal strength changes. Possible triggers are:
+
         <td>string; default: <b>none</b></td>
−
            <ul>
+
        <td>Subject of an email. Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )</td>
−
                <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>
 
     <tr>
 
     <tr>
−
         <td><b>SMS</b></td>
+
         <td><span style="color: red;">Send email:</span> Email user</td>
−
         <td>Informs on received SMS messages. Possible triggers are:
+
         <td>Previously created Email user</td>
−
            <ul>
+
        <td>Choose non empty email configuration from email groups. Emails can be configured in '''[[Administration#Users_&_Recipients| Users & Recipients]]''' section.</td>
−
                <li><i>SMS received</i></li>
+
     </tr>
−
            </ul>
 
−
        </td>
 
−
     </tr>{{#ifeq: {{{simswitch}}} | 1 |
 
 
     <tr>
 
     <tr>
−
         <td><b>Sim switch</b></td>
+
         <td><span style="color: red;">Send email:</span> Recipient's email address</td>
−
         <td>Informs on sim switch changes. Possible triggers are:
+
         <td>Email address; default: <b>none</b></td>
−
            <ul>
+
        <td>The intended recipient's email address. Allowed characters (a-zA-Z0-9._%+@-)</td>
−
                <li><i>Changing to SIM1</i></li>
+
     </tr>
−
                <li><i>Changing to SIM2</i></li>
 
−
                <li><i>All</i></li>
 
−
            </ul>
 
−
        </td>
 
−
     </tr>|}}|}}
 
 
     <tr>
 
     <tr>
−
         <td><b>SSH</b></td>
+
         <td><span style="color: red;">Send email:</span> Send test email</td>
−
         <td>Informs on successful or unsuccessful SSH login attempts. Possible triggers are:
+
         <td>-(interactive button)</td>
−
            <ul>
+
        <td>Sends test email to chosen recipient.</td>
−
                <li><i>Successful authentication</i></li>
+
    </tr>
−
                <li><i>Unsuccessful authentication</i></li>
+
</table>
−
                <li><i>All</i></li>
+
 
−
            </ul>
+
====Event Types and Sub-types====
−
        </td>
+
----
−
    </tr>{{#ifeq: {{{eth}}} | 1 |
+
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=====
 +
----
 +
 
 +
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <td><b>Topology changes</b></td>
+
         <th style="width: 250px">event sub-type</th>
−
        <td>Informs on changes to the device's network topology. Possible triggers are:
+
      <th style="width: 904px">description</th>
−
            <ul>
+
     </tr>
−
                <li><i>Topology changes</i></li>
 
−
            </ul>
 
−
        </td>
 
−
     </tr>|}}{{#ifeq: {{{failover}}} | 1 |
 
 
     <tr>
 
     <tr>
−
        <td><b>WAN failover</b></td>
+
      <td>All</td>
−
        <td>Informs on WAN failover occurrences. Possible triggers are:
+
      <td>Sends a report message when any type of configuration changes are applied</td>
−
            <ul>
+
     </tr>
−
                <li><i>Switched to failover</i></li>
 
−
                <li><i>Switched to main</i></li>
 
−
                <li><i>All</i></li>
 
−
            </ul>
 
−
        </td>
 
−
     </tr>|}}
 
 
     <tr>
 
     <tr>
−
         <td><b>WebUI</b></td>
+
         <td>OpenVPN</td>
−
         <td>Informs on successful or unsuccessful HTTP/HTTPS login attempts. Possible triggers are:
+
         <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>
−
            <ul>
+
    </tr>
−
                <li><i>Successful authentication</i></li>
+
{{#ifeq:{{{mobile}}}|0||
−
                <li><i>Unsuccessful authentication</i></li>
+
    <tr>
−
                <li><i>All</i></li>
+
        <td>SMS</td>
−
            </ul>
+
        <td>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.</td>
−
        </td>
+
    </tr>
−
     </tr>{{#ifeq:{{{wifi}}} | 1 |
+
    <tr>
 +
        <td>Multiwan</td>
 +
        <td>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.</td>
 +
     </tr>
 
     <tr>
 
     <tr>
−
         <td><b>New WiFi client</b></td>
+
         <td>Mobile</td>
−
         <td>Informs on new WiFi clients. Possible triggers are:
+
        <td>Sends a report message when any '''[[{{{name}}} Mobile]]''' configuration changes are applied. For example, whenever Service mode, APN, Connection type is changed, etc.</td>
−
            <ul>
+
    </tr>
−
                <li><i>Connected</i></li>
+
    <tr>
−
                <li><i>Disconnected</i></li>
+
        <td>Data limit</td>
−
                <li><i>All</i></li>
+
         <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>
−
            </ul>
+
    </tr>
−
         </td>
+
}}
−
     </tr>|}}
+
{{#ifeq:{{{gps}}}|1|
 +
    <tr>
 +
        <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>
 +
    </tr>
 +
|}}
 +
    <tr>
 +
        <td>Events reporting</td>
 +
        <td>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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Periodic reboot</td>
 +
        <td>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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>SNMP</td>
 +
        <td>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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Ping reboot</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>
 +
{{#ifeq:{{{series}}}|RUTX|
 +
    <tr>
 +
        <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>
 +
    </tr>
 +
    <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>
 +
        <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>
 +
    </tr>
 +
|}}
 +
    <tr>
 +
        <td>Input/Output</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>
 +
        <td>Profiles</td>
 +
         <td>Sends a report message when a new '''[[{{{name}}} Profiles|Profile]]''' is added or deleted.</td>
 +
     </tr>
 +
    <tr>
 +
        <td>DDNS</td>
 +
        <td>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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>IPsec</td>
 +
        <td>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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>DHCP</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>
 +
{{#ifeq:{{{series}}}|RUTX|
 +
    <tr>
 +
        <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>
 +
    </tr>
 +
|}}
 +
    <tr>
 +
        <td>SSH</td>
 +
        <td>Sends a report message when any configuration changes to SSH are applied.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Network</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>
 +
{{#ifeq:{{{wireless}}}|1|
 +
    <tr>
 +
        <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>
 +
    </tr>
 +
|}}
 +
    <tr>
 +
        <td>Firewall</td>
 +
        <td>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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>NTP</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>
 +
{{#ifeq:{{{series}}}|RUTX|
 +
    <tr>
 +
        <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>
 +
    </tr>
 +
|}}
 
</table>
 
</table>
  
−
==Events Reporting Configuration==
+
=====New DHCP client=====
 +
----
  
−
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:
+
<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 a new devices is connected to the device either via LAN or Wi-Fi.</td>
 +
    </tr>
 +
{{#ifeq:{{{wireless}}}|1|
 +
    <tr>
 +
      <td>Connected from WiFi</td>
 +
      <td>Sends a report message when a new device is connected to the device via Wi-Fi.</td>
 +
    </tr>
 +
}}
 +
    <tr>
 +
      <td>Connected from LAN</td>
 +
      <td>Sends a report message when a new device is connected to the device via LAN port.</td>
 +
    </tr>
 +
</table>
  
−
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_add_button.png|border|class=tlt-border]]
+
{{#ifeq:{{{mobile}}}|0||
 +
=====Mobile Data=====
 +
----
  
−
After adding a rule you should be redirected to its configuration page.
+
<table class="nd-mantable">
−
{{#ifeq: {{{mobile}}} | 1 | ===Send SMS===
+
    <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 mobile data connection is achieved or lost.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Connected</td>
 +
      <td>Sends a report message when mobile data connection is achieved.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Disconnected</td>
 +
      <td>Sends a report message when mobile data connection is lost.</td>
 +
    </tr>
 +
</table>
 +
 
 +
=====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 style="width: 250px">event sub-type</th>
 +
      <th style="width: 904px">description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>SMS received</td>
 +
      <td>Sends a report message when the device receives a new SMS message.</td>
 +
    </tr>
 +
</table>
 +
 
 +
=====Signal Strength=====
 +
----
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th>Field</th>
+
         <th style="width: 250px">event sub-type</th>
−
       <th>Value</th>
+
       <th style="width: 904px">description</th>
−
       <th>Description</th>
+
    </tr>
 +
    <tr>
 +
      <td>All</td>
 +
      <td>Sends a report message when the device '''[[RSSI]]''' value leaves any one of the below specified ranges.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>-121 dBm -113 dBm</td>
 +
       <td>Sends a report message when the device RSSI value leaves the -121 dBm to -113 dBm range.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>-113 dBm -98 dBm</td>
 +
      <td>Sends a report message when the device RSSI value leaves the -113 dBm to -98 dBm range.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>-98 dBm -93 dBm</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>Enable</td>
+
       <td>-93 dBm -75 dBm</td>
−
       <td>off {{!}} on; default: <b>off</b></td>
+
       <td>Sends a report message when the device RSSI value leaves the -93 dBm to -75 dBm range.</td>
−
      <td>Turns the rule on or off.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Event type</td>
+
      <td>-75 dBm -60 dBm</td>
−
        <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|}}; default: <b>Config change</b></td>
+
      <td>Sends a report message when the device RSSI value leaves the -75 dBm to -60 dBm range.</td>
−
        <td>Event that will trigger the rule.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Event subtype</td>
+
      <td>-60 dBm -50 dBm</td>
−
        <td>Varies</td>
+
      <td>Sends a report message when the device RSSI value leaves the -60 dBm to -50 dBm range.</td>
−
         <td>More specific event type that will trigger the rule.</td>
+
    </tr>
 +
</table>
 +
}}
 +
 
 +
=====Reboot=====
 +
----
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
         <th style="width: 250px">event sub-type</th>
 +
      <th style="width: 904px">description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Action</td>
+
      <td>All</td>
−
        <td>Send SMS {{!}} Send email; default: <b>Send Email</b></td>
+
      <td>Sends a report message when the device starts up after any type of reboot (except factory reset).</td>
−
        <td>Selects the method of reporting on the specified event.</td>
+
     </tr>
−
     </tr>{{#ifeq:{{{dualmodem}}}| 1 |
 
 
     <tr>
 
     <tr>
−
        <td>Modem</td>
+
      <td>From Web UI</td>
−
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></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>
−
        <td>Selects the modem which is used to get information from.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Gateway modem</td>
+
      <td>From input/output</td>
−
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></td>
+
      <td>Sends a report message when the device starts up after a reboot command is initiated via Input/Output.</td>
−
        <td>Selects the modem which is used to send SMS.</td>
+
     </tr>
−
     </tr>|}}
 
 
     <tr>
 
     <tr>
−
        <td>Message text on Event</td>
+
      <td>From ping reboot</td>
−
        <td>string; default: <b>Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;</b></td>
+
      <td>Sends a report message when the device starts up after a reboot command is initiated by the Ping Reboot function.</td>
−
        <td>Text to be included in the body of the report message.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Recipients</td>
+
      <td>From periodic reboot</td>
−
        <td>Single {{!}} Group; default: <b>Single</b></td>
+
      <td>Sends a report message when the device starts up after a reboot command is initiated by the Periodic Reboot function.</td>
−
        <td>Specifies whether the recipient should be a single number or a group of numbers.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Recipient's phone number</td>
+
      <td>From button</td>
−
        <td>phone number; default: <b>none</b></td>
+
      <td>Sends a report message when the device starts up after being restarted by the press of the physical button located on the device.</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>
 
     </tr>
 
</table>
 
</table>
−
|}}
+
 
−
<h3>Send email</h3>
+
=====SSH=====
 
----
 
----
−
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.
+
<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 someone connects to the device via SSH (either successfully or unsuccessfully).</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Successful authentication</td>
 +
      <td>Sends a report message when someone successfully connects to the device via SSH.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Unsuccessful authentication</td>
 +
      <td>Sends a report message when someone unsuccessfully tries to connect to the device via SSH.</td>
 +
    </tr>
 +
</table>
  
−
[[File:Networking_rutos_manual_events_reporting_events_reporting_rules_send_email_dual_modem_{{{dualmodem}}}_v1.png|border|class=tlt-border]]
+
=====WebUI=====
 +
----
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th>Field</th>
+
         <th style="width: 250px">event sub-type</th>
−
       <th>Value</th>
+
       <th style="width: 904px">description</th>
−
      <th>Description</th>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
       <td>Enable</td>
+
       <td>All</td>
−
       <td>off | on; default: <b>on</b></td>
+
       <td>Sends a report message when someone connects to the device via HTTP or HTTPS (either successfully or unsuccessfully).</td>
−
       <td>Turns the rule on or off.</td>
+
    </tr>
 +
    <tr>
 +
      <td>Successful authentication</td>
 +
       <td>Sends a report message when someone successfully connects to the device via HTTP or HTTPS.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Unsuccessful authentication</td>
 +
      <td>Sends a report message when someone unsuccessfully tries to connect to the device via HTTP or HTTPS.</td>
 +
    </tr>
 +
</table>
 +
 
 +
{{#ifeq:{{{series}}}|TRB14X||
 +
=====Ports State=====
 +
----
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th style="width: 250px">event sub-type</th>
 +
      <th style="width: 904px">description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Event type</td>
+
      <td>All</td>
−
        <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|}}; default: <b>Config change</b></td>
+
      <td>Sends a report message when a device is either plugged in or unplugged from one of the device LAN ports.</td>
−
        <td>Event that will trigger the rule.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Event subtype</td>
+
      <td>Link state</td>
−
        <td>Varies</td>
+
      <td>Sends a report message when a device is plugged or unplugged from one of the device Ethernet ports.</td>
−
        <td>More specific event type that will trigger the rule.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Action</td>
+
      <td>Link speed</td>
−
        <td>{{#ifeq:{{{mobile}}}|1|Send SMS {{!}} |}}Send email; default: <b>Send email</b></td>
+
      <td>Sends a report message when Port Link speed is decided.</td>
−
        <td>Selects the method of reporting on the specified event.</td>
+
    </tr>
−
    </tr>{{#ifeq:{{{dualmodem}}}|1|
+
</table>
 +
 
 +
=====Topology state=====
 +
----
 +
 
 +
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <td>Modem</td>
+
         <th style="width: 250px">event sub-type</th>
−
        <td>Primary modem {{!}} Secondary modem; default: <b>Primary Modem</b></td>
+
      <th style="width: 904px">description</th>
−
        <td>Specifies which modem to get information from.</td>
+
     </tr>
−
     </tr>|}}
 
 
     <tr>
 
     <tr>
−
        <td>Subject</td>
+
      <td>Topology changes</td>
−
        <td>string; default: <b>none</b></td>
+
      <td>Sends a report message when there are changes in network topology.</td>
−
        <td>Subject of the sent email.</td>
 
 
     </tr>
 
     </tr>
 +
</table>
 +
}}
 +
 +
{{#ifeq:{{{series}}}|RUTX|
 +
=====WAN Failover=====
 +
----
 +
 +
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <td>Message text on Event</td>
+
         <th style="width: 250px">event sub-type</th>
−
        <td>string; default: <b>Router name - %rn; Event type - %et; Event text - %ex; Time stamp - %ts;</b></td>
+
      <th style="width: 904px">description</th>
−
        <td>Text to be included in the body of the report email.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Email account</td>
+
      <td>All</td>
−
        <td>email account; default: <b>none</b></td>
+
      <td>Sends a report message when device WAN switches to Failover or back to main WAN.</td>
−
        <td>The account that will be used to send an email.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Recipient's email address</td>
+
      <td>Switches to main</td>
−
        <td>email address; default: <b>none</b></td>
+
      <td>Sends a report message when device switches from failover to main WAN.</td>
−
        <td>Email address of the recipient.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
        <td>Send test email</td>
+
      <td>Switches to failover</td>
−
        <td>- (interactive button)</td>
+
      <td>Sends a report message when device switches to failover WAN.</td>
−
        <td>Sends an email based on the current configuration. This is used to test whether the configuration works as intended.</td>
 
 
     </tr>
 
     </tr>
 
</table>
 
</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 07:52, 3 July 2020

Template:Networking rutos manual fw disclosure

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]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_events_reporting&oldid=66118"