Jump to content
  • EN

Template:Networking rutos manual mobile utilities: Difference between revisions

← Older editNewer edit →
VisualWikitext
No edit summary
No edit summary
Line 211: Line 211:
===Modify SMS Rule===
===Modify SMS Rule===
----
----
Every SMS rule can be edited to your liking. If a rule does not meet your requirements, click the click the 'Edit' button next to it. Below are examples of what the configuration page for the <i>reboot</i> rule looks like.
Every SMS rule can be edited to your liking. To begin configuring a rule, click the click the 'Edit' button located next to it:
 
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_edit_button.png|border|class=tlt-border]]
 
After this you should redirected to configuration page for that rule. Below are examples of what the configuration page for the <i>reboot</i> rule looks like.


<b>General settings</b>
<b>General settings</b>
Line 237: Line 241:
Most rules are configured in a similar manner. However, the configuration does differ from rule to rule, depending on a rule's purpose (selected 'Action'). If you run into trouble when configuring a rule, hover your mouse cursor over the name of a field to see a hint that explains what that field does.
Most rules are configured in a similar manner. However, the configuration does differ from rule to rule, depending on a rule's purpose (selected 'Action'). If you run into trouble when configuring a rule, hover your mouse cursor over the name of a field to see a hint that explains what that field does.


===Change mobile data settings (cellular) rule===
===Change mobile 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.
The <b>Change mobile settings</b> rule is used to change the configuration settings of the mobile data connection. The usage of this rule is a bit more complex because the SMS text in and of itself does nothing, as you must also specify the parameters and values that you wish to set. For example, you can send a message that will change your APN only or a message that will change multiple parameters at once.


<table class="nd-mantable">
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_cellular_dualsim_{{{dualsim}}}.png|border|class=tlt-border]]
    <tr>
        <th>Field</th>
        <th>Description</th>
        <th>Explanation</th>
    </tr>
    <tr>
        <td>Enable</td>
        <td>This check box will enable or disable the Change mobile data settings function</td>
        <td>Allows you to change mobile settings via SMS</td>
    </tr>
    <tr>
        <td>Action</td>
        <td>The action to be performed when this rule is met.</td>
        <td>Changes the specified mobile settings</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: '''cellular'''. '''Detailed explanations on how to use this function are presented in the table below'''</td>
    </tr>
    <tr>
        <td>Authorization method</td>
        <td>What kind of authorization to use for SIM management</td>
        <td>Possible values:
        <li>No authorization</li>
        <li>By serial</li>
        <li>By router admin password; default: '''By router admin password'''</li>
        </td>
    </tr>
    <tr>
        <td>Allowed users</td>
        <td>White list of allowed users</td>
        <td>Possible values:
        <li>From all numbers</li>
        <li>From group</li>
        <li>From single number; default: '''From all numbers'''</li>
        </td>
    </tr>
</table>


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.  
Below is the full list of parameters that can be changed with this rule.


<table class="nd-mantable" >
<table class="nd-othertables_2" style="width: 100%;">
     <tr>
     <tr>
         <th>Parameter</th>
         <th width=20%>Parameter</th>
         <th>Value</th>
         <th width=50%>Description</th>
        <th>Description</th>
         <th width=30%>SMS text example</th>
         <th>Default message example</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>apn=</td>
         <td><b>apn=</b></td>
        <td>e.g., internet</td>
         <td>Sets APN</td>
         <td>Sets APN</td>
         <td>'''cellular apn=internet'''</td>
         <td><i>cellular apn=internet</i></td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>dialnumber=</td>
         <td><b>dialnumber=</b></td>
         <td>e.g., *99***1#</td>
         <td>e.g., *99***1#</td>
         <td>Sets Dialing number</td>
         <td>Sets Dialing number</td>
         <td>'''cellular dialnumber=*99***1#'''</td>
         <td><i>cellular dialnumber=*99***1#</i></td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>auth_mode=</td>
         <td><b>auth_mode=</b></td>
         <td>
         <td>Sets the authentication method. Possible values are:
        <li>none</li>
            <ul>
        <li>pap</li>
                <li><i>none</i></li>
        <li>chap</li>
                <li><i>pap</i></li>
                <li><i>chap</i></li>
            </ul>
         </td>
         </td>
         <td>Sets Authentication method</td>
         <td><i>cellular auth_method=pap</i></td>
        <td>'''cellular auth_method=pap'''</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>service=</td>
         <td><b>service=</b></td>
         <td>
         <td>Sets the service mode. Possible values are:
        <li>3gonly</li>
            <ul>
        <li>4gonly</li>
                <li>3gonly</li>
        <li>auto</li>
                <li>4gonly</li>
                <li>auto</li>
            </ul>
         </td>
         </td>
         <td>Sets the mobile Service mode</td>
         <td><i>cellular service=auto</i></td>
        <td>'''cellular service=auto'''</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>username=</td>
         <td><b>username=</b></td>
        <td>e.g., user</td>
         <td>Sets the user name for PAP or CHAP authentication.</td>
         <td>Sets the user name for PAP or CHAP authentication</td>
         <td><i>cellular username=user</i></td>
         <td>'''cellular username=user'''</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>password=  
         <td><b>password=</b></td>
        <td>e.g., pass</td>
         <td>Sets the password for PAP or CHAP authentication.</td>
         <td>Sets the password for PAP or CHAP authentication</td>
         <td><i>cellular password=pass</i></td>
         <td>'''cellular password=pass'''</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>roaming=</td>
         <td><b>roaming=</b></td>
         <td>'''0''' for OFF; '''1''' for ON</td>
         <td>Turns mobile data roaming on or off.  Possible values are:
        <td>Turn Mobile data roaming ON or OFF</td>
            <ul>
         <td>'''cellular roaming=0'''</td>
                <li><i>0</i> - for off.</li>
                <li><i>1</i> - for on.</li>
            </ul>
        </td>
         <td><i>cellular roaming=0</i></td>
     </tr>
     </tr>
</table>
</table>


Each of the above examples contain a single parameter but you can send out multiple parameters in one message. For example, '''"cellular apn=internet service=3gonly"'''. This message would set your APN to "internet" and your Service mode to 3G Only. You can also send a message that would include all of the parameters above: '''"cellular apn=internet dialnumber=*99***1# auth_mode=pap service=3gonly username=user password=pass"'''
Each example above contains a single parameter but you can also send out multiple parameters in one message. For example:
 
cellular apn=internet service=3gonly
 
This message would set your APN to "internet" and the service mode of the mobile connection to "3G Only". You can also send a message that would include all of the parameters above:
 
cellular apn=internet dialnumber=*99***1# auth_mode=pap service=3gonly username=user password=pass roaming=0


===UCI API rule===
===UCI API rule===
----
----
The <b>UCI API</b> rule lets you set or get any parameter from the router's configuration files.
The <b>UCI API</b> rule is used to configure any parameters on the device. The following are syntax examples for the UCI API rule:


<table class="nd-mantable">
<table class="nd-othertables_2" style="width: 100%;">
     <tr>
     <tr>
         <th>Field</th>
         <th width=25%>Example structure</th>
         <th>Description</th>
         <th width=25%>Description</th>
         <th>Explanation, notes</th>
         <th width=50%>Example SMS text</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Enable</td>
         <td>uci <b>get</b> <config>.<section>.<option_name></td>
         <td>This will enable or disable the UCI API function</td>
         <td>Returns the value of a single configuration option.</td>
         <td>Allows you to set or get any configurations from the router</td>
         <td><i>uci get network.wan.ipaddr</i> - returns the router's WAN IP address.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Action</td>
         <td>uci <b>set</b> <config>.<section>.<option_name>="value"</td>
         <td>The action to be performed when this rule is met.</td>
         <td>Sets the value of a specified configuration option.</td>
         <td>Sets or sends you any specified configurations of the router</td>
         <td><i>uci set network.mobile.apn=example</i> - changes mobile APN value to "example".</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>SMS text</td>
         <td>uci <b>show</b> <config></td>
         <td>SMS text that will trigger the rule</td>
         <td>Returns the contents of a config file</td>
         <td>SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter'''Detailed explanations on how to use this function are presented in the table below'''</td>
         <td><i>uci show openvpn</i> - returns the contents of the "openvpn" config file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Modem</td>
         <td>uci <b>show</b> <config>.<section></td>
         <td>Select which modem you want to use</td>
         <td>Returns the exact part (section) of a config file.</td>
         <td>Which modem is configured</td>
         <td><i>uci show network.lan</i> - returns the configuration of the "lan" section from the "network" config file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Authorization method</td>
         <td>uci <b>delete</b> <config>.<section></td>
        <td>What kind of authorization to use for SIM management</td>
         <td>Deletes the specified section in a configuration file. To avoid operation issues, please use this command to delete optional configuration sections only (not mandatory ones).</td>
        <td>Possible values: No authorization | By serial | By router admin password; default: '''By router admin password'''</td>
         <td><i>uci delete network.lan4</i> - deletes a network interface called "lan4".</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>
 
The following are syntax examples for the UCI API rule:
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
        <th>Description</th>
        <th>Explanation, notes</th>
    </tr>
    <tr>
        <td>uci get config.section.option"</td>
         <td>Returns config option value</td>
        <td>'''uci get network.wan.ipaddr''' - returns the router's WAN IP address</td>
    </tr>
    <tr>
        <td>uci set config.section.option="value"</td>
        <td>Sets config option</td>
        <td>'''"uci set network.mobile.apn=example"''' - Changes mobile APN to example</td>
    </tr>
    <tr>
        <td>uci show config</td>
        <td>Returns the contents of a config file</td>
        <td>'''uci show openvpn''' - returns the contents of the openvpn config file</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>uci show config.section</td>
         <td>uci <b>delete</b> <config>.<section>.<option_name></td>
         <td>Returns the exact part of a config file (either section or the exact option value)</td>
         <td>Deletes the specified configuration option. To avoid operation issues, please use this command to delete optional configuration options only (not mandatory ones).</td>
         <td>'''uci show network.ppp''' - returns the contents of the ppp interface section from the network config file</td>
         <td><i>uci delete dhcp.lan.force</i> - deletes the "force" option for DHCP server of the "lan" interface (which in turn disables the "Force DHCP" function of that DHCP server).</td>
     </tr>
     </tr>
</table>
</table>
Retrieved from "https://wiki.teltonika-networks.com/view/Template:Networking_rutos_manual_mobile_utilities"