Search For Topics
BeamOS – Administration
Summary
This chapter is an overview of the BEAM iSERIES routers’ System → Administration section.
General
The General section is used to change some of the most general configurations of the router (password, language, etc.)
Field Name | Value | Description |
|---|---|---|
Router name | string; Default: BEAMxx | The router’s model name. |
Host name | string; Default: beam-onboard.com | The router’s hostname. This can be used for communication with other LAN hosts. |
Current password | string; Default: admin01 | Router’s admin password |
New password | Confirm new password | string; Default: none | A new password for the router. The password must be comprised of 8-32 characters, including at least one upper case letter, one lower case letter and one digit. |
Language | English | Deutsch | Français | Turkish; Default: English | Selects the router’s WebUI language. |
IPv6 Support | yes | no; default: no | Turns IPv6 support on or off. |
Show mobile info at login page | yes | no; Default: no | Shows mobile data connection information (signal strength, state, service mode) at login page. |
Show WAN IP at login page | yes | no; Default: no | Show the router’s WAN IP address at login page |
LEDs Indication | yes | no; Default: yes | Toggles LED indication ON or OFF |
Min time | integer [5..60]; default: 5 | Specifies the minimum amount of time (in seconds) that the reset button has to be pressed and held down in order to initiate a factory reset. |
Max time | integer [5..100]; default: 30 | Specifies the maximum amount of time (in seconds) that the reset button has to be pressed and held down in order to initiate a factory reset. |
Restore to default | – | Restores the router to it’s default state (factory settings) |
Troubleshoot
The Troubleshoot section is used to download various files that contain information used for troubleshooting the router. Refer to the figure and table below for information on the Troubleshoot page.
Field Name | Value | Description |
|---|---|---|
System log level | Debug | Info | Notice | Warning | Error | Critical | Alert | Emergency; Default: Debug | Specifies the information output level of the system log.
Debug – contains basic information that is diagnostically helpful to most people (i.e., not just engineers).
Info – general useful information (e.g., configuration changes, starts and stops of services, etc.)
Notice – conditions that are not error conditions, but that may require special handling.
Warning – anything that can potentially cause application oddities, but for which the system is automatically recovering from (e.g., retrying an operation, missing secondary data, etc.)
Error – errors that are fatal to the operation, but not the service or application (can’t open a required file, missing data, etc.) Solving these types of errors will usually require user intervention.
Critical – critical conditions, device errors.
Alert – a condition that must be corrected immediately.
Emergency – a panic condition, i.e., system is no longer usable. |
Save log in | RAM memory | Flash memory; Default: RAM memory | Specifies which type of memory to use for storing system logs. |
Include GSMD information | yes | no; Default: yes | Includes GSMD information in the router’s logs |
Include PPPD information | yes | no; Default: no | Includes PPPD information in the router’s logs |
Include Chat script information | yes | no; Default: yes | Includes Chat script information in the router’s logs |
System log | – (interactive button) | Displays the contents of the router’s system log file. The system log contains records of various system related events, such as starts/stops of various services, errors, reboots, etc. |
Kernel log | – (interactive button) | Displays the contents of the router’s kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS). |
Troubleshoot file | – (interactive button) | Downloads the router’s Troubleshoot file. It contains the router’s configuration information, logs and some other files. When requesting support, it is recommended to always provide the router’s Troubleshoot file to Mobile Onbaord engineers for analysis. |
TCP dump file | – (interactive button) | Downloads the router’s TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the router does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file. |
Enable TCP dump* | yes | no; Default: no | Turns TCP dump packets capture on or off. |
* More on TCP dump in the next section.
TCP Dump
TCP dump is a program used to capture packets moving through network interfaces. By default, the router does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
Field Name | Value | Description |
|---|---|---|
Enable TCP dump | yes | no; Default: no | Turns TCP dump packet capture on or off. |
Select interface | network interface; default: any | Only captures packets that move through the specified network interface. |
Select protocol filter | all | icmp | tcp | udp | arp; default: all | Only captures packets that match the specified protocol. |
Select packets direction | IN/OUT | Incoming | Outgoing; default: IN/OUT | Only captures packets coming from the specified direction. |
Host | ip | host; default: none | Only captures packets related to the specified host. |
Port | integer [0..65335]; default: none | Only captures packets related to the specified communication port. |
Select storage | Internal storage; default: Internal storage | Specifies where the TCP dump file will be stored. |
Backup
The Backup page is used to download or upload configuration backup files to the router. Backup files can be uploaded only from identical devices with identical firmware. Once a backup file is uploaded to a router, that router will have identical configuration as the router from which the backup file originated (was downloaded from).
- Backup Configuration – generates and downloads the router’s backup file based on the current configuration.
- Restore Configuration – uploads a configuration backup file to the router. This can be done in two ways:
- Upgrade from file – uploads a configuration file from your computer.
- Upgrade from FOTA – uploads a configuration file assigned to the device in FOTA.
Important: backup files can be uploaded only when taken from a device with an identical Product code (can be checked in Status → Device) and identical or older firmware.
Access Control
The Access Control page is used to manage remote and local access to the router.
Important: turning on remote access leaves the router vulnerable to external attackers. Make sure you use a strong password.
General
The General section is used to manage SSH, HTTP(S) and CLI access to the router.
SSH
Field Name | Value | Description |
|---|---|---|
Enable SSH access | yes | no; Default: yes | Turns SSH access from the local network (LAN) on or off. |
Remote SSH access | yes | no; default: no | Turns SSH access from remote networks (WAN) on or off. |
Port | integer [0..65535]; default: 22 | Selects which port to use for SSH access. |
WebUI
Field Name | Value | Description |
|---|---|---|
Enable HTTP access | yes | no; Default: yes | Turns HTTP access from the local network (LAN) to the router’s WebUI on or off. |
Redirect to HTTPS | yes | no; default: no | Redirects connection attempts from HTTP to HTTPS. |
Enable remote HTTP access | yes | no; default: no | Turns HTTP access from remote networks (WAN) to the router’s WebUI on or off. |
Port | integer [0..65535]; default: 80 | Selects which port to use for HTTP access. |
Enable remote HTTPS access | yes | no; default: no | Turns HTTPS access from remote networks (WAN) to the router’s WebUI on or off. |
Port | integer [0..65535]; default: 443 | Selects which port to use for HTTPS access. |
Enable JSON RPC | yes | no; default: yes | Turns JSON-RPC access via ubus on or off. |
RFC1918 Filter | yes | no; default: yes | Turns Address Allocation for Private Internets on or off. |
CLI
Field Name | Value | Description |
|---|---|---|
Enable CLI | yes | no; Default: yes | Turns CLI access from the local network (LAN) on or off. |
Enable remote CLI | yes | no; default: no | Turns CLI access from remote networks (WAN) on or off. |
Port range | range of integers [0..65534]-[1..65535]; default: 4200-4220 | Selects which ports to use for CLI access. |
Shell limit | integer [1..10]; default: 5 | Maximum number of active CLI connections. |
Safety
The Safety section is used to manage the List Of Blocked Addresses. After a user attempts to login to this devices via SSH/HTTP, he will have a limited amount of retries in case of unsuccessful login attempts. This limit is called Fail count and is set in this page. After the user exhausts the maximum number of attempts, his IP address will be blocked from making more attempts and added to the List Of Blocked Addresses.
Block Unwanted Access
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: yes | Turns secure SSH/HTTP access on or off. If this is checked, devices logging in have a limited amount of tries specified in the Fail count field to log in to the router via SSH/HTTP. |
Clean after reboot | yes | no; Default: no | If this field is checked, addresses are removed from the List Of Blocked Addresses after every router reboot. |
Fall count | integer; Default: 5 | Maximum login fail count after which the device’s address is blocked and addedd to the List Of Blocked Addresses. |
List Of Blocked Addresses
The screenshot above is of a list that contains one blocked address. If you or someone you know gets blocked accidentally, you can unblock users from this section by deleting their IP address from the list.
Note: the list gets cleared after a factory reset.
Diagnostics
The Diagnostics section is used to execute simple network diagnostic tests, including ping, traceroute and nslookup.
Enter an address in the Host field and execute one of the following actions:
- Ping – sends ICMP requests to the specified address.
- Traceroute – displays the path that packets have to take in order to reach the specified address.
- Nslookup – obtains domain name address and IP address mapping information.
MAC Clone
The MAC Clone section is used to change the router’s WAN MAC address. You can change the MAC address by entering a new custom value in the WAN MAC address field or click the ‘Get PC MAC address’ button to obtain your PC’s MAC address and use it to fill the field.
In some cases access to a local network is protected by a MAC filter. For example, your company’s main router may bind the MAC addresses of devices to the physical Internet sockets they usually connect to. In these cases only the device that is bound to the socket may gain access to the network. You can use MAC Clone to “clone” your PCs address and apply it to your router’s WAN Ethernet port to gain access to such networks.
Overview
The Overview section is used to select which widgets should be visible in the Status → Overview page.
Simply select the widgets that you would like to view in the Overview page and click the ‘Save’ button.
RMS
RMS (Remote Management System) is a cloud system designed and intended for remote monitoring and management of networking products. Access to the RMS is a subscription-based service charged on a per-device basis.
The figure below is a screenshot of the RMS section taken from a device which has been connected to RMS:
Field Name | Value | Description |
|---|---|---|
Connection type | Enabled | Standby | Disabled; default: Enabled | Defines how the device will connect to RMS:
Enabled – the device attempts to connect to RMS every 2-5 minutes (every 2 minutes the first hour; then every 5 minutes). If it cannot connect for 14 days, it will enter Standby mode.
Standby – the device attempts to connect to RMS every 6 hours.
Disabled – RMS functionality is disabled. |
Hostname | host | ip; default: rms.beamonboard.com | Address of the RMS server. If you’re using regular RMS, just leave the default address (rms.beamonboard.com). |
Port | integer [0..65535]; default: 15009 | Port number for connecting to RMS. If you’re using regular RMS, just leave the default port (15009). |
The RMS server waits for incoming connections. Since the device attempts to connect at a fixed interval, it may not connect instantly after you add it to RMS. While it is disconnected, you can check how much time is left until the next connection attempt in the Status section:
To speed up the process by initiating an immediate connection attempt, click the ‘Connect’ button.
Root CA
The Root CA section is used to add a root CA certificate file to the router. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.
