The information contained in this document is subject to change. This document contains proprietary information, which is protected by copyright
laws. All rights are reserved. No part of this document may be photocopied, reproduced or translated to another language or program language
without prior written consent of RFI Engineering B.V.
RefGuide_U-routerNGW_v1.01.docx
Page: 35(
57)
13 CLI Commands
This chapter lists the commands to configure the U-router NGW software features using the
command line interface (CLI). The information in this chapter is intended for system administrators
who are responsible for configuring and operating a network using the U-router NGW. To obtain the
greatest benefit from this chapter, you should have a basic understanding of Linux and also have
basic knowledge of Ethernet and networking concepts.
13.1 What is the CLI
The command line interface (CLI) is a text-based way to manage and monitor the U-router NGW.
You can access the CLI by using a remote logical connection over SSH.
13.2 Command Syntax
A command is one or more words that might be followed by one or more parameters. Parameters
can be required or optional values. Some commands, such as
ngw-term.sh
, do not require
parameters. Other commands, such as
ngw-client
, require that you supply a value after the
command. You must type the parameter values in a specific order, and optional parameters follow
required parameters.
13.3 Command Conventions
The parameters for a command might include mandatory values, optional values, or keyword
choices.
<> angle brackets
<value>
Indicates a mandatory parameter
[ ] square brackets
[value]
Indicates an optional parameter
13.4 Status command of the U-router NGW: ngw-client
When you use the Dashboard tab of the Web GUI you will find the information about the mobile
connection, such as the status of the mobile network connection, signal strength and registration
states. That same information can be obtained using the
ngw-client
command.
Ngw-client by itself, i.e. called without parameters, tries to be helpful and lists the various command
options. As example:
root@VZ1-034748:~# ngw-client
Build date is: Jun 22 2020 11:38:20
Usage: ngw-client [-v] <command>
possible <command>s
status, show status of the U-router
mobile, show mobile settings of the U-router
interface, show the interfaces of the U-router
relay [id] [on]/[off], operate internal relay or show relay status
possible options
-v switch on verbose mode
13.5 Retrieving the Status of the U-router NGW: ngw-client status
When ngw-client is called with the ‘status’ option, the command retrieves the status of the U-
router and shows information to identify the unit. As example:
rfi@rfi-000102
:
~
$ ngw-client status
+---------------------------------------------------------------------+
| SYSTEM |
+---------------------------------------------------------------------+
magic : 801f12639d52
softwareVersion : ngw-daemon 1.78 [Oct 28 2020 20:28:28]
hardwareVersion : 2.2
osSysname : Linux
osRelease : 5.4.20
osMachine : armv5tejl
serialNumber : RE.45.NGWR.00001
productionDate : Fri 10 Jul 2020 07:10:06 PM
flavour : rfi0
imei : 354679091577638
manufacturer : u-blox
