Template:Networking rutos manual mobile utilities: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
Line 1,008: Line 1,008:
</table>
</table>


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

Revision as of 09:13, 19 December 2022

Template:Networking rutos manual fw disclosure


Summary

The Mobile Utilities page is used to configure various SMS and Call related device control options and to read, send and manage SMS messages and SMS storage space.

This manual page provides an overview of the Mobile Utilities page in {{{name}}} devices.

SMS Utilities

The SMS Utilities section contains a list of rules that perform certain actions when they are activated by SMS messages.

The entire list contains more than 20 rules, but it does not include all possible SMS actions. You can also create custom rules or modify existing rules. All possible SMS rule actions, their default SMS texts and descriptions are listed in the table below.

Action SMS Text Description
Change mobile settings cellular Is used to configure the device's mobile data connection. Click here for more information on this rule.
Change profile no default text Is used to change profiles on the device. Include the name of the profile that you wish to change to after the rule's SMS text, for example if SMS text is set to changeprof:
  • changeprof default
  • changeprof custom
Execute custom script - Executes a custom shell script.
FW upgrade from server fw_upgrade Upgrades the device's firmware (provided a new version is available on the FOTA server).
Get list of profiles profdisp Sends a list of configuration profiles existing on the device.
IP unblock ipunblock Unblocks Web/SSH access for devices that were blocked for too many unsuccessful connection attempts. Send the SMS text to unblock all blocked devices or include the IP address of a single blocked device after the SMS text. For example:
  • ipunblock - clears the block list (unblocks Web/SSH access for all previously blocked devices).
  • ipunblock 192.168.1.2 - removes this IP address from the block list (unblocks Web/SSH access for that device).
Manage OpenVPN vpnon Turns a selected OpenVPN instance on. Include the name of the OpenVPN instance that you wish to turn on after the rule's SMS text:
  • vpnon client_name
  • vpnon server_name
Manage OpenVPN vpnoff Turns a selected OpenVPN instance off. Include the name of the OpenVPN instance that you wish to turn off after the rule's SMS text:
  • vpnoff client_name
  • vpnoff server_name
Mobile Data limit status no default text Sends a status report message that includes data limit usage information for mobile network interfaces (that have [[{{{name}}}_Interfaces#Mobile_Data_Limit|Mobile Data Limit]] enabled)
Mobile Data usage reset no default text Resets mobile data usage for specified interface.
Monitoring status monitoring_status Sends a status report message that includes the RMS connection type, state and the device serial number and MAC address.
More more Displays next part of a composite response message (more than 160 characters).
OpenVPN status vpnstatus Sends a status report message on all OpenVPN connections.
Reboot reboot Reboots the device.
Restore to default restore Restores factory settings on the device.
RMS action rms_on Turns RMS connection on.
RMS action rms_off Turns RMS connection off.
RMS connect rms_connect Forces the device to connect to RMS. This action is analogous to clicking the 'Connect' button in the Cloud Solutions → [[{{{name}}}_Cloud_Solutions#RMS|RMS page]].
RMS status rms_status Sends a status report message on the state of the connection to RMS.
Send status status Sends a status report message.
SSH access control sshon Turns remote and local (by default) SSH access on. This rule can be modified to only include local SSH access.
SSH access control sshoff Turns SSH access off.
Switch mobile data mobileon Turns mobile data usage on.
Switch mobile data mobileoff Turns mobile data usage off.
UCI API uci Is used to change the configuration settings on the device. Click here for more information on the UCI API rule.
Restore to user's defaults userdefaults Restores user's default configuration on the device. [[{{{name}}}_Backup#Create_default_configuration|Click here]] for more information on User's default configuration.
Wake on LAN wakeup Sends a magic packet that "wakes up" a specified device from standby mode. If you have multiple Wake-on-LAN-capable devices, you will have to create a separate rule with a different SMS text for each one. Configuration for each device must include the MAC address of that device.
Web access control webon Turns remote and local (by default) HTTP and HTTPS access on. This rule can be modified to only include local HTTP/HTTPS access.
Web access control weboff Turns HTTP and HTTPS access off. This rule can also modified to turn of either HTTP or HTTPS separately.

SMS rule execution syntax

To execute an SMS rule, send an SMS message to your device's SIM card number with the rule's SMS Text preceded by the selected authorization keyword, which depends on the selected authorization method:

  • No authorization - no special keyword required; simply send a rule's SMS Text. For example, to execute the reboot rule without authorization:
    reboot
  • By serial - include the device's serial number before a rule's SMS Text. For example, to execute the iostatus rule with serial authorization:
    1111111111 iostatus
    (replace 1111111111 with your device's serial number)
  • By device admin password - include the device's password before a rule's SMS Text. For example, to execute the vpnon rule with password authorization:
    admin01 vpnon
    (replace admin01 with your device's admin password)

Modify SMS Rule

Every SMS rule can be edited to your liking. To begin configuring a rule, click the click the 'Edit' button located next to it:

After this you should redirected to configuration page for that rule. Below are examples of what the configuration page for the reboot rule looks like.

General settings

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_general_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

  1. The Enable slider turn the rule on or off. In order to use a rule, this slider must be set to 'on'. By default, all existing SMS rules are turned on.
  2. The Action dropdown selection specifies which action should be performed when the rule is executed.
  3. The SMS text field specifies the text that will trigger the rule upon receiving a message.
  4. The Get status via SMS after reboot slider specifies whether the device should send a status report message after an action is executed. The name of this slider may differ from rule to rule and it is only available for some rules.
  5. The Message forwarding slider specifies whether the device should send a status report message to another number (besides the original sender). Setting this slider to 'on' will prompt you to enter an additional phone number(s) of the status message recipient(s).
  6. The Text messagetext box is used to modify the text that should be included in an SMS rule's response message.

Authorization

  1. The Authorization method dropdown selection specifies the type of authorization an SMS rule requires (device admin password, serial number or none).
  2. The Allowed number(s) dropdown selection specifies who can execute an SMS rule (based on phone number).

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 settings (cellular) rule

The Change mobile settings 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.

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_cellular_dualsim_{{{dualsim}}}_{{{dualmodem}}}.png|border|class=tlt-border]]

Below is the full list of parameters that can be changed with this rule.

Parameter Description SMS text example
apn= Sets APN. cellular apn=internet
auto_apn= Turns auto APN on or off. Possible values are 0/1. cellular auto_apn=1
dialnumber= Sets Dialing number. cellular dialnumber=*99***1#
auth_mode= Sets the authentication method. Possible values are:
  • none
  • pap
  • chap
 cellular auth_method=pap
service= Sets the service mode. Possible values are:
  • mixture of any two modes (ex.: 3g_lte)
  • auto
 cellular service=auto
username= Sets the user name for PAP or CHAP authentication. cellular username=user
password= Sets the password for PAP or CHAP authentication. cellular password=pass
roaming= Turns mobile data roaming on or off. Possible values are:
  • 0 - for off.
  • 1 - for on.
 cellular roaming=0

Each example above contains a single parameter but you can also send out multiple parameters in one message. For example: 

cellular apn=internet service=3g

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 auth_mode=pap service=3g username=user password=pass roaming=0

Note: only "apn=" or "auto_apn=" is required in a message. For example, to set custom APN: 

cellular apn=internet

or if you want to turn auto APN on: 

cellular auto_apn=1

UCI API rule

The UCI API rule is used to configure any parameters on the device.

The following are syntax examples for the UCI API rule:

Structure example Description SMS text example
uci get <config>.<section>.<option_name> Returns the value of a single configuration option.
  • uci get network.wan.ipaddr
    • Returns the router's WAN IP address.
    uci set <config>.<section>.<option_name>="value" Sets the value of a specified configuration option.
  • uci set network.mobile.apn=example
    • Changes mobile APN value to "example".
    uci show <config> Returns the contents of a config file
  • uci show openvpn
    • Returns the contents of the "openvpn" config file.
    uci show <config>.<section> Returns the exact part (section) of a config file.
  • uci show network.lan
    • Returns the configuration of the "lan" section from the "network" config file.

    The UCI rule requires that you know the names of the configuration files and sections and parameters contained within them. You can find the config file list and some examples of the UCI system usage in our UCI command usage article.

    Disclaimer: do not enclose values in escape characters like you would when executing UCI commands via CLI. For example: uci set network.mobile.apn="example" will cause an error in SMS API and your value will be altered, as a result, UCI commands execution will fail. Instead, simply write uci set network.mobile.apn=example without any escape characters or quotes.

    Custom Rules

    If none of the default rules suit your purposes, you can also configure custom ones. To do so, scroll down to the very bottom of the SMS Utilities page, where you will find the Add Rule section. Enter a custom SMS text, select an Action and click the 'Add' button:

    SMS Gateway

    This section provides a summary of the SMS Gateway functions for {{{name}}} devices.

    Post/Get

    Post/Get allows you to perform action requests by writing them in the URL after your device’s IP address.

    [[File:Networking_rutos_manual_mobile_utilities_sms_gateway_post_get_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

    Field Value Description
    Enable off | on; default: off Enable SMS management functionality through POST/GET
    Access mobile_data | sms_delete | sms_list | sms_read | sms_send | sms_total; default: mobile_data, sms_delete, sms_list, sms_read, sms_send, sms_total Methods available for Post/Get. All methods are allowed if this list is left empty.
    User name default: user1 User name used for authorization (5 characters minimum). Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )
    Password default: user_pass Password used for authorization (5 characters minimum). Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )

    Use a web browser or any other compatible software to send HTTP post/get strings to the router. The router must be connected to a GSM network when using the Send SMS feature. Below you will find a table with possible actions and examples on how to use them:

    Action Post/get URL examples
    View mobile messages list http://192.168.1.1/cgi-bin/sms_list?username=user1&password=user_pass
    Read mobile message http://192.168.1.1/cgi-bin/sms_read?username=user1&password=user_pass&number=1
    Send mobile message to a single number http://192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage
    Send mobile message to a group http://192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&group=group_name&text=testmessage
    View mobile messages total http://192.168.1.1/cgi-bin/sms_total?username=user1&password=user_pass
    Delete mobile message http://192.168.1.1/cgi-bin/sms_delete?username=user1&password=user_pass&number=1
    • 192.168.1.1 - router's IP address. (Replace it with your [[{{{name}}}_LAN#General_Setup|LAN IP]] or [[{{{name}}}_WAN#Operation_Modes|WAN IP]] (when connecting remotely))
    • SMS related post/get commands. Possible values are:
      • sms_list - view all SMS messages in storage
      • sms_read - read a single SMS message by specified SMS index (number)
      • sms_send - send an SMS message to specified recipient
      • sms_total - display SMS storage statistics
      • sms_delete - delete a single SMS message by specified SMS index (number)
    • & - separation symbol. After specifying the SMS command, other parameters must be separated by an ampersand (&) symbol
    • username - SMS post/get configuration user name
    • password - SMS post/get configuration password
    • number - SMS message index or (depending on context) recipient's phone number. SMS message indexes can be viewed with the sms_list command.
      Correct phone number format is:
      • 00 - number must be preceded by two zeros
      • <country_code> - the next following element is the number holder's country code
      • <receivers_number> - phone number of the recipient
             For example, a valid number would be 0037012345678 (370 is country code and 12345678 is the receiver's
       phone number, all preceded by 00)
    • text - SMS message text

    To use Post/Get via SSH instead of a browser, you may want to use the curl -X command. Simply add the same URL command in between quotes and specify the HTTP method.

    Examples:

    • View SMS list:
      curl -X GET "http://192.168.1.1/cgi-bin/sms_list?username=user1&password=user_pass"
    • Send SMS:
      curl -X GET "http://192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&number=0037000000000&text=testmessage"

    Auto Reply

    Auto reply allows you to configure automatic replying to SMS messages that the router receives.

    [[File:Networking_rutos_manual_mobile_utilities_sms_gateway_auto_reply_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

    Field Value Description
    Enable off | on; default: off Toggles Auto Reply ON or OFF
    Reply SMS-Utilities rules off | on; default: off It will reply to sms rules, from SMS-Utilities
    Don't save received messages off | on; default: off If enabled, the router will delete received SMS messages
    Mode default: Everyone Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options:
  • Everyone
  • Listed numbers
  • From user group
    		•
    Message text default: none The message that will be sent in reply

    SMS Forwarding

    This section is a summary of the SMS Forwarding function in {{{name}}} routers.

    SMS Forwarding To HTTP

    The SMS Forwarding To HTTP functionality forwards SMS messages to HTTP, using either POST or GET methods.

    Field Value Description
    Enable off | on; default: off Enable/disable SMS forwarding to HTTP
    Forward SMS-Utilities rules off | on; default: off Enable/disable sms-utilities rules forwarding
    Don't save received message off | on; default: off Select whether you want to save forwarded messages or not
    Include sender's number off | on; default: off Enable/disable adding original message sender phone number at the end of message text
    HTTPS certificate verification default: Ignore Select whether to ignore or verify server certificate. Available options:
  • Ignore
  • Verify
    		•
    Method default: Get Choose witch HTTP request method will be used. Available options:
  • Get
  • Post
    		•
    URL default: none URL to which message is going to be forwarded
    Number value name default: none Sender phone number code name for query string name/value pair
    Message value name default: none Message code name for query string name/value pair
    Extra data pair 1 default: none Extra html query name/value pair. Enter name to the left field and value to right
    Extra data pair 2 default: none Extra html query name/value pair. Enter name to the left field and value to right
    Mode default: All messages Choose which messages are going to be forwarded. Available options:
  • All messages
  • From listed numbers
  • From user group

    • SMS Forwarding To SMS

    The SMS Forwarding To SMS function forwards SMS messages to one or several recipients.

    [[File:Networking_rutos_manual_mobile_utilities_sms_gateway_sms_forwarding_to_sms_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

    Field Value Description
    Enable off | on; default: off Enables/disables SMS forwarding to SMS
    Forward SMS-Utilities rules off | on; default: off Enable/disable sms-utilities rules forwarding
    Don't save received message off | on; default: off Select whether you want to save forwarded messages or not
    Add sender's number off | on; default: off Enable/disable adding original message sender phone number at the end of message text. Only added if total message length is up to 480 characters
    Mode default: All messages Choose which messages are going to be forwarded. Available options:
  • All messages
  • From listed numbers
  • From user group
    • Recipients phone numbers default: none Number(s) to which received messages will be forwarded to

    SMS Forwarding To Email

    The SMS Forwarding To Email function forwards SMS messages to email.

    Field Value Description
    Enable off | on; default: off Enables/disables SMS forwarding to Email
    Forward SMS-Utilities rules off | on; default: off Enables/disables sms-utilities rules forwarding
    Don't save received message off | on; default: off Select whether you want to save forwarded messages or not
    Add sender's number off | on; default: off Enable/disable adding sender phone number at the end of email text body
    Subject default: none Subject of an email. Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )
    Email group default: none Sender's email configuration
    Recipient's email address default: none For whom you want to send an email to. Allowed characters (a-zA-Z0-9._%+-)
    Mode default: All messages Choose which messages are going to be forwarded. Available options:
  • All messages
  • From listed numbers
  • From user group

    • Email To SMS Forwarding

    Email to SMS Forwarding is a function that connects to your email account and checks its inbox at the specified frequency. If it finds any new received emails with a specific subject (phone number in email subject), it sends the body of the email as an SMS message(s) to the recipient specified in the email subject field.

    Important note: all POP3 server email messages from inbox will be deleted when using this service.

    [[File:Networking_rutos_manual_mobile_utilities_sms_gateway_email_to_sms_forwarding_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

    Field Value Description
    Enable off | on; default: off Turns Email to SMS Forwarding ON or OFF
    POP3 server host | ip; default: none Email service provider's POP3 server address (can be looked up online)
    Server port integer [0..65535]; default: none Email service provider's POP3 server port (can be looked up online)
    User name string; default: none Email account user name. This is information is used by router in order to atuhenticate itself when connecting to the email client
    Password string; default: none Email account password. This is information is used by router in order to atuhenticate itself when connecting to the email client
    Secure connection (SSL) yes | no; default: no SSL is a protocol for transmitting private documents via the Internet. SSL uses a cryptographic system that uses two keys to encrypt data − a public key known to everyone and a private or secret key known only to the recipient of the message
    SMS limit integer; default: 5 Limit of SMS count that can be contained in the email body of text, SMS length is limited to 160 seven-bit characters. Emails that contain more symbols than it is specified in this field will not be sent as SMS messages
    Check email every time; default: 1 minute Email inbox check interval
    Interval Minutes | Hours| Days; default: Minutes Email inbox check interval

    Additional note: you may have noticed that there is no option where you can specify the recipient's phone number. As mentioned earlier, Email to SMS doesn't forward all emails, only the ones that are meant to be forwarded. Only emails with the recipient's phone number in the subject will be forwarded to SMS

    Correct phone number format is:

    • 00 - number must be preceded by two zeros
    • <country_code> - the next following element is the number holder's country code
    • <receivers_number> - phone number of the recipient

    For example, a valid number would be 0037012345678 (370 is country code and 12345678 is the receiver's phone number, all preceded by 00)

    SMPP

    Short Message Peer-to-Peer (SMPP) is a protocol used for exchanging SMS messages between Short Message Service Centers (SMSC) and/or External Short Messaging Entities (ESME). The figure below is an example of the SMPP section and the table below provides information on the configuration fields contained in that section:

    [[File:Networking_rutos_manual_mobile_utilities_sms_gateway_smpp_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

    Field Value Description
    Enable off | on; default: off Turns SMPP on or off.
    User name string; default: admin User name used for authentication on the SMPP server.
    Password string; default: admin01 Password used for authentication on the SMPP server.
    Server port integer [0..65535]; default: 2775 SMPP server port.

    Call Utilities

    Just like SMS Utilities, Call Utilities provide you with the possibility to issue certain commands to the router from your mobile phone. The list of possible rules is of course shorter because you can only make one type of call. Keep that in mind when creating Call Utilities rules because one call will trigger all of the enabled rules at once.


    Call Rules

    To create a new rule, select an 'Action' and click the 'Add' button. After this, a new configuration window should appear.

    Incoming Calls

    This option specifies the action to be performed on incoming calls. Call utilities rules will keep getting executed while the call is active.

    Messages

    With the help of the Messages window you can read and send SMS messages.

    Read Messages

    In the Read Messages section you can read and delete received/stored SMS messages. The layout is simple, there is a list of received SMS messages and you can choose how many entries of that list should be visible at one time with SMS per page drop box in the top left corner of the page and there is a Search field to help you navigate more efficiently through the list of messages in the top right corner of the page.

    [[File:Networking_rutos_manual_mobile_utilities_messages_read_messages_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

    Send Messages

    The Send Messages section lets you send SMS messages from the router‘s SIM card.

    [[File:Networking_rutos_manual_mobile_utilities_messages_send_messages_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

    All you have to do is enter the recipient’s phone number, type in your message and hit the Send button.

    Storage

    In the Storage tab you can find settings associated with message storage.

    [[File:Networking_rutos_manual_mobile_utilities_messages_storage_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

    Field Value Description
    Save messages to SIM card | Modem storage; default: SIM card Specify location where to save messages
    Memory - Information about used/available SIM card memory
    Leave free space integer; default: 5 How much memory (number of messages) should be left free

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

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