Teltonika Networks Wiki

Changes

Template:Networking rutos manual mobile utilities (view source)

Revision as of 00:18, 18 May 2020

14,325 bytes added ,  00:18, 18 May 2020
no edit summary
Line 10: Line 10:  
The SMS Utilities section contains a list of rules that perform certain actions when they are activated by SMS messages.
 
The SMS Utilities section contains a list of rules that perform certain actions when they are activated by SMS messages.
   −
[[Image:Networking_rutx_manual_mobile_utilities_sms_rules_v1.png|border| class=tlt-border|1102x1102px]]
+
[[Image:Networking_rutx_manual_mobile_utilities_sms_rules_v1.png|border]]
    
The entire list contains 17 rules but you are also be provided with the possibility to configure custom ones or edit the
 
The entire list contains 17 rules but you are also be provided with the possibility to configure custom ones or edit the
Line 19: Line 19:  
<li>Reboot</li>
 
<li>Reboot</li>
 
<li>Send_status</li>
 
<li>Send_status</li>
−
{{#ifeq:{{{name}}}|RUTXR1| |
+
{{#ifeq:{{{name}}}|RUTXR1||
 
<li>I/O set</li>
 
<li>I/O set</li>
 
<li>I/O status</li>
 
<li>I/O status</li>
Line 27: Line 27:  
<li>Wifi(off) </li>
 
<li>Wifi(off) </li>
 
}}
 
}}
−
{{#ifeq:{{{mobile}}}|1|
   
<li>Mobile (on)</li>
 
<li>Mobile (on)</li>
 
<li>Mobile (off)</li>
 
<li>Mobile (off)</li>
−
}}
   
<li>SSH_access (on)</li>
 
<li>SSH_access (on)</li>
 
<li>SSH_access (off)</li>
 
<li>SSH_access (off)</li>
Line 36: Line 34:  
<li>Web_access (off)</li>
 
<li>Web_access (off)</li>
 
<li>Firstboot</li>
 
<li>Firstboot</li>
−
{{#ifeq:{{{mobile}}}|1|
+
{{#ifeq:{{{name}}}|TRB14X||
 
<li>Switch SIM</li>
 
<li>Switch SIM</li>
 
}}
 
}}
−
{{#ifeq:{{{mobile}}}|1|*
+
{{#ifeq:{{{gps}}}|1|
 
<li>GPS coordinates</li>
 
<li>GPS coordinates</li>
 
<li>GPS (off)</li>
 
<li>GPS (off)</li>
Line 238: Line 236:  
         </td>
 
         </td>
 
</table>
 
</table>
−
      
====SSH access control====
 
====SSH access control====
Line 456: Line 453:  
         </td>
 
         </td>
 
</table>
 
</table>
 +
 +
    
====GPS control====
 
====GPS control====
Line 727: Line 726:  
<tr>
 
<tr>
 
         <td>Action</td>
 
         <td>Action</td>
−
         <td>The action to be performed when this rule is met/td>
+
         <td>The action to be performed when this rule is met</td>
 
         <td>Returns an SMS message containing information about the Input/Output status of the router</td>
 
         <td>Returns an SMS message containing information about the Input/Output status of the router</td>
 
</tr>
 
</tr>
Line 763: Line 762:  
<tr>
 
<tr>
 
         <td>Action</td>
 
         <td>Action</td>
−
         <td>The action to be performed when this rule is met/td>
+
         <td>The action to be performed when this rule is met</td>
 
         <td>Returns a text message containing information about remote monitoring status</td>
 
         <td>Returns a text message containing information about remote monitoring status</td>
 
</tr>
 
</tr>
Line 842: Line 841:  
         <td>State</td>
 
         <td>State</td>
 
         <td>The state to which mobile data will be set when this rule is met.</td>
 
         <td>The state to which mobile data will be set when this rule is met.</td>
−
         <td>If you set it as ON it will turn on mobile data if OFF it will turn it off.</td>
+
         <td>If you set it as ON it will turn on RMS functionality if OFF it will turn it off.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 863: Line 862:  
</table>
 
</table>
   −
====Get OpenVPN status====
+
====RMS status====
 
----
 
----
 
<table class="mw-collapsible mw-collapsed nd-mantable"style="width: 100%">
 
<table class="mw-collapsible mw-collapsed nd-mantable"style="width: 100%">
Line 873: Line 872:  
<tr>
 
<tr>
 
         <td>Enable</td>
 
         <td>Enable</td>
−
         <td>This check box will enable or disable the OpenVPN status function</td>
+
         <td>This check box will enable or disable the RMS action function</td>
−
         <td>Allows to get the router‘s OpenVPN status via SMS</td>
+
         <td>Allows you to manage RMS functionality via SMS</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
         <td>Action</td>
 
         <td>Action</td>
 
         <td>The action to be performed when this rule is met/td>
 
         <td>The action to be performed when this rule is met/td>
−
         <td>Returns an SMS message containing information about an OpenVPN instance's status</td>
+
         <td>
 +
  <tr>
 +
        <td>State</td>
 +
        <td>The state to which mobile data will be set when this rule is met.</td>
 +
        <td>If you set it as ON it will turn on RMS functionality if OFF it will turn it off.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
         <td>SMS text</td>
 
         <td>SMS text</td>
 
         <td>SMS text that will trigger the rule</td>
 
         <td>SMS text that will trigger the rule</td>
−
         <td>SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter; Default text: vpnstatus</td>
+
        <td>SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter
 +
Default text: rms_on</td>
 +
</tr>
 +
<tr>
 +
        <td>Authorization method</td>
 +
        <td>What kind of authorization to use for SIM management</td>
 +
        <td>Possible values: No authorization | By serial | By router admin password; Default: '''By router admin password'''
 +
        </td>
 +
</tr>
 +
<tr>
 +
        <td>Allowed users</td>
 +
        <td>White list of allowed users</td>
 +
        <td>Possible values: From all numbers | From group | From single number; Default: '''From all numbers'''
 +
        </td>
 +
</table>
 +
====Get OpenVPN status====
 +
----
 +
<table class="mw-collapsible mw-collapsed nd-mantable"style="width: 100%">
 +
<tr>
 +
        <th>FIELD NAME</th>
 +
        <th>DESCRIPTION</th>
 +
        <th>EXPLANATION, NOTES</th>
 +
</tr>
 +
<tr>
 +
        <td>Enable</td>
 +
        <td>This check box will enable or disable the OpenVPN status function</td>
 +
        <td>Allows to get the router‘s OpenVPN status via SMS</td>
 +
</tr>
 +
<tr>
 +
        <td>Action</td>
 +
        <td>The action to be performed when this rule is met/td>
 +
        <td>Returns an SMS message containing information about an OpenVPN instance's status</td>
 +
</tr>
 +
<tr>
 +
        <td>SMS text</td>
 +
        <td>SMS text that will trigger the rule</td>
 +
         <td>SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter; Default text: vpnstatus</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 898: Line 937:  
         </td>
 
         </td>
 
</table>
 
</table>
−
      
====Manage OpenVPN====
 
====Manage OpenVPN====
Line 974: Line 1,012:  
         </td>
 
         </td>
 
</table>
 
</table>
 +
 +
====Change profile====
 +
----
 +
{| class="wikitable"
 +
|+
 +
! style="width: 250px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |FIELD NAME
 +
! style="width: 500px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |DESCRIPTION
 +
! style="width: 950px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |EXPLANATION, NOTES
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Enable
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |This check box will enable or disable the Change profile function
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Allows changing profiles via SMS
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Action
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |The action to be performed when this rule is met.
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Changes the current profile to the one specified in the message
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |SMS text
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |SMS text that will trigger the rule
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter
 +
Default text '''pr'''
 +
 +
'''After the SMS text you have to write the Profile's name, e.g., "pr John"'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Authorization method
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |What kind of authorization to use for SIM management
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Possible values:
 +
No authorization | By serial | By router admin password; Default: '''By router admin password'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Allowed users
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |White list of allowed users
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Possible values:
 +
From all numbers | From group | From single number; Default: '''From all numbers'''
 +
|-
 +
|}
    
====More====
 
====More====
Line 1,011: Line 1,084:  
         </td>
 
         </td>
 
</table>
 
</table>
 +
 +
===Change mobile data settings (cellular) rule===
 +
----
 +
The Change mobile data settings rule is exceptional to most of the other rules as it does not perform a single action like turning specific services On/Off or getting status updates. It designed to change mobile data settings and it's '''SMS text''' can't be described by a single string because the message depends on what configurations you want to change. For example, you can send a message that will change your APN only, you can send a message that will change APN and mobile service mode, or even a message that will change every single mobile setting.
 +
 +
{| class="wikitable"
 +
|+ style="text-align: left;" |Change mobile data settings
 +
! style="width: 250px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |FIELD NAME
 +
! style="width: 500px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |DESCRIPTION
 +
! style="width: 950px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |EXPLANATION, NOTES
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Enable
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |This check box will enable or disable the Change mobile data settings function
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Allows you to change mobile settings via SMS
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Action
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |The action to be performed when this rule is met.
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Changes the specified mobile settings
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |SMS text
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |SMS text that will trigger the rule
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter
 +
Default: '''cellular'''
 +
 +
'''Detailed explanations on how to use this function are presented in the table below'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Authorization method
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |What kind of authorization to use for SIM management
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Possible values:
 +
No authorization | By serial | By router admin password; Default: '''By router admin password'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Allowed users
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |White list of allowed users
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Possible values:
 +
From all numbers | From group | From single number; Default: '''From all numbers'''
 +
|-
 +
|}
 +
 +
The default '''SMS text''' for the Change mobile data settings rule is '''cellular''' but it is only an indication text and does not include any specific parameters to be changed. The list of parameters that can be changed and explanations on how to incorporate them into the '''"cellular"''' message is presented in the table below.
 +
 +
{| class="wikitable"
 +
|+ style="text-align: left;" |Mobile Settings via SMS parameters
 +
! style="width: 250px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |PARAMETER
 +
! style="width: 500px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |VALUE
 +
! style="width: 500px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |DESCRIPTION
 +
! style="width: 500px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |DEFAULT MESSAGE EXAMPLE
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |apn=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |e.g., internet
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Sets APN
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular apn=internet.gprs'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |dialnumber=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |e.g., *99***1#
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Sets Dialing number
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular dialnumber=*99***1#'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |auth_mode=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |<nowiki>none | pap | chap</nowiki>
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Sets Authentication method
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular auth_method=pap'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |service=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" <nowiki> |3gonly | 4gonly | auto</nowiki>
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Sets the mobile Service mode
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular service=auto'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |username=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |e.g., user
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Sets the user name for PAP or CHAP authentication
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular username=user'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |password=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |e.g., pass
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Sets the password for PAP or CHAP authentication
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular password=pass'''
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |roaming=
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''0''' for OFF; '''1''' for ON
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |Turn Mobile data roaming ON or OFF
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" |'''cellular roaming=0'''
 +
|-
 +
|}
 +
 +
Each of the above examples contain a single parameter but you can send out multiple parameters in one message. For example, '''"cellular apn=internet.gprs service=3gonly"'''. This message would set your APN to "internet.gprs" and your Service mode to 3G Only. You can also send a message that would include all of the parameters above: '''"cellular apn=internet.gprs dialnumber=*99***1# auth_mode=pap service=3gonly username=user password=pass"'''
      Line 1,485: Line 1,643:     
<b>Important note</b>: all POP3 server email messages from inbox will be deleted when using this service.
 
<b>Important note</b>: all POP3 server email messages from inbox will be deleted when using this service.
−
 
+
{{#ifeq:{{{name}}}| RUTX12 |
−
[[File:Networking_rutos_manual_mobile_utilties_email_to_sms_v1.png]]
+
[[File:Networking_rut12_manual_mobile_utilties_email_to_sms_v1.png|border|class=tlt-border]]
−
[[File:Networking_rut12_manual_mobile_utilties_email_to_sms_v1.png]]
+
|
 +
[[File:Networking_rutos_manual_mobile_utilties_email_to_sms_v1.png|border|class=tlt-border]]
 +
}}
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/62592"