Gsmctl commands

Introduction

gsmctl is an SSH command used to communicate with a RUTxxx router's modem. In other words, gsmctl relays AT commands (a set of instructions used to control a modem) to the router's modem; thus, providing the user with a way to control and obtain information from the modem via SSH. This can be used to either obtain certain modem related variables (signal strength, operator, connection state, etc.) or to execute certain actions (sending SMS messages, changing the frequency band, etc.).

This article provides a complete overview on gsmctl commands available in RUTxxx routers.

Prerequisites

gsmctl commands can be used on all RUTxxx routers via any type of command line interface (CLI) supported by the router. So all you need is:

• a RUTxxx router
• knowledge on how to login via a command line interface

gsmctl options

gsmctl commands are used in tandem with various options that specify what type of action should be executed.

---

Example structure

Individual options are described in separate subsections of this article. To find the information you are looking for faster, refer to the table of contents at the top of the page or use your browser's "Find in page" feature (Control + F).

Each option is presented with its usage syntax and an example command. For easier differentiation of the different elements that make up the examples, different colors are used:

• options are highlighted in blue
• responses are highlighted in red
• additional parameters are highlighted in purple

---

Two execution methods

Each option can be executed in two distinct ways. One is shorter, the other is longer and more descriptive. For example, to obtain the modem's IMEI you can either use:

• short version: gsmctl -i
• long version: gsmctl --imei

In both cases, enter the desired command and press the "Enter" key on your keyboard to execute that command. The response will be printed out as a standard output (stdout) string in your terminal.

---

Combined options

Multiple options can be combined together to obtain more than one parameter at a time. For example, to obtain the name of the operator used, signal strength and connection type with one command you can use one of the following:

• short version: gsmctl -oqt
• long version: gsmctl --operator --signal --conntype

Note that in the shorter version multiple options can be used together with one hyphen (-) symbol with no spacing, while in the longer version different options must be separated by spaces and before each option a double hyphen (--) is required.

Basic options

This subsection overviews basic gsmctl options, usually related to obtaining certain modem related information.

Get IP address of logical interface

---

To obtain the IP address of a network interface, use -p or --ip options.

Usage syntax:

gsmctl -p, --ip <INTERFACE>

Where <INTERFACE> is the name of a network interface.

Example: obtaining the IP address of the mobile connection interface:

root@Teltonika:~# gsmctl -p wwan0
10.139.75.221

Where wwan0 is the name of the mobile interface when the connection type is set to QMI (default). You can use the ifconfig command to check the names of existing network interfaces.

Possible responses:

• IP address (32-bit numeric address written as four numbers separated by periods)

Get number of bytes sent

---

To obtain the number of bytes sent (TX bytes) by a network interface, use -e or --bsent options.

Usage syntax:

gsmctl -i, --bsent <INTERFACE>

Where <INTERFACE> is the name of a network interface.

Example: obtaining the number of bytes sent (TX bytes) by the mobile connection interface:

root@Teltonika:~# gsmctl -e wwan0
36335

Where wwan0 is the name of the mobile interface when the connection type is set to QMI (default). You can use the ifconfig command to check the names of existing network interfaces.

Possible responses:

• An integer number representing bytes (not bits) sent

Get number of bytes received

---

To obtain the number of bytes received (RX bytes) by a network interface, use -r or --brecv options.

Usage syntax:

gsmctl -b, --brecv <INTERFACE>

Where <INTERFACE> is the name of a network interface.

Example: obtaining the number of bytes received (RX bytes) by the mobile connection interface:

root@Teltonika:~# gsmctl -r wwan0
92551

Where wwan0 is the name of the mobile interface when the connection type is set to QMI (default). You can use the ifconfig command to check the names of existing network interfaces.

Possible responses:

• An integer number representing bytes (not bits) received

Get network connection state

---

To obtain the network connection state, use -j or --connstate options.

Usage syntax:

gsmctl -j, --connstate

Example: obtaining the current network connection state:

root@Teltonika:~# gsmctl -j
connected

Possible responses:

• connected
• disconnected

Get network link state

---

To obtain the registration state of the mobile network, use -g or --netstate options.

Usage syntax:

gsmctl -g, --netstate

Example: obtaining the registration state of the mobile network:

root@Teltonika:~# gsmctl -g
registered (home)

Possible responses:

• registered (home)
• registered (roaming)
• unregistered
• searching
• unknown

Get device IMEI

---

To obtain the modem's International Mobile Equipment Identity (IMEI), use -i or --imei options.

Usage syntax:

gsmctl -i, --imei

Example: obtaining the modem's IMEI:

root@Teltonika:~# gsmctl -i
990000862471854

Possible responses:

• a 15 digit sequence of decimal numbers

Get SIM ICCID

---

To obtain the Integrated Circuit Card Identifier (ICCID) of the SIM card that is currently in use, use -J or --iccid options.

Usage syntax:

gsmctl -J, --iccid

Example: obtaining the ICCID of the SIM card in use:

root@Teltonika:~# gsmctl -J
89310410106543789301

Possible responses:

• a 19 or 20 digit sequence of decimal numbers

Get device model

---

To obtain the modem's model name, use -m or --model options.

Usage syntax:

gsmctl -m, --model

Example: obtaining the modem's model name

root@Teltonika:~# gsmctl -m
model_name

Possible responses:

• a string of letters and digits representing the model name

Get device manufacturer

---

To obtain the modem's manufacturer's name, use -w or --manuf options.

Usage syntax:

gsmctl -w, --manuf

Example: obtaining the modem's manufacturer's name:

root@Teltonika:~# gsmctl -w
manufacturers_name

Possible responses:

• a string of letters and digits representing the manufacturer's name

Get device serial number

---

To obtain the modem's serial number, use -a or --serial options.

Usage syntax:

gsmctl -a, --serial

Example: obtaining the modem's serial number:

root@Teltonika:~# gsmctl -a
990000862471854

Possible responses:

• a 15 digit sequence of decimal numbers

Get device revision number

---

To obtain the modem's revision number (firmware version), use -y or --revision options.

Usage syntax:

gsmctl -y, --revision

Example: obtaining the modem's revision number:

root@Teltonika:~# gsmctl -i
EC25EFAR02A08M4G

Possible responses:

• a string of letters and digits representing the revision number (firmware version)

Get IMSI

---

To obtain the International Mobile Subscriber Identity (IMSI), use -x or --imsi options.

Usage syntax:

gsmctl -x, --imsi

Example: obtaining IMSI:

root@Teltonika:~# gsmctl -x
246029999999999

Possible responses:

• a 15 digit (or less) sequence of decimal numbers

Get SIM card state

---

To obtain the state of the SIM card currently in use, use -z or --simstate options.

Usage syntax:

gsmctl -z, --simstate

Example: obtaining the current SIM state:

root@Teltonika:~# gsmctl -

Possible responses:

Get GSM signal (RSSI) level

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

• inserted
• not inserted

Get WCDMA RSCP level

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get WCDMA EC/IO level

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get LTE RSRP level

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get LTE SINR level

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get LTE RSRQ level

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get cell ID parameter

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get name of operator used

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get operator number

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get data carrier type

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get module temperature

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get PIN/PUK count

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get network information

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get serving cell information

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Get neighbour cell information

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Shutdown the modem

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

List available options

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

Print gsmctl version

---

To obtain the , use - or -- options.

Usage syntax:

gsmctl -, --

Example: obtaining the

root@Teltonika:~# gsmctl -

Possible responses:

---

---

---

---

---

---

---

---

---

---