- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
07-Mobile communication modem management commands | 534.54 KB |
Mobile communication modem management commands
reset counters controller cellular
3G modem-specific management commands
Mobile communication modem management commands
Common management commands
controller cellular
Use controller cellular to enter cellular interface view.
Syntax
controller cellular cellular-number
Views
System view
Predefined user roles
network-admin
Parameters
cellular-number: Specifies a cellular interface by its number.
Examples
# Enter Cellular 2/4/0 interface view.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular 2/4/0]
description
Use description to configure the description of an interface.
Use undo description to restore the default.
Syntax
description text
undo description
Default
The description for a cellular interface is in the interface name Interface format, for example, Cellular 2/4/0 Interface.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
text: Sets an interface description, a case-sensitive string of 1 to 255 characters.
Examples
# Set the description for Cellular 2/4/0 to Cellular-intf.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] description Cellular-intf
display cellular
Use display cellular to display call connection information for a mobile communication modem.
Syntax
display cellular [ interface-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
cellular [ interface-number ]: Specifies a cellular interface by its number. If you do not specify a cellular interface, this command displays call connection information for all cellular interfaces with mobile communication modems installed.
Usage guidelines
The command output might vary by modem manufacturers.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Display call connection information for a 3G modem. (WCDMA network).
<Sysname> display cellular 2/4/0
Cellular2/4/0:
Hardware Information:
Model: E176G
Modem Firmware Version: 11.604.09.00.00
Hardware Version: CD25TCPU
International Mobile Subscriber Identity (IMSI): 460029010431055
International Mobile Equipment Identity (IMEI): 353871020138548
Factory Serial Number (FSN): DK9RAA1871500602
Modem Status: Online
Profile Information:
Profile 1: Active
PDP Type: IPv4, Header Compression: Off
Data Compression: Off
Access Point Name (APN): 001
Packet Session Status: Inactive
Modem Setup Information:
Diagnostics Monitor: Close
Network Information:
Current Service Status: Service available
Current Service: Combined
Packet Service: Attached
Packet Session Status: Inactive
Current Roaming Status: Roaming
Network Selection Mode: Manual
Network Connection Mode: WCDMA precedence
Current Network Connection: HSDPA and HSUPA
Mobile Country Code (MCC): 460
Mobile Network Code (MNC): 00
Location Area Code (LAC): 4318
Cell ID: 25381
Radio Information:
Current Band: ANY
Current RSSI: -51 dBm
Modem Security Information:
PIN Verification: Disabled
PIN Status: Ready
Number of Retries remaining: 3
SIM Status: OK
Table 1 Command output
Field |
Description |
Model |
Modem name. |
International Mobile Subscriber Identity (IMSI) |
IMSI string of the SIM card. |
International Mobile Equipment Identity (IMEI) |
IMEI serial number of the modem. |
Factory Serial Number (FSN) |
FSN of the modem. |
Modem Status |
Status of the modem: · Online—The modem is powered on. · Offline—The modem is powered off or in low power mode. The cellular interface is not available. |
Profile Information |
Profile settings for the modem. |
Profile 1 |
PDP status of the modem: · Active—The profile is already configured. · Undefined—The profile is not configured. |
PDP Type |
PDP type, displayed only when Profile 1 is Active: · IPv4. · IPv6. · PPP (transparent transmission). |
Header Compression |
PDP header compression status: · On. · Off. |
Data Compression |
PDP data compression status: · On. · Off. |
Packet Session Status |
PDP status: · Active—The modem is transmitting data through PPP. · Inactive—The modem is physically down. |
Diagnostics Monitor |
Diagnostic and monitoring (DM) status: · Open—DM is enabled. · Close—DM is disabled. |
Current Service Status |
Service status of the modem: · Service available—The modem is providing services correctly. · Emergency—The modem is providing limited services. The cellular interface is not available. · No service—The modem cannot provide services. The cellular interface is not available. · Low power—The modem is in low power mode. The cellular interface is not available. |
Current Service |
Current service type: · Circuit-switched—For the CS domain only. · Packet-switched—For the PS domain only. · Combined—For both the CS and PS domains. · Invalid—Invalid service. |
Packet Service |
PS domain attach/detach status of the modem: · Detached—The cellular interface is not available. · Attached—The cellular interface is available. |
Current Roaming Status |
Roaming status: · Roaming. · Home. |
Network Selection Mode |
Network selection mode: · Manual. · Automatic. |
Network Connection Mode |
Network connection mode: · WCDMA only—Connected to the WCDMA network only. · WCDMA precedence—Connected to the WCDMA network with preference. · GSM only—Connected to the GSM network only. · GSM precedence—Connected to the GSM network with preference. |
Current Network Connection |
Current network: · No Service. · GSM. · GPRS. · EDGE. · WCDMA. · HSDPA. · HSUPA. · HSDPA and HSUPA. · HSPA+. · Unknown. |
Mobile Country Code (MCC) |
The MCC is displayed if the modem has found a mobile network. |
Mobile Network Code (MNC) |
The MNC is displayed if the modem is successfully registered with a mobile network. |
Location Area Code (LAC) |
The LAC is displayed if the modem is successfully registered with a mobile network. |
Cell ID |
The Cell ID is displayed if the modem is successfully registered with a mobile network. |
Current Band |
Current band selection mode: · GSM. · WCDMA. · ANY. · AUTO. |
Current RSSI |
Current RSSI: · An RSSI value in the range of –110 dBm to –51 dBm. · Unknown—No signal. The cellular interface is unavailable. |
PIN Verification |
PIN authentication status: · Disabled. · Enabled. |
PIN Status |
PIN status: · Ready—The SIM card is ready. · PIN Requirement—Requires you to execute the pin verify command to enter the PIN for PIN verification. · PUK Requirement—Requires you to execute the pin unlock command to unlock the SIM or UIM card. |
Number of Retries remaining |
Remaining retries available for entering the PIN or PUK. |
SIM Status |
SIM card status: · OK—The SIM card is normal. · Locked—The SIM card is locked. The cellular interface is not available. · Not Insert—No SIM card is present. The cellular interface is not available. · Unknown—The SIM card status is unknown. |
# Display call connection information for a 3G modem (TD-SCDMA network).
<Sysname> display cellular 2/4/0
Cellular2/4/0:
Hardware Information:
Model: ET128
Modem Firmware Version: 11.101.01.08.00
Hardware Version: CS31TCPU
International Mobile Subscriber Identity (IMSI): 460079011105842
International Mobile Equipment Identity (IMEI): 860039002369111
Factory Serial Number (FSN): GQ4CAB1942911350
Modem Status: Online
Profile Information:
Profile 1: Active
PDP Type: IPv4
Header Compression: Off
Data Compression: Off
Access Point Name (APN): cmnet
Packet Session Status: Active
Network Information:
Current Service Status: Service available
Network Selection Mode: Automatic
Network Connection Mode: TD-SCDMA precedence
Current Network Connection: HSDPA
Mobile Network Name: CHINA MOBILE
Downstream Bandwidth: 2800000 bps
Radio Information:
Current RSSI: -75 dBm
Modem Security Information:
PIN Verification: Disabled
PIN Status: Ready
Number of Retries remaining: 3
SIM Status: OK
Table 2 Command output
Field |
Description |
Model |
Modem name. |
International Mobile Subscriber Identity (IMSI) |
IMSI string of the SIM card. |
International Mobile Equipment Identity (IMEI) |
IMEI serial number of the modem. |
Factory Serial Number (FSN) |
FSN of the modem. |
Modem Status |
Status of the modem: · Online—The modem is powered on. · Offline—The modem is powered off or in low power mode. The cellular interface is not available. |
Profile Information |
Profile settings for the modem. |
Profile 1 |
PDP status of the modem: · Active—The profile is already configured. · Undefined—The profile is not configured. |
PDP Type |
PDP type, displayed only when Profile 1 is Active: · IPv4. · IPv6. · PPP (transparent transmission). |
Header Compression |
PDP header compression status: · On. · Off. |
Data Compression |
PDP data compression status: · On. · Off. |
Packet Session Status |
PDP status: · Active—The modem is transmitting data through PPP. · Inactive—The modem is physically down. |
Current Service Status |
Service status of the modem: · Service available—The modem is providing services correctly. · Emergency—The modem is providing limited services. The cellular interface is not available. · No service—The modem cannot provide services. The cellular interface is not available. · Low power—The modem is in low power mode. The cellular interface is not available. |
Network Selection Mode |
Network selection mode: · Manual. · Automatic. |
Network Connection Mode |
Network connection mode: · WCDMA only—Connected to the WCDMA network only. · WCDMA precedence—Connected to the WCDMA network with preference. · GSM only—Connected to the GSM network only. · GSM precedence—Connected to the GSM network with preference. |
Current Network Connection |
Current network: · No Service. · GSM. · GPRS. · EDGE. · TD-SCDMA. · HSDPA. · Unknown. |
Downstream Bandwidth |
Downstream bandwidth, in bps. |
Radio Information |
Radio communication information. |
Current RSSI |
Current RSSI: · An RSSI value in the range of –110 dBm and –51 dBm. · Unknown—No signal. The cellular interface is unavailable. |
PIN Verification |
PIN authentication status: · Disabled. · Enabled. |
PIN Status |
PIN status: · Ready—The SIM card is ready. · PIN Requirement—Requires you to execute the pin verify command to enter the PIN for PIN verification. · PUK Requirement—Requires you to execute the pin unlock command to unlock the SIM or UIM card. |
Number of Retries remaining |
Remaining retries available for entering the PIN or PUK. |
SIM Status |
SIM card status: · OK—The SIM card is normal. · Network Reject—The SIM card is denied access to the network. The cellular interface is not available. · Not Insert—The SIM card is absent. The cellular interface is not available. |
# Display call connection information for a 3G modem (CDMA network).
<Sysname> display cellular 2/4/0
Cellular2/4/0:
Hardware Information:
Model: EC169
Manufacturer: HUAWEI TECHNOLOGIES CO.
Modem Firmware Version: 11.002.03.01.45
Hardware Version: CE62TCPUVer A
Electronic Serial Number (ESN): c1836f2d
Preferred Roaming List (PRL) Version: 0
International Mobile Subscriber Identity (IMSI): 460036101433925
Modem Status: Online
Network Information:
Current Service Status: Service available
Current Roaming Status: Home
Network Connection Mode: Manual
Current Network Connection: 1xRTT/EVDO HYBRID
Downstream Bandwidth: 3100000 bps
Radio Information:
Current RSSI(1xRTT): -93 dBm
Current RSSI(EVDO): -75 dBm
Current Voltage: 3336 mV
Modem Security Information:
PIN Verification: Disabled
PIN Status: Ready
Number of Retries remaining: 3
UIM Status: OK
UIM Number Information:
UIM Number: 0
Table 3 Command output
Field |
Description |
Model |
Modem name. |
International Mobile Subscriber Identity (IMSI) |
IMSI string of the UIM card. |
Modem Status |
Status of the modem: · Online—The modem is powered on. · Offline—The modem is powered off or in low power mode. The cellular interface is not available. |
Current Service Status |
Service status of the modem: · Service available—The modem is providing services correctly. · Emergency—The modem is providing limited services. The cellular interface is not available. · No service—The modem cannot provide services. The cellular interface is not available. · Low power—The modem is in low power mode. The cellular interface is not available. |
Current Roaming Status |
Roaming status: · Roaming. · Home. |
Network Selection Mode |
Network selection mode · Manual. · Automatic. |
Current Network Connection |
Current network: · No Service. · 1xRTT/EVDO HYBRID. · EVDO. · 1xRTT. · Unknown. |
Downstream Bandwidth |
Downstream bandwidth, in bps. |
Radio Information |
Radio communication information. |
Current RSSI (1xRTT) |
Current RSSI of 1xRTT: · An RSSI value in the range of –125 dBm to –75 dBm. · Unknown—No signal. |
Current RSSI (EVDO) |
Current RSSI of EVDO: · An RSSI value in the ranges of –120 dBm to –60 dBm. · Unknown—No signal. |
Current Voltage |
Current voltage of the UIM card, in mV. |
PIN Verification |
PIN authentication status: · Disabled. · Enabled. |
PIN Status |
PIN status: · Ready—The UIM card is ready. · PIN Requirement—Requires you to execute the pin verify command to enter the PIN for PIN verification. · PUK Requirement—Requires you to execute the pin unlock command to unlock the SIM or UIM card. |
Number of Retries remaining |
Remaining retries available for entering the PIN or PUK. |
UIM Status |
UIM card status: · OK—The UIM card is normal. · Network Reject—The UIM card is denied access to the network. The cellular interface is not available. · Not Insert—The UIM card is absent. The cellular interface is not available. |
UIM Number Information |
Slot information for the active UIM card. |
UIM Number |
Slot number for the active UIM card. The available values are 0 and 1. |
# Display call connection information for a 4G modem (LTE network).
<Sysname> display cellular 0/0
Cellular0/0:
Hardware Information:
Model: MC7750
Manufacturer: Sierra Wireless, Incorporated
Modem Firmware Version: SWI9600M_03.05.10.06
Hardware Version: 10
International Mobile Equipment Identity (IMEI): 990000560327506
Modem Status: Online
Profile Information:
Profile index: 1
PDP Type: IPv4
Header Compression: Off
Data Compression: Off
Access Point Name (APN): vzwinternet
Network Information:
Current Service Status: Service available
Current Roaming Status: Roaming
Current Data Bearer Technology: Unknown
Network Selection Mode: Manual
Mobile Country Code (MCC): 460
Mobile Network Code (MNC): 00
Location Area Code (LAC): 4318
Cell ID: 25381
Radio Information:
Technology Preference: LTE only
Technology Selected: LTE
LTE related info:
Current RSSI: -79 dBm
Current RSRQ: -9 dB
Current RSRP: -106 dBm
Current SNR: 5 dB
Tx Power: -3276 dBm
Modem Security Information:
PIN Verification: Disabled
PIN Status: Ready
SIM Status: OK
ICCID: 89860113811003195000
Table 4 Command output
Field |
Description |
Modem Status |
Status of the modem: · Online—The modem is powered on. · Offline—The modem is powered off or in lower power mode. The cellular interface is unavailable. |
PDP Type |
PDP type, displayed only when Profile 1 is Active: · IPv4. · IPv6. · PPP (transparent transmission). |
Header Compression |
PDP header compression status · On. · Off. |
Data Compression |
PDP data compression status: · On. · Off. |
Current Service Status |
Service status of the modem: · Limited—The modem is not in the coverage of the selected network. The cellular interface is not available. · Service available—The modem is providing services correctly. · Emergency—The modem is providing limited services. The cellular interface is not available. · No service—The modem cannot provide services. The cellular interface is not available. · Low power—The modem is in low power mode. The cellular interface is not available. |
Current Roaming Status |
Roaming status: · Roaming. · Home. |
Current Data Bearer Technology |
Current data carrier technology: · CDMA2000 1X. · CDMA2000 HRPD (1xEV-DO). · GSM. · UMTS. · CDMA2000 HRPD (1xEV-DO RevA). · EDGE. · HSDPA and WCDMA. · WCDMA and HSUPA. · HSDPA and HSUPA. · LTE. · CDMA2000 EHRPD. · HSDPA+ and WCDMA. · HSDPA+ and HSUPA. · DC_HSDPA+ and WCDMA. · DC_HSDPA+ and HSUPA. · HSDPA+ and 64QAM. · HSDPA+, 64QAM and HSUPA. · TDSCDMA. · TDSCDMA and HSDPA. · Unknown. |
Network Selection Mode |
Network selection mode · Manual. · Automatic. |
Mobile Country Code (MCC) |
The MCC is displayed if the modem has found the network. |
Mobile Network Code (MNC) |
The MNC is displayed if the modem is successfully registered with a mobile network. |
Location Area Code (LAC) |
The LAC is displayed if the modem is successfully registered with a mobile network. |
Cell ID |
The Cell ID is displayed if the modem is successfully registered with a mobile network. |
Radio Information |
Wireless communication information. |
Technology Preference |
Network connecting preference: · AUTO—Automatically select a network for connection. · GSM only—Connects only to a GSM network. · GSM precedence—Connects preferentially to a GSM network. · WCDMA only—Connects only to a WCDMA network. · WCDMA precedence—Connects preferentially to a WCDMA network. · TD-SCDMA only—Connects only to a TD-SCDMA network. · TD-SCDMA precedence—Connects preferentially to a TD-SCDMA network. · EVDO—Connects only to a CDMA-EVDO network. · 1x RTT—Connects only to a CDMA-1x RTT network. · 1xRTT/EVDO HYBRID—Connects to CDMA-EVDO and CDMA-1x RTT networks simultaneously. · LTE only—Connects only to a LTE network. |
Technology Selected |
Current network: · GSM—Has connected to a GSM network. · WCDMA—Has connected to a WCDMA network. · TD-SCDMA—Has connected to a TD-SCDMA network. · EVDO—Has connected to a CDMA-EVDO network. · 1Xrtt—Has connected to a CDMA-1x RTT network. · 1xRTT/EVDO HYBRID—Has connected to the CDMA-EVDO and CDMA-1x RTT networks. · LTE—Has connected to an LTE network. |
LTE related info |
Information about the LTE network. |
Current RSSI |
The value is in the range of –110 dBm to –51 dBm. This field displays Unknown when no signal is received and the cellular interface is not available. |
Current RSRQ |
Current reference signal received quality. |
Current RSRP |
Current reference signal received power. |
Current SNR |
Current signal-to-noise ratio. |
Tx Power |
Transmitting power. |
PIN Verification |
PIN authentication status: · Disabled. · Enabled. · Unknown. |
PIN Status |
PIN status: · Ready—The SIM card is ready. · PIN Requirement—Requires you to execute the pin verify command to enter the PIN for PIN verification. · PUK Requirement—Requires you to execute the pin unlock command to unlock the SIM or UIM card. |
SIM Status |
SIM card status: · OK—The SIM card is normal. · Network Reject—The SIM card is denied access to the network. The cellular interface is not available. · Not Insert—The SIM card is absent. The cellular interface is not available. · Not Initialized—The SIM card status cannot be identified. |
ICCID |
ID of the SIM card, displayed only when the SIM card status is OK. |
# Display call connection information for a 5G modem (LTE network).
<sysname>display cellular 0/0
Cellular0/0:
Modem State:
Hardware Information:
Model: RM500QGL_VH
Manufacturer: QUALCOMM INCORPORATED
Modem Firmware Version: RM500QGLABR01A01M4G
International Mobile Equipment Identity (IMEI): 863305040121609
International Mobile Subscriber Identity (IMSI): 460028012255957
Hardware Version: 20000
Modem Status: Online
Modem Status: IPv4 Active.
Modem Status: IPv6 Unknown.
Profile Information:
Profile index: 1
PDP Type: IPv4v6
Header Compression: Off
Data Compression: Off
Access Point Name (APN): cmiot
Authentication: NONE
* - Default profile
Profile index: 2
PDP Type: IPv4v6
Header Compression: Off
Data Compression: Off
Access Point Name (APN): ims
Authentication: NONE
Profile index: 3
PDP Type: IPv4v6
Header Compression: Off
Data Compression: Off
Access Point Name (APN): CMNET
Authentication: NONE
Profile index: 4
PDP Type: IPv4v6
Header Compression: Off
Data Compression: Off
Access Point Name (APN): CMWAP
Authentication: NONE
Profile index: 5
PDP Type: IPv4v6
Header Compression: Off
Data Compression: Off
Access Point Name (APN): SOS
Authentication: NONE
Network Information:
Current Service Status: Service Available
Registration Status: Registered
Current Service: Combined
Current Roaming Status: Home
Current Data Bearer Technology = NR
Network Selection Mode: Automatic
Current IP address Mode: Cellular-alloc
Current IPv6 address Mode: Unknown
Mobile Network Name: C
Mobile Country Code (MCC): 460
Mobile Network Code (MNC): 00
Tracking Area Code(TAC): 4526
Cell ID: 20027137
Radio Information:
Technology Preference: No preference specified (AUTO)
Technology Selected: NR && LTE
Configured LTE Band = 1,2,3,4,5,7,8,12,13,14,17,18,19,20,25,26,28,29,30,32,34,38,39,40,41,42,43
5G availability under LTE system info:
Current PCI: 537
Endc Available: 1
Restrict Dcnr: 0
R15Availabe: 1
NR related info:
Current RSRQ: -12 dB
Current RSRP: -93 dBm
Current SNR: 14 dB
LTE related info:
Current RSSI: -65 dBm
Current RSRQ: -13 dB
Current RSRP: -103 dBm
Current SNR: -2 dB
Tx Power: 10 dBm
Active Band = E-UTRA Operating Band 39
Modem Security Information:
PIN Verification: Disabled
PIN Status: PIN Requirement Disabled
Number of PIN Retries Remaining: 3
Number of PUK Retries Remaining: 10
SIM Status: OK
ICCID: 898600100119F0111820
Error Information:
IPv4 dialing failed: 0x00: No error in the request
IPv6 dialing failed: N/A
GNSS Information:
GNSS Info:
GNSS State: Enabled
GNSS Mode Configured: Standalone
Latitude(WGS84): 31 Deg 50 Min 21.17 Sec North
Longitude(WGS84): 117 Deg 7 Min 47.22 Sec East
Timestamp (UTC): 09/24/2020 01:27:26
Local time: 09/24/2020 09:27:26
Heading: 0.00, Velocity Horiz: 0.00, Velocity Vert: 0.00
Height (MSL): 212.30 m
Satellite Info:
Satellite ID: #2
SvSystem:GPS Elevation: 44.00, Azimuth: 309.00, SNR: 33.00, Processing Status: Track
Satellite ID: #1
SvSystem:BEIDOU Elevation: 61.00, Azimuth: 116.00, SNR: 40.00, Processing Status: Track
Satellite ID: #7
SvSystem:GALILEO Elevation: 42.00, Azimuth: 71.00, SNR: 44.00, Processing Status: Track
Table 5 Command output
Field |
Description |
Modem Status |
Status of the modem: · Online—The modem is powered on. · Offline—The modem is powered off or in lower power mode. The cellular interface is not available. · IPv4 Active—IPv4 dialup is activated. · IPv4 Inactive—IPv4 dialup is not activated. · IPv4 Unknown—IPv4 dialup is disabled. · IPv6 Active—IPv6 dialup is activated. · IPv6 Inactive—IPv6 dialup is not activated. · IPv6 Unknown—IPv6 dialup is disabled. |
PDP Type |
PDP type, displayed only when Profile 1 is Active: · IPv4. · IPv6. · PPP (transparent transmission). |
Header Compression |
PDP header compression status: · On. · Off. |
Data Compression |
PDP data compression status: · On. · Off. |
Authentication |
Authentication mode: · NONE—No authentication. · CHAP—CHAP authentication. · PAP—PAP authentication. · PAP or CHAP—PAP or CHAP authentication. |
Current Service Status |
Service providing status of the modem: · Limited—The modem is not in the coverage of the selected network. The cellular interface is not available. · Service available—The modem is providing services correctly. · Emergency—The modem is providing limited services. The cellular interface is not available. · No service—The modem cannot provide services. The cellular interface is not available. · Low power—The modem is in low power mode. The cellular interface is not available. |
Registration Status |
Network registration status: · Registered—The modem has been registered to a network. · Not Registered—The modem has not been registered to a network. · Searching—The modem is searching for networks. · Denied—The modem has been denied from registration to a network. · Unknown—Other status. |
Current Service |
Current service status: · Combined. · Invalid. · Circuit-switched. · Packet-switched. |
Current Roaming Status |
Roaming status: · Roaming. · Home. |
Current Data Bearer Technology |
Current data carrier technology: · CDMA2000 1X. · CDMA2000 HRPD (1xEV-DO). · GSM. · UMTS. · CDMA2000 HRPD (1xEV-DO RevA). · EDGE. · HSDPA and WCDMA. · WCDMA and HSUPA. · HSDPA and HSUPA. · LTE. · NR. · CDMA2000 EHRPD. · HSDPA+ and WCDMA. · HSDPA+ and HSUPA. · DC_HSDPA+ and WCDMA. · DC_HSDPA+ and HSUPA. · HSDPA+ and 64QAM. · HSDPA+, 64QAM and HSUPA. · TDSCDMA. · TDSCDMA and HSDPA. · Unknown. |
Network Selection Mode |
Network selection mode · Manual. · Automatic. |
Current IP address Mode |
IPv4 address allocation method: · Cellular-alloc—Modem configuration. · dhcp-alloc—DHCP allocation. · Manual—Manual specification. · Unknown—Other allocation method. |
Current IPv6 address Mode |
IPv6 address allocation method: · Cellular-alloc—Modem configuration. · dhcp-alloc—DHCP allocation. · Manual—Manual specification. · Unknown—Other allocation method. |
Mobile Country Code(MCC) |
This information is displayed only when a network is found. |
Mobile Network Code(MNC) |
This information is displayed only when the modem has been registered to a network. |
Tracking Area Code(TAC) |
This information is displayed only when the modem has been registered to a network. |
Cell ID |
This information is displayed only when the modem has been registered to a network. |
Radio Information |
Wireless communication information |
Technology Preference |
Network connecting preference: · AUTO—Automatically selects a network for connection. · GSM only—Connects only to a GSM network. · GSM precedence—Connects preferentially to a GSM network. · WCDMA only—Connects only to a WCDMA network. · WCDMA precedence—Connects preferentially to a WCDMA network. · TD-SCDMA only—Connects only to a TD-SCDMA network. · TD-SCDMA precedence—Connects preferentially to a TD-SCDMA network. · EVDO—Connects only to a CDMA-EVDO network. · 1x RTT—Connects only to a CDMA-1x RTT network. · 1xRTT/EVDO HYBRID—Connects to CDMA-EVDO and CDMA-1x RTT networks simultaneously. · LTE only—Connects only to an LTE network. · NR only—Connects only to an NR network. |
Technology Selected |
Currently connected network: · GSM—Has connected to a GSM network. · WCDMA—Has connected to a WCDMA network. · TD-SCDMA—Has connected to a TD-SCDMA network. · EVDO—Has connected to a CDMA-EVDO network. · 1Xrtt—Has connected to a CDMA-1x RTT network. · 1xRTT/EVDO HYBRID—Has connected to the CDMA-EVDO and CDMA-1x RTT networks simultaneously. · LTE—Has connected to an LTE network. · NR && LTE—Has connected to an NR+LTE network (NSA networking) · NR—Has connected to an NR network. |
5G availability under LTE system info |
5G base station settings configured in NSA networking. |
Current PCI |
Current physical cell ID. |
Endc Available |
Whether 5G services are available (indicated by the SIB2 message). |
Restrict Dcnr |
Whether the modem can connect to both LTE and NR base stations. |
R15Availabe |
Whether R15 can be used (indicated by the PLMN message of the base station). |
Current RSRQ |
Current reference signal received quality. |
Current RSRP |
Current reference signal received power. |
Current SNR |
Current signal-to-noise ratio. |
Current RSSI |
The value is in the range of –110 dBm to –51 dBm. This field displays Unknown when no signal is received and the cellular interface is not available. |
Tx Power |
Signal transmit power. |
Active Band |
Band No. of the base station. |
PIN Verification |
PIN authentication status: · Disabled. · Enabled. · Unknown. |
PIN Status |
· Ready—The SIM card is normal. · PIN Requirement—Requires you to execute the pin verify command to enter the PIN for PIN verification. · PUK Requirement—Requires you to execute the pin unlock command to unlock the SIM or UIM card. |
Number of PIN Retries Remaining |
Remaining retries available for entering the PIN. |
Number of PUK Retries Remaining |
Remaining retries available for entering the PUK. |
SIM Status |
SIM card status: · OK—The SIM card is normal. · Locked—The SIM card is locked. The cellular interface is not available. · Not Inserted—No SIM card is present. The cellular interface is not available · Unknown—The SIM card status is unknown. |
ICCID |
ID of the SIM card, displayed only when the SIM card status is OK. |
IPv4 dialing failed |
The system returns 0x00 if IPv4 dialup failed and displays N/A if no IPv4 dialup is performed. |
IPv6 dialing failed |
The system returns 0x00 if IPv6 dialup failed and displays N/A if no IPv6 dialup is performed. |
Related commands
mode
pin modify
pin unlock
pin verification enable
pin verify
plmn select
profile create
display controller cellular
Use display controller cellular to display information about cellular interfaces.
Syntax
display controller [ cellular [ interface-number ] ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
cellular [ interface-number ]: Specifies cellular interfaces or a cellular interface by its number. If you do not specify the cellular keyword, this command displays information about all interfaces. If you specify the cellular keyword but not the interface-number argument, this command displays information about all cellular interfaces.
Usage guidelines
Hot swapping a USB mobile communication modem clears the cellular interface statistics.
Examples
# Display information about Cellular 2/4/0.
<Sysname> display controller cellular 2/4/0
Cellular2/4/0
Current state: UP
Description: Cellular2/4/0 Interface
Last clearing of counters: Never
Current system time:2023-10-30 13:56:28
Last time when physical state changed to up:-
Last time when physical state changed to down:2023-10-30 07:02:40
Capability:
1 Control channel, 1 ETH channel
Control channel traffic statistics:
TX: 389760 packets
RX: 389760 packets
Capability:
1 Control AT channel 1 Control QMI channel1 Control Debug channel1 ETH channel
Control channel(AT) 0 traffic statistics:
TX: 305028 packets, 0 errors
RX: 305028 packets, 0 errors
Control channel(QMI) 0 traffic statistics:
TX: 84732 packets, 0 errors
RX: 84732 packets, 0 errors
Debug channel 0 traffic statistics:
TX: 0 packets, 0 errors
RX: 0 packets, 0 errors
ETH channel 0 traffic statistics:
TX: 0 packets, 0 errors
RX: 0 packets, 0 errors
Table 6 Command output
Field |
Description |
Cellular2/4/0 Current state |
Status of the interface: · DOWN(Administratively)—The interface has been administratively shut down by using the shutdown command. · DOWN—The interface is administratively up but its physical state is down, possibly because of a connection or link failure. · UP—The administrative and physical states of the interface are both up. |
Description |
Description of the interface. |
Last clearing of counters |
Time when statistics on the logical interface were last cleared by using the reset counters controller cellular command. If the statistics of the interface have never been cleared by using the reset counters controller cellular command since the device started, this field displays Never. |
Modem status |
Status of the USB mobile communication modem: · Present—The modem is present. · Absent—The modem is absent. |
DM port status |
DM status: · Enabled. · Disabled. |
Capability: x Control channel, x PPP channel |
Type and number of channels the cellular interface supports: · x Control channel—Supports x control channels. · x PPP channel—Supports x asynchronous serial subchannels. · x ETH channel—Supports x Ethernet subchannels. · x ETH channel—Supports x diagnostic channels. |
Control channel 0 traffic statistics: TX: 0 packets, 0 errors RX: 0 packets, 0 errors |
Control channel statistics: · TX: 0 packets, 0 errors—Number of packets and number of error packets sent through the control channel. · RX: 0 packets, 0 errors—Number of packets and number of error packets received through the control channel. |
PPP channel 0 traffic statistics TX: 0 packets, 0 errors RX: 0 packets, 0 errors |
PPP channel statistics: · TX: 0 packets, 0 errors—Number of packets and number of error packets sent through the PPP channel. · RX: 0 packets, 0 errors—Number of packets and number of error packets received through the PPP channel. |
Debug channel 0 traffic statistics: TX: 0 packets, 0 errors RX: 0 packets, 0 errors |
Debug channel statistics: · TX: 0 packets, 0 errors—Number of packets and number of error packets sent through the debug channel. · RX: 0 packets, 0 errors—Number of packets and number of error packets received through the debug channel. |
ETH channel 0 traffic statistics TX: 0 packets, 0 errors RX: 0 packets, 0 errors |
Ethernet channel statistics: · TX: 0 packets, 0 errors—Number of packets and number of error packets sent through the Ethernet channel. · RX: 0 packets, 0 errors—Number of packets and number of error packets received through the Ethernet channel. |
Related commands
reset counters controller cellular
dm-port open
Use dm-port open to enable diagnostic and monitoring (DM) on a mobile communication modem.
Use undo dm-port open to disable DM on a mobile communication modem.
Syntax
dm-port open
undo dm-port open
Default
The default setting for this command depends on the modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Usage guidelines
Enabling DM on a mobile communication modem allows third-party debugging tools to diagnose and monitor the mobile communication modem through cellular interface debugging output.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Enable DM on a mobile communication modem.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] dm-port open
mode
Use mode to specify the network connection preference.
Syntax
mode { 1xrtt | auto | evdo | gsm | gsm-precedence | hybrid | lte | nr | td | td-precedence | wcdma | wcdma-precedence }
Default
The default setting for this command depends on the modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
1xrtt: Connects only to a CDMA-1x RTT network.
auto: Connects to a network automatically.
evdo: Connects only to a CDMA-EVDO network.
gsm: Connects only to a GSM network.
gsm-preference: Connects to a GSM network preferentially.
hybrid: Connects to CDMA-EVDO and CDMA-1xRTT networks simultaneously.
lte: Connects only to an LTE network.
nr: Connects only to an NR network.
td: Connects only to a TD-SCDMA network.
td-preference: Connects to a TD-SCDMA network preferentially.
wcdma: Connects only to a WCDMA network.
wcdma-preference: Connects to a WCDMA network preferentially.
Usage guidelines
The available parameters depend on the modem model.
Specify the nr keyword with caution. On an NSA network, if you specify the nr keyword for the modem to connect only to an NR network, the modem might fail to connect to the Internet.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify the LTE service for the 4G/5G modem.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] mode lte
modem reboot
Use modem reboot to reboot a mobile communication modem.
Syntax
modem reboot
Views
Cellular interface view
Predefined user roles
network-admin
Usage guidelines
CAUTION: This command will disconnect the established modem connections. Before executing this command, make sure you understand its impact on the live network. |
A mobile communication modem module can automatically detect running errors and reboot. If the mobile communication modem fails to reboot by itself, you can use this command to reboot it.
Examples
# Manually reboot the mobile communication modem.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] modem reboot
modem response
Use modem response to set a mobile communication modem response timer and a consecutive response failure threshold for auto recovery.
Use undo modem response to restore the default.
Syntax
modem response timer time auto-recovery threshold
undo modem response
Default
The response timer is 10 seconds and the consecutive response failure threshold is 3.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
timer time: Sets the response timer, in the range of 1 to 300, in seconds.
auto-recovery threshold: Specifies the consecutive response failure threshold for auto recovery. The value range for the threshold argument is 0 to 10. To disable auto recovery, set the value to 0.
Usage guidelines
A mobile communication modem might malfunction in an unstable mobile communication network or when the application environment changes. During a malfunction, the modem cannot respond to the device's requests or configuration commands. If the device does not receive any responses from the mobile communication modem before the timer times out, a response failure occurs. When the number of consecutive response failures reaches the threshold, the device restarts the mobile communication modem automatically. This releases the user from manually rebooting the modem.
The device does not restart the mobile communication modem when the mobile communication modem has not made a successful dialup since the last restart. This restriction avoids repeated restarts of the mobile communication modem when there are configuration errors.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Set the response timer to 20 seconds and the consecutive response failure threshold for auto recovery to 4.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] modem response timer 20 auto-recovery 4
pin modify
Use pin modify to modify the PIN of a SIM/UIM card.
Syntax
pin modify current-pin new-pin
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
current-pin: Specifies the current PIN of the SIM/UIM card, a string of 4 to 8 digits.
new-pin: Specifies the new PIN, a string of 4 to 8 digits.
Usage guidelines
The new PIN is saved on the SIM/UIM card.
If PIN verification is enabled, execute the pin verify command to save the new PIN on the device after the PIN is modified.
Failure to modify the PIN in a maximum number of attempts locks the SIM/UIM card. The maximum number of attempts depend on the mobile communication modem model. To unlock the card, execute the pin unlock command.
For some mobile communication modems, you can modify their PINs only when the mobile communication modems pass the PIN authentication.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Modify the PIN of a SIM/UIM card.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] pin modify 1234 4321
PIN will be changed to “4321”. Continue? [Y/N]:y
PIN has been changed successfully.
Related commands
pin unlock
pin verification enable
pin verify
pin unlock
Use pin unlock to specify the Personal Unlock Code (PUK) to unlock a SIM/UIM card.
Syntax
pin unlock puk new-pin
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
puk: Specifies the PUK of the SIM/UIM card, a string of 4 to 8 digits. The PUK code of a SIM/UIM card is provided by the network service provider.
new-pin: Specifies the new PIN, a string of 4 to 8 digits.
Usage guidelines
A SIM/UIM card will be locked in the following circumstances:
· Consecutive PIN modification failures.
· Consecutive failures for enabling or disabling PIN authentication.
· Consecutive PIN authentication failures.
If the SIM/UIM card is locked, the modem cannot be used. To unlock the card, you can use the pin unlock command. The new PIN is saved on the SIM/UIM card.
If PIN verification is enabled, use the pin verify command to save the new PIN on the device after the SIM/UIM card is unlocked.
If you consecutively fail to unlock a card by using the PUK, the card will be locked permanently. To unlock a permanently locked card, contact the service provider of the card.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Use the PUK to unlock a SIM/UIM card.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] pin unlock 87654321 1234
PIN will be unlocked and changed to “1234”. Continue? [Y/N]:y
PIN has been unlocked and changed successfully.
Related commands
pin modify
pin verification enable
pin verification enable
Use pin verification enable to enable PIN verification for a mobile communication modem.
Use undo pin verification enable to disable PIN verification for a mobile communication modem.
Syntax
pin verification enable [ pin ]
undo pin verification enable [ pin ]
Default
The default setting for this command depends on the modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
pin: Specifies the PIN of the SIM/UIM card, a string of 4 to 8 digits.
Usage guidelines
If PIN verification is enabled, PIN verification is performed after you perform any of the following tasks:
· Install a mobile communication modem.
· Reboot the device.
· Execute the modem reboot command to reboot a mobile communication modem.
· Hot swap a USB mobile communication modem.
· Cold boot the device where a SIC-mobile communication modem is installed.
To perform PIN verification, you also need to execute the pin verify command to save the PIN of the SIM/UIM card on the device. After the PIN is saved on the device, the PIN is used for verification automatically when required.
You might be required to provide the current PIN when you enable or disable PIN verification. Consecutive failures for enabling or disabling PIN verification lock a SIM/UIM card. To unlock the card, execute the pin unlock command.
For some mobile communication modems, you can disable PIN verification only when the mobile communication modems pass PIN authentication.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Enable PIN authentication.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] pin verification enable 1234
Related commands
pin unlock
pin verify
pin verify
Use pin verify to specify the PIN of a SIM/UIM card on a mobile communication modem.
Use undo pin verify to restore the default.
Syntax
pin verify { cipher | simple } string
undo pin verify
Default
No PIN is specified for a SIM/UIM card.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
cipher ciphered-pin: Specifies a PIN in encrypted form.
simple pin: Specifies a PIN in plaintext form. For security purposes, the PIN specified in plaintext form will be stored in encrypted form.
string: Specifies the PIN. Its plaintext form is 4 to 8 digits long. Its encrypted form is a string of 37 to 41 characters.
Usage guidelines
This command saves the PIN of the SIM/UIM card on the device. The PIN is used for verifying the mobile communication modem when PIN verification is performed. You can execute this command before or after you enable PIN verification.
Consecutive PIN verification failures might lock a SIM/UIM card. To unlock the card, execute the pin unlock command.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify the plaintext form PIN 1234 for the SIM/UIM card.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] pin verify simple 1234
Related commands
pin unlock
pin verification enable
plmn search
Use plmn search to search for available mobile networks.
Syntax
plmn search
Views
Cellular interface view
Predefined user roles
network-admin
Usage guidelines
Before you use a mobile communication modem to access a mobile network, use the plmn search command to search a PLMN for available mobile networks. The search takes a few minutes. After the search is complete, the CLI displays the available mobile networks. Some mobile communication modems automatically access an available network. You can also specify a mobile network for the mobile communication modem from the available mobile networks.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Search for mobile networks on Cellular 2/4/0.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] plmn search
PLMN search done.
Available PLMNs:
PLMN No. MCC MNC Status Type
01 460 00 Current GSM
02 460 00 Available UTRAN
03 460 01 Forbidden GSM
Table 7 Command output
Field |
Description |
PLMN No |
PLMN number. |
MCC |
Mobile Country Code. |
MNC |
Mobile Network Code: · 00, 02, and 07—China Mobile. · 01—China Unicom. · 03—China Telecom. |
Status |
Status of the mobile network: · Current. · Available. · Forbidden. |
Type |
Type of the mobile network. |
Related commands
display cellular
plmn select
plmn select
Use plmn select to configure the mobile network selection mode.
Syntax
plmn select { auto | manual mcc mnc }
Default
The default setting for this command depends on the modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
auto: Specifies the auto selection mode. The modem automatically selects a mobile network.
manual: Specifies the manual selection mode.
mcc: Specifies the mobile country code (MCC) in the range of 0 to 65535.
mnc: Specifies the mobile network code (MNC) in the range of 0 to 65535.
Usage guidelines
For manual selection, you can first use the plmn search command to obtain the MCC and MNC of a mobile network.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Manually specify a mobile network.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] plmn select manual 65524 65524
Related commands
display cellular
plmn search
reset counters controller cellular
Use reset counters controller cellular to clear statistics on cellular interfaces.
Syntax
reset counters controller cellular [ interface-number ]
Views
User view
Predefined user roles
network-admin
Parameters
cellular [ interface-number ]: Specifies cellular interfaces or a cellular interface by its number. If you do not specify the interface-number argument, this command clears statistics on all cellular interfaces. If you specify the interface-number argument, this command clears statistics on the specified cellular interface.
Usage guidelines
To collect traffic statistics on an interface during a period of time, first use the reset counters controller cellular command to clear the existing statistics on the interface.
Examples
# Clear statistics on Cellular 2/4/0.
<Sysname> reset counters controller cellular 2/4/0
Related commands
display controller cellular
rssi
Use rssi to set the RSSI thresholds for a mobile communication modem.
Use undo rssi to restore the default.
Syntax
rssi { 1xrtt | evdo | gsm | lte } { low lowthreshold | medium mediumthreshold } *
undo rssi { 1xrtt | evdo | gsm | lte } [ low | medium ]
Default
The lower and upper RSSI thresholds for a mobile communication modem are –150 dBm and 0 dBm, respectively.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
1xrtt: Specifies the 1xRTT mode.
evdo: Specifies the EVDO mode.
gsm: Specifies the GSM mode.
lte: Specifies the LTE mode.
low lowthreshold: Specifies the lower RSSI threshold value in the range of 0 to 150, which represents a lower RSSI threshold in the range of –150 dBm to 0 dBm. The value of lowthreshold cannot be smaller than the value of mediumthreshold because the system automatically adds a negative sign to the RSSI thresholds.
medium mediumthreshold: Specifies the upper RSSI threshold value in the range of 0 to 150, which represents an upper RSSI threshold in the range of –150 dBm to 0 dBm.
Usage guidelines
The device performs the following operations based on the actual RSSI of the mobile communication modem:
· Sends a trap that indicates high RSSI when the RSSI exceeds the upper threshold.
· Sends a trap that indicates normal RSSI when the RSSI is between the lower threshold and upper threshold (included).
· Sends a trap that indicates low RSSI when the RSSI drops to or below the lower threshold.
· Sends a trap that indicates low RSSI every 10 minutes when the RSSI remains equal to or smaller than the lower threshold.
To view the RSSI change information for a mobile communication modem, use the display cellular command.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Set the lower threshold for a mobile communication modem in GSM mode to –110 dBm.
<Sysname> system-view
[Sysname] controller cellular 0/0
[Sysname-Cellular0/0] rssi gsm low 110
sendat
Use sendat to issue a configuration directive to a mobile communication modem.
Syntax
sendat at-string
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
at-string: Specifies a configuration directive string, a string of 1 to 300 characters. This argument can be an AT directive (containing +++, A/, or be any string beginning with AT) or a CNS directive. For more information about AT directives, see the sendat command in Layer 2—WAN Access Command Reference. Table 8 describes the CNS directive samples.
Table 8 CNS directive description
Directive |
Description |
CNSn |
Controls the CNS heartbeat debugging switch. · n = 00000500000000000000—Enables CNS heartbeat debugging. · n = 00000800000000000000—Disables CNS heartbeat debugging. |
Usage guidelines
The sendat command does not verify the configuration directive. Each time it issues one configuration directive to the mobile communication modem, lowercase characters are automatically converted to uppercase characters.
One sendat command issues one configuration directive. To issue multiple configuration directives to a modem, you must repeat the sendat command.
Configuration directives might cause malfunction of a mobile communication modem. When you issue a configuration directive to the modem, make sure you understand the impact on the mobile communication modem.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Issue the ATD169 directive to the mobile communication modem to call number 169.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] sendat ATD169
# Issue the cns00000500000000000000 directive to the mobile communication modem to enable CNS heartbeat debugging.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] sendat cns00000500000000000000
set primary
Use set primary to set the secondary SIM card as the primary SIM card.
Use undo set primary to restore the default.
Syntax
set primary
undo set primary
Default
On a dual-SIM single-standby (DSSS) device, the SIM card at the first cellular interface is the primary and the SIM card at the second cellular interface is the secondary.
Views
Cellular interface view
Predefined user roles
network-admin
Usage guidelines
Application scenarios
This command is applicable when you want to use the secondary SIM card of a DSSS mobile communication device as the primary SIM card. For example, the corresponding ISP of the secondary SIM card might have better network coverage, signal quality, or more favorable charges than that of the default primary SIM card. In this situation, you can use this command to set the secondary SIM card as the primary one.
Operating mechanism
After this command is executed on the cellular interface hosting the secondary SIM card, the mobile communication modem is forcibly restarted. The secondary SIM card is set primary after the restart finishes. The device will use the new primary SIM card for communication. To restore the primary SIM card to the default, execute the undo set primary command.
Restrictions and guidelines
· This command is applicable to only DSSS mobile communication devices.
· This command is supported only on the cellular interface inserted with the default secondary SIM card. If you execute this command on the cellular interface inserted with the default primary SIM card, the device will prompt a configuration failure.
· Before a primary/secondary SIM card switchover, make sure the secondary SIM card is inserted and the network is available. If this command is executed without the secondary SIM card inserted, it will not take effect immediately and the mobile communication modem will not restart. If the secondary SIM card is inserted later, the modem will not automatically restart. In this situation, you must manually restart the modem. After the restart, the modem will automatically set the secondary SIM card as the primary SIM card.
· If the device is already connected to the network, switching the primary SIM card will terminate the connection. Before executing this command, make sure the disconnection does not impact the related services or user consent has been obtained.
· When you configure the set primary and sim switch-back enable commands on the cellular interface inserted with the default secondary SIM card, follow these restrictions and guidelines:
¡ If you execute the sim switch-back enable command after the set primary command, the device will prompt a failure to issue the sim switch-back enable command.
¡ You can execute the set primary command after the sim switch-back enable command. However, only the set primary command will take effect.
Examples
# Set the SIM card at Cellular1/1 as the primary SIM card.
<Sysname> system-view
[Sysname] controller cellular 1/1
[Sysname-Cellular1/1] set primary
modem reboot
sim switch-back enable
shutdown
Use shutdown to shut down a cellular interface.
Use undo shutdown to bring up a cellular interface.
Syntax
shutdown
undo shutdown
Default
The cellular interface is up.
Views
Cellular interface view
Predefined user roles
network-admin
Examples
# Shut down Cellular 2/4/0.
<Sysname> system-view
[Sysname] interface cellular 2/4/0
[Sysname-Cellular2/4/0] shutdown
trust-imsi
Use trust-imsi to configure a trusted IMSI.
Use undo trust-imsi to remove a trusted IMSI.
Syntax
trust-imsi string-imsi
undo trust-imsi [ string-imsi ]
Default
No trusted IMSI is configured.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
string-imsi: Specifies an IMSI. The string-imsi argument is a case-insensitive string of 1 to 31 characters.
Usage guidelines
For a successful dialup, configure the IMSI of the SIM card as a trusted IMSI.
You can configure a maximum of 16 trusted IMSIs.
Examples
# Configure trusted IMSI hccc123456789 for Cellular 0/0.
<Sysname> system-view
[Sysname] controller cellular 0/0
[Sysname-Cellular0/0] trust-imsi hccc123456789
3G modem-specific management commands
gsm band
Use gsm band to specify a GSM frequency band.
Use undo gsm band to restore the default.
Syntax
gsm band { egsm900 | gsm450 | gsm480 | gsm750 | gsm850 | gsm1800 | gsm1900 | pgsm900 | rsgm900 }
undo gsm band
Default
No GSM band is specified.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
egsm900: Specifies the E-GSM 900 MHz band.
gsm450: Specifies the GSM 450 MHz band.
gsm480: Specifies the GSM 480 MHz band
gsm750: Specifies the GSM 750 MHz band.
gsm850: Specifies the GSM 850 MHz band.
gsm1800: Specifies the GSM 1800 MHz band.
gsm1900: Specifies the GSM 1900 MHz band.
pgsm900: Specifies the P-GSM 900 MHz band.
rgsm900: Specifies the GSM-R 900 MHz band.
Usage guidelines
This command is supported only by Sierra MC7354 (ATT version) and MC7304 4G modules.
Multiple frequency bands are available for accessing the GSM network. When the network environment changes, the 3G/4G modem might change the working band automatically to adapt to the change. To avoid link instability caused by frequency changes, you can specify a GSM band for the 3G/4G modem.
Examples
# Specify the GSM 1800 MHz band for the 3G/4G modem.
<Sysname> system-view
[Sysname] controller cellular 0/0
[Sysname-Cellular0/0] gsm band gsm1800
Related commands
lte band
wcdma band
profile create
Use profile create to create a profile for the 3G modem.
Syntax
profile create profile-number { dynamic | static apn } authentication-mode { none | { chap | pap } user username [ password password ] }
Default
The default setting for this command depends on the modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
profile-number: Specifies a profile number. The value range varies by the modem model.
dynamic: Uses an access point automatically assigned by the service provider.
static apn: Specifies the access point provided by the service provider. It is a string of 1 to 100 characters. Whether the string is case-sensitive varies by service providers.
authentication-mode: Specifies the authentication mode, which can be none, pap, or chap.
none: Performs no authentication.
chap: Specifies CHAP authentication.
pap: Specifies PAP authentication.
user username: Specifies the username provided by the service provider. It is a case-sensitive string of 1 to 32 characters.
password password: Specifies the authentication password provided by the service provider. It is a case-sensitive string of 1 to 32 characters.
Usage guidelines
If you specify chap or pap, make sure the authentication settings are identical to those assigned by the service provider.
Examples
# Create a profile for Cellular 2/4/0. Specify the profile number as 1 and the access point name as cmnet, and specify the PAP authentication mode.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] profile create 1 static cmnet authentication-mode pap user abc password abc
Related commands
display cellular
profile delete
profile delete
Use profile delete to delete a profile for the 3G modem.
Syntax
profile delete profile-number
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
profile-number: Specifies a profile by its number.
Examples
# Delete profile 1 for Cellular 2/4/0.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] profile delete 1
Related commands
display cellular
profile create
profile main
Use profile main to specify the primary and backup profiles for 3G modem dialup.
Use undo profile main to restore the default.
Syntax
profile main profile-M-number backup profile-B-number
undo profile main
Default
Profile 1 is used for 3G modem dialup.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
main profile-M-number: Specifies the primary profile by its number. The value range varies by the modem model.
backup profile-B-number: Specifies the backup profile by its number. The value range varies by the modem model.
Usage guidelines
The primary profile always has priority over the backup profile. For each dialup connection establishment, the 3G modem uses the backup profile only when it has failed to dial up using the primary profile.
You must configure the same user name and password for the primary and backup profiles.
This command takes effect only on dialup connections initiated after the command is configured. It does not take effect on a dialup connection that has been established.
Examples
# Specify the profiles numbered 1 and 2 as the primary and backup profiles, respectively.
<sysname>system-view
[sysname]interface Cellular 2/4/0
[sysname-Cellular2/4/0]profile main 1 backup 2
serial-set
Use serial-set to channelize a cellular interface into a synchronous/asynchronous serial interface.
Use undo serial-set to delete a synchronous/asynchronous serial interface channelized from a cellular interface.
Syntax
serial-set set-number
undo serial-set set-number
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
set-number: Specifies the serial interface number.
Usage guidelines
The command names the serial interface as serial cellular-number:set-number.
Examples
# Channelize Cellular 2/4/0 into a serial interface.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] serial-set 0
wcdma band
Use wcdma band to specify a WCDMA band.
Use undo wcdma band to restore the default.
Syntax
wcdma band { wcdma800 | wcdma850 | wcdma900 | wcdma1700ip | wcdma1700us | wcdma1800 | wcdma1900 | wcdma2100 | wcdma2600 }
undo wcdma band
Default
No WCDMA band is specified.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
wcdma800: Specifies the WCDMA 800 MHz band.
wcdma850: Specifies the WCDMA 850 MHz band.
wcdma900: Specifies the WCDMA 900 MHz band.
wcdma1700jp: Specifies the Japan WCDMA 1700 MHz band.
wcdma1700us: Specifies the US WCDMA 1700 MHz band.
wcdma1800: Specifies the WCDMA 1800 MHz band.
wcdma1900: Specifies the WCDMA 1900 MHz band.
wcdma2100: Specifies the WCDMA 2100 MHz band.
wcdma2600: Specifies the WCDMA 2600 MHz band.
Usage guidelines
This command is supported only by Sierra MC7354 (ATT version) and MC7304 4G modules.
Multiple frequency bands are available for accessing the WCDMA network. When the network environment changes, the 3G/4G modem might change the working band automatically to adapt to the change. To avoid link instability caused by frequency changes, you can specify a WCDMA band for the 3G/4G modem.
Examples
# Specify the WCDMA 1700 MHz band for the 3G/4G modem.
<Sysname> system-view
[Sysname] controller cellular 0/0
[Sysname-Cellular0/0] wcdma band wcdma1700
Related commands
gsm band
lte band
4G/5G modem-specific management commands
apn
Use apn to specify an access point name (APN) for a 4G/5G modem.
Use undo apn to remove an APN.
Syntax
apn { dynamic | static apn }
undo apn
Default
No APN is specified for a 4G/5G modem.
Views
4G/5G modem profile view
Predefined user roles
network-admin
Parameters
dynamic: Uses an APN automatically assigned by the service provider.
static apn: Specifies the APN provided by the service provider. The apn argument is a string of 1 to 100 characters. Whether the string is case-sensitive depends on the service provider.
Usage guidelines
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify APN apn1 for 4G/5G modem profile test.
<Sysname> system-view
[Sysname] apn-profile test
[Sysname-apn-profile-test] apn static apn1
Related commands
apn-profile
apn-profile
Use apn-profile to create a 4G/5G modem profile.
Use undo apn-profile to remove a 4G/5G modem profile.
Syntax
apn-profile profile-name
undo apn-profile profile-name
Default
No 4G/5G modem profile exists.
Views
System view
Predefined user roles
network-admin
Parameters
profile-name: Specifies a 4G/5G modem profile name.
Usage guidelines
A 4G/5G modem profile takes effect only after you apply the profile to a 4G/5G interface. To remove a 4G/5G modem profile, you must first remove the association between the profile and the 4G/5G interface.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Create 4G/5G modem profile test.
<Sysname> system-view
[Sysname] apn-profile test
Related commands
apn-profile apply
apn-profile apply
Use apn-profile apply to specify 4G/5G modem profiles for an interface.
Use undo apn-profile apply to restore the default.
Syntax
apn-profile apply profile-name [ backup profile-name ]
undo apn-profile apply
Default
No 4G/5G modem profiles are specified for an interface.
Views
Eth-channel interface view
Predefined user roles
network-admin
Parameters
profile-name: Specifies a primary 4G/5G modem profile name.
backup profile-name: Specifies a backup 4G/5G modem profile name.
Usage guidelines
After you specify a 4G/5G modem profile for a 4G/5G modem, the 4G/5G modem uses the settings in the profile to negotiate with the service provider's device.
A primary profile always has priority over a backup profile. For each dialup connection establishment, the 4G/5G modem uses the backup profile only when it has failed to dial up using the primary profile.
This command takes effect only on dialup connections initiated after the command is configured. It does not take effect on a dialup connection that has been established.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify primary 4G/5G modem profile test and backup 4G/5G modem profile bktest for Eth-channel interface 2/4/0:0.
<Sysname> system-view
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] apn-profile apply test backup bktest
Related commands
apn-profile
attach-format imsi-sn split
Use attach-format imsi-sn split to specify a delimiter for the IMSI/SN binding authentication information.
Use undo attach-format imsi-sn split to restore the default.
Syntax
attach-format imsi-sn split splitchart [ sn-lenth sn-lenth ]
undo attach-format imsi-sn split
Default
No delimiter is specified for the IMSI/SN binding authentication information.
Views
4G/5G modem profile view
Predefined user roles
network-admin
Parameters
split splitchart: Specifies a delimiter. It can be a letter, a digit, or a sign such as a percent sign (%) or a pound sign (#).
sn-lenth sn-lenth: Specifies the truncation length of the SN during IMSI/SN binding authentication. The value is 10 or 20. The default is 20.
Usage guidelines
If IMSI/SN binding authentication is enabled, the IMSI/SN information is included in the authentication information in addition to the username. You need to configure a delimiter to separate different types of information. For example, if you specify the delimiter as #, the authentication information will be sent in the imsiinfo#sninfo#username format.
The truncation length of the SN during IMSI/SN binding authentication is the last several digits of the SN. For example, if you specify sn-lenth as 10, the last 10 digits of the SN are used. When this feature is used in conjunction with the H3C IMC, the truncated SN will populate the sninfo field in the access service menu.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Configure the pound sign (#) as the delimiter and the truncation length of the SN as 10 for the IMSI/SN binding authentication information.
<Sysname> system-view
[Sysname] apn-profile test
[Sysname-apn-profile-test] attach-format imsi-sn split # sn-lenth 10
Related commands
apn-profile
authentication-mode
Use authentication-mode to specify an authentication mode for accessing a 4G/5G network.
Use undo authentication-mode to restore the default.
Syntax
authentication-mode { pap | chap| pap-chap } user user-name password { cipher | simple } string
undo authentication-mode
Default
No authentication mode is specified for accessing a 4G/5G network.
Views
4G/5G modem profile view
Predefined user roles
network-admin
Parameters
chap: Specifies CHAP authentication.
pap: Specifies PAP authentication.
pap-chap: Specifies CHAP or PAP authentication.
user username: Specifies the username for authentication, a case-sensitive string of 1 to 32 characters.
cipher: Specifies a password in encrypted form.
simple: Specifies a password in plaintext form. For security purposes, the password specified in plaintext form will be stored in encrypted form.
string: Specifies the password. Its plaintext form is a case-sensitive string of 1 to 32 characters. Its encrypted form is a case-sensitive string of 1 to 73 characters.
Usage guidelines
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify the CHAP authentication mode for 4G/5G modem profile test. Specify the username as user1 and the password as 123456.
<Sysname> system-view
[Sysname] apn-profile test
[Sysname-apn-profile-test] authentication-mode chap user user1 password simple 123456
Related commands
apn-profile
bandwidth
Use bandwidth to configure the expected bandwidth for an Eth-channel interface.
Use undo bandwidth to restore the default.
Syntax
bandwidth bandwidth-value
undo bandwidth
Default
The expected bandwidth (in kbps) is the interface baud rate divided by 1000.
Views
Eth-channel interface view
Predefined user roles
network-admin
Parameters
bandwidth-value: Specifies the expected bandwidth in the range of 1 to 400000000 kbps.
Usage guidelines
The expected bandwidth for an interface affects the link costs in OSPF, OSPFv3, and IS-IS. For more information, see Layer 3—IP Routing Configuration Guide.
Examples
# Set the expected bandwidth for Eth-channel 2/4/0:0 to 1000 kbps.
<Sysname> system-view
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] bandwidth 1000
default
Use default to restore the default settings for an interface.
Syntax
default
Views
Eth-channel interface view
Predefined user roles
network-admin
Usage guidelines
CAUTION: The default command might interrupt ongoing network services. Make sure you are fully aware of the impact of this command before using it on a live network. |
This command might fail to restore the default settings for some commands for reasons such as command dependencies and system restrictions. Use the display this command in interface view to identify these commands. Then, use their undo forms or follow the command reference to individually restore their default settings. If your restoration attempt fails, follow the error message instructions to resolve the problem.
Examples
# Restore the default settings for Eth-channel 2/4/0:0.
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] default
description
Use description to configure the description of an interface.
Use undo description to restore the default.
Syntax
description text
undo description
Default
The description for an interface is in the interface name Interface format, for example, Echannel2/4/0:0 Interface.
Views
Eth-channel interface view
Predefined user roles
network-admin
Parameters
text: Sets an interface description, a case-sensitive string of 1 to 255 characters.
Usage guidelines
Configure the description of an interface for easy identification and management purposes.
You can use the display interface command to view the description for an interface.
Examples
# Configure the description for Eth-channel 2/4/0:0 as Echannel-interface.
<Sysname> system-view
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] description Echannel-interface
display interface eth-channel
Use display interface eth-channel to display information about the specified or all Eth-channel interfaces.
Syntax
display interface [ eth-channel [ channel-id ] ] [ brief [ description | down ] ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
eth-channel [ channel-id ]: Specifies Eth-channel interfaces or an Eth-channel interface by its number. If you do not specify the eth-channel keyword, the command displays information about all interfaces. If you specify the eth-channel keyword but not the channel-id argument, this command displays information about all Eth-channel interfaces.
brief: Displays brief interface information. If you do not specify this keyword, the command displays detailed interface information.
description: Displays complete interface descriptions. If you do not specify this keyword, the command displays only the first 27 characters of interface descriptions.
down: Displays information about interfaces in down state and the causes. If you do not specify this keyword, the command displays information about interfaces in all states.
Examples
# Display detailed information about Eth-channel 2/4/0:0, including its operating status.
<Sysname> display interface eth-channel 2/4/0:0
Echannel2/4/0:0
Current state: DOWN
Line protocol state: DOWN
Description: Echannel2/4/0:0 Interface
Bandwidth: 100000kbps
Maximum Transmit Unit: 1500
Internet protocol processing: disabled
IP Packet Frame Type:PKTFMT_ETHNT_2, Hardware Address: 000c-2963-b75d
IPv6 Packet Frame Type:PKTFMT_ETHNT_2, Hardware Address: 000c-2963-b75d
Output queue - Urgent queuing: Size/Length/Discards 0/100/0
Output queue - Protocol queuing: Size/Length/Discards 0/500/0
Output queue - FIFO queuing: Size/Length/Discards 0/75/0
Last link flapping: Never
Last clearing of counters: Never
Last 300 seconds input rate 0.00 bytes/sec, 0.00 packets/sec
Last 300 seconds output rate 0.00 bytes/sec, 0.00 packets/sec
Input: 0 packets, 0 bytes, 0 buffers
Output:0 packets, 0 bytes
# Display brief information about Eth-channel 2/4/0:0.
<Sysname> display interface eth-channel 2/4/0:0 brief
Brief information on interface(s) under route mode:
Link: ADM - administratively down; Stby - standby
Protocol: (s) - spoofing
Interface Link Protocol Main IP Description
Echannel2/4/0:0 UP UP(s) 192.168.80.239
# Display information about all Eth-channel interfaces in down state and the causes.
<Sysname> display interface eth-channel brief down
Brief information on interface(s) under route mode:
Link: ADM - administratively down; Stby - standby
Interface Link Cause
Echannel2/4/0:0 ADM Administratively
Table 9 Command output
Field |
Description |
Current state |
Physical link state of the interface: · Administratively DOWN—The interface has been shut down by using the shutdown command. · DOWN—The interface is administratively up, but its physical state is down (possibly because no physical link exists or the link has failed). · UP—The interface is both administratively and physically up. |
Line protocol state |
Data link layer state of the interface. The state is determined through automatic parameter negotiation at the data link layer. · UP—The data link layer protocol is up. · UP (spoofing)—The data link layer protocol is up, but the link is an on-demand link or does not exist. This attribute is typical of null interfaces and loopback interfaces. · DOWN—The data link layer protocol is down. |
Description |
Description for the interface. |
Bandwidth |
Expected bandwidth of the interface. |
Maximum Transmit Unit |
MTU of the interface. |
Internet address: ip-address/mask-length (Type) |
IP address of the interface and type of the address in parentheses. Possible IP address types include: · Primary—Manually configured primary IP address. · Sub—Manually configured secondary IP address. If the interface has both primary and secondary IP addresses, the primary IP address is displayed. If the interface has only secondary IP addresses, the lowest secondary IP address is displayed. · DHCP-allocated—DHCP allocated IP address. For more information, see DHCP client configuration in Layer 3—IP Services Configuration Guide. · BOOTP-allocated—BOOTP allocated IP address. For more information, see BOOTP client configuration in Layer 3—IP Services Configuration Guide. · PPP-negotiated—IP address assigned by a PPP server during PPP negotiation. For more information, see PPP configuration in Layer 2—WAN Access Configuration Guide. · Unnumbered—IP address borrowed from another interface. · Cellular-allocated—IP address allocated through the modem-manufacturer's proprietary protocol. For more information, see mobile communication modem management in Layer 2—WAN Access Configuration Guide. · MAD—IP address assigned to an IRF member device for MAD on the interface. For more information, see IRF configuration in Virtual Technologies Configuration Guide. · MTunnel—IP address of the multicast tunnel interface (MTI), which is the same as the IP address of the MD source interface. For more information, see multicast VPN configuration in IP Multicast Configuration Guide. |
Internet protocol processing: disabled |
The interface is not assigned an IP address and cannot process IP packets. |
Internet Address is 192.168.1.200/24 Primary |
IP address of the interface. The primary attribute indicates that the address is the primary IP address.. |
IP Packet Frame Type |
IPv4 packet framing format. |
Hardware Address |
MAC address of the interface. |
IPv6 Packet Frame Type |
IPv6 packet framing format. |
Output queue - Urgent queuing: Size/Length/Discards |
Packet statistics for urgent queuing in the output queue of the interface: · Size—Current number of packets in the queue. · Length—Maximum number of packets that can stay in the queue. · Discards—Number of dropped packets. |
Output queue - Protocol queuing: Size/Length/Discards |
Packet statistics for protocol queuing in the output queue of the interface: · Size—Current number of packets in the queue. · Length—Maximum number of packets that can stay in the queue. · Discards—Number of dropped packets. |
Output queue - FIFO queuing: Size/Length/Discards |
Packet statistics for FIFO queuing in the output queue of the interface: · Size—Current number of packets in the queue. · Length—Maximum number of packets that can stay in the queue. · Discards—Number of dropped packets. |
Last link flapping |
The amount of time that has elapsed since the most recent physical state change of the interface. This field displays Never if the interface has been physically down since device startup. |
Last clearing of counters |
Time when statistics on the logical interface were last cleared by using the reset counters interface command. If the statistics of the interface have never been cleared by using the reset counters interface command since the device started, this field displays Never. |
Last 300 seconds input rate |
Average input rate during the last 300 seconds: · bytes/sec—Average number of received bytes per second. · bits/sec—Average number of received bits per second. · packets/sec—Average number of received packets per second. |
Last 300 seconds output rate |
Average output rate over the last 300 seconds: · bytes/sec—Average number of sent bytes per second. · bits/sec—Average number of sent bits per second. · packets/sec—Average number of sent packets per second. |
Input: 0 packets, 0 bytes, 0 buffers |
Incoming packet statistics: · 0 packets—Packet number. · 0 bytes—Packet size in bytes. · 0 buffers—Number of buffered units. |
Output: 0 packets, 0 bytes |
Outgoing packet statistics: · 0 packets—Packet number. · 0 bytes—Packet size in bytes. |
Link |
Physical link state of the interface: · UP—The interface is physically up. · DOWN—The interface is physically down. · ADM—The interface has been shut down by using the shutdown command. To restore the physical state of the interface, use the undo shutdown command. · Stby—The interface is a backup interface in standby state. To see the primary interface, use the display interface-backup state command. |
Protocol |
Data link layer protocol state of the interface: · UP—The data link layer protocol of the interface is up. · DOWN—The data link layer protocol of the interface is down. · UP(s)—The data link layer protocol of the interface is up, but the link is an on-demand link or does not exist. The (s) attribute represents the spoofing flag. This value is typical of null interfaces and loopback interfaces. |
Main IP |
Main IP address of the interface. |
Description |
Description of the interface. |
Cause |
Cause for the physical link state of the interface to be DOWN. The value of the field varies by device model. Administratively represents that the interface has been manually shut down by using the shutdown command. To restore the physical state of the interface, use the undo shutdown command. |
display sim mqtt statistics
Use display sim mqtt statistics to display MQTT connection statistics.
Syntax
display sim mqtt statistics { all | connect | connect-fail | disconnect | packet }
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
all: Displays all MQTT connection statistics.
connect: Displays statistics about successful MQTT connections.
connect-fail: Displays statistics about failed MQTT connections.
disconnect: Displays statistics about disconnected MQTT connections.
packet: Displays MQTT message statistics.
Usage guidelines
This command is available only for devices installed with a 5G mobile communication modem.
Examples
# Display all MQTT connection statistics.
<Sysname> display sim mqtt statistics all
Connection information:
Sever info: www.example.com
Port: 1883
Connected at: 2022/05/01 10:13:33
Sever info: www.example.com
Port: 8883
SSL policy name:test-policy
Connected at: 2022/05/01 01:24:18
Disconnection information:
Sever info: www.example.com
Port: 8883
SSL policy name:test-policy
Disconnected at: 2022/05/01 10:13:19
Disconnection reason: User cleared connection settings.
Sever info: www.example.com
Port: 8883
SSL policy name:test-policy
Disconnected at: 2022/05/01 01:24:17
Disconnection reason: Keepalive timed out.
Connection fail information:
Connection failed at: 2022/05/01 00:33:21
Connection fail reason: Refused by the server
Connection failed at: 2022/05/01 10:23:21
Connection fail reason: Connection to the server timed out
Packet statistics:
Connect : 4 Connack : 4
Publish : 12 Puback : 1
Pubrec : 44 Pubrel : 44
Pubcomp : 2 Subscribe : 2
Suback : 1 Unsubscribe : 1
Unsuback : 0 Pingrep : 0
Pingresp : 0 SendDisconnect : 0
RecvDisconnect : 0 RecvData : 0
SendData : 20
Table 10 Command output
Field |
Description |
Connection information |
Successful MQTT connection information. |
Sever info |
Domain name or IP address of the MQTT server. |
Port |
Server-end port number for MQTT connection. |
SSL policy-name |
SSL client policy used for establishing an encrypted MQTT connection. |
Connected at |
Time at which the device established a connection to the MQTT server. |
Disconnection information |
MQTT disconnection information. |
Disconnected at |
Time at which the device was disconnected from the MQTT server. |
Disconnection reason |
Reason that caused disconnection of the device from the MQTT server. · Keepalive timed out. · User cleared connection settings. · Server sent disconnect packet. · Memory usage alert. |
Connection fail information |
Failed MQTT connection information. |
Connection failed at |
Time at which the device failed to establish a connection with the MQTT server. |
Connection fail reason |
Reason that caused failure of the device to establish a connection with the MQTT server. · Refused by the server. · Connection to the server timed out. · Server sent disconnect packet. · Memory usage alert. |
Packet statistics |
Statistics of messages for MQTT connection. |
Connect |
Number of connection requests sent by the device to the MQTT server. |
Connack |
Number of connection-request responses that the device received from the MQTT server. |
Publish |
Number of information publishings from the device to the MQTT server. |
Puback |
Number of information-publishing responses that the device received from the MQTT server. |
Pubrec |
Number of recorded information publishings from the device to the MQTT server. |
Pubrel |
Number of released information publishings from the device to the MQTT server. |
Pubcomp |
Number of completed information publishings from the device to the MQTT server. |
Subscribe |
Number of subscriptions from the device to the MQTT server. |
Suback |
Number of subscription acknowledgements from the MQTT server. |
Unsubscribe |
Number of canceled subscriptions from the device to the MQTT server. |
Unsuback |
Number of subscription cancel acknowledgement from the MQTT server. |
Pingreq |
Number of keepalive messages sent from the device to the MQTT server. |
Pingresp |
Number of keepalive acknowledge messages that the device received from the MQTT server. |
SendDisconnect |
Number of disconnection requests that the device sent to the MQTT server. |
RecvDisconnect |
Number of disconnection requests that the device received from the MQTT server. |
RecvData |
Number of data packets that the device received from the MQTT server. |
SendData |
Number of data packets that the device sent to the MQTT server. |
Related commands
reset sim mqtt statistics
display sim mqtt status
Use display sim mqtt status to display the MQTT connection status.
Syntax
display sim mqtt status
Views
Any view
Predefined user roles
network-admin
network-operator
Usage guidelines
This command is available only for devices installed with a 5G mobile communication modem.
Examples
# Display MQTT connection status.
<Sysname> display sim mqtt status
Connection status : Established
Reconnection interval : 10s
Reconnection retries : 5
Keepalive status : Normal
Keepalive interval : 30s
Keepalive retries : 5
Table 11 Command output
Field |
Description |
Connection status |
Connection status between the device and MQTT server. · Idle—No connection is established. · Established—A connection has been established. |
Connection interval |
Intervals at which the device retries connection to the MQTT server, in seconds. |
Connection retries |
Maximum number of connection retries from the device to the MQTT server. |
Keepalive status |
Keepalive status between the device and MQTT server: · Abnormal: The connection is not alive. · Normal: The connection is alive. · -: Keepalive is not enabled. |
Keepalive interval |
Intervals at which the device sends keepalive messages to the MQTT server, in seconds. |
Keepalive retries |
Maximum number of keepalive message transmission retries. |
Related commands
sim mqtt connect
sim mqtt keeplive
display sim register
Use display sim register to display automatic SIM registration information.
Syntax
display sim register
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display automatic SIM registration information.
<Sysname> display sim register
ICCID: 89860312805320133131
Registration status: Succeeded
Last registration time: 2021/12/20 15:00:00
Table 12 Command output
Item |
Description |
ICCID |
ICCID of the SIM, which uniquely identifies the SIM. |
Registration status |
Automatic SIM registration information. The value is Succeeded (only successful registration information is displayed) |
Last registration time |
Most recent SIM registration time. |
Related commands
sim register enable
eth-channel
Use eth-channel to channelize a cellular interface into an Eth-channel interface.
Use undo eth-channel to remove the Eth-channel interface channelized from a cellular interface.
Syntax
eth-channel channel-number
undo eth-channel channel-number
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
channel-number: Specifies an Eth-channel interface by its number.
Usage guidelines
This command names the Eth-channel interface channelized from a cellular interface as eth-channel cellular-number:channel-number.
Examples
# Channelize Cellular 2/4/0 into an Eth-channel interface.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] eth-channel 0
interface eth-channel
Use interface eth-channel to enter Eth-channel interface view.
Syntax
interface eth-channel interface-number
Views
System view
Predefined user roles
network-admin
Parameters
interface-number: Specifies an Eth-channel interface by its number.
Examples
# Enter Eth-channel 2/4/0:0 interface view.
<Sysname> system-view
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0]
ip address cellular-alloc
Use ip address cellular-alloc to enable an Eth-channel interface to obtain an IP address by using the modem-manufacturer's proprietary protocol.
Use undo ip address cellular-alloc to restore the default.
Syntax
ip address cellular-alloc
undo ip address cellular-alloc
Default
An Eth-channel interface does not obtain an IP address by using the modem-manufacturer's proprietary protocol.
Views
Eth-channel interface view
Predefined user roles
network-admin
Usage guidelines
To enable an interface to obtain an IP address from the modem by using the modem-manufacturer's proprietary protocol, use the ip address cellular-alloc command.
To enable an interface to obtain an IP address from the modem by using DHCP, use the ip address dhcp-alloc command.
The IP address of the modem is automatically allocated by the service provider.
Examples
# Channelize Cellular 2/4/0 into an Eth-channel interface. Enable the Eth-channel interface to obtain an IP address by using the modem-manufacturer's proprietary protocol.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] eth-channel 0
[Sysname-Cellular2/4/0] quit
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] ip address cellular-alloc
ipv6 address cellular-alloc
Use ipv6 address cellular-alloc to enable an interface to obtain an IPv6 address by using the modem-manufacturer's proprietary protocol.
Use undo ipv6 address cellular-alloc to restore the default.
Syntax
ipv6 address cellular-alloc
undo ipv6 address cellular-alloc
Default
An interface does not obtain an IPv6 address by using the modem-manufacturer's proprietary protocol.
Views
Eth-channel interface view
Predefined user roles
network-admin
Usage guidelines
To enable an interface to obtain an IPv6 address by using the modem-manufacturer's proprietary protocol, use the ipv6 address cellular-alloc command.
To enable an interface to obtain an IP address by using DHCP, use the ipv6 address dhcp-alloc command.
The IPv6 address of the modem is automatically allocated by the service provider.
Examples
# Channelize Cellular 2/4/0 into an Eth-channel interface. Enable the Eth-channel interface to obtain an IPv6 address by using the modem-manufacturer's proprietary protocol.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Cellular2/4/0] eth-channel 0
[Sysname-Cellular2/4/0] quit
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] ipv6 address cellular-alloc
Related commands
ip address cellular-alloc
lte band
Use lte band to specify a band for a 4G/5G modem.
Use undo lte band to restore the default.
Syntax
lte band band-number
undo lte band
Default
The default setting for this command varies by 4G/5G modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
band-number: Specifies a band for a 4G/5G modem. The available bands vary by modem model.
Usage guidelines
This command is supported by the following 4G/5G modems:
· Sierra MC7354 and MC7304.
· Long Sung U8300C, U8300W, and U8300.
· WNC DM11-2.
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify band 3 for Cellular 2/4/0.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Controller-Cellular2/4/0] lte band 3
mtu
Use mtu to set the maximum transmission unit (MTU) for an interface.
Use undo mtu to restore the default.
Syntax
mtu size
undo mtu
Default
The MTU of an interface is 1500 bytes.
Views
Eth-channel interface view
Predefined user roles
network-admin
Parameters
size: Sets the MTU in bytes.
Examples
# Set the MTU for Eth-channel 2/4/0:0 to 1430 bytes.
<Sysname> system-view
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] mtu 1430
nr band
Use nr band to specify a 5G NR frequency band.
Use undo nr band to restore the default.
Syntax
nr band nr-band-number
undo nr band
Default
The default setting of this command varies by modem model.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
nr-band-number: Specifies a 5G NR frequency band. The supported frequency bands depend on the modem model.
Usage guidelines
This command is supported only by 5G modems.
Examples
# Specify NR frequency band 3 for Cellular 2/4/0.
<Sysname> system-view
[Sysname] controller cellular 2/4/0
[Sysname-Controller-Cellular2/4/0] nr band n3
Related commands
gsm band
lte band
wcdma band
nr mode
Use nr mode to specify the 5G new radio (NR) network deployment mode for 5G modem network registration.
Use undo nr mode to restore the default.
Syntax
nr mode { nsa | sa | auto }
undo nr mode
Default
A 5G modem registers with a 5G NR network deployed in SA mode preferentially than that deployed in NSA mode.
Views
Cellular interface view
Predefined user roles
network-admin
Parameters
nsa: Specifies the NSA 5G NR network deployment mode for 5G modem network registration.
sa: Specifies the SA 5G NR network deployment mode for 5G modem network registration.
auto: Enables the 5G modem to register with a 5G NR network deployed in SA mode preferentially than that deployed in NSA mode.
Usage guidelines
Support for this command depends on the device model.
Examples
# Specify the NSA 5G network deployment mode for 5G modem network registration.
<Sysname> system-view
[Sysname] controller cellular 0/0
[Sysname-Cellular0/0]nr mode nsa
Related commands
nr band
pdp-type
Use pdp-type to specify the PDP data carrying protocol.
Use undo pdp-type to restore the default.
Syntax
pdp-type { ipv4 | ipv6 | ipv4v6 }
undo pdp-type
Default
The PDP data carrying protocol is IPv4 and IPv6.
Views
Apn-profile view
Predefined user roles
network-admin
Parameters
ipv4: Specifies the IPv4 protocol.
ipv6: Specifies the IPv6 protocol.
ipv4v6: Specifies the IPv4 and IPv6 protocols.
Usage guidelines
This command is not supported on devices that connect to a mobile communication network through a USB 4G modem.
Examples
# Specify the PDP data carrying protocol as IPv4.
<Sysname> system-view
[Sysname] apn-profile 1
[Sysname-apn-profile-1] pdp-type ipv4
reset counters interface
Use reset counters interface to clear the statistics on the specified or all Eth-channel interfaces.
Syntax
reset counters interface [ eth-channel [ channel-id ] ]
Views
User view
Predefined user roles
network-admin
Parameters
eth-channel [ channel-id ]: Specifies Eth-channel interfaces or an Eth-channel interface by its number. If you do not the eth-channel keyword, the command clears statistics on all interfaces. If you specify the eth-channel keyword but not the channel-id argument, this command clears statistics on all Eth-channel interfaces. If you specify both the eth-channel keyword and the channel-id argument, this command clears statistics on the specified Eth-channel interface.
Usage guidelines
Use this command to clear history statistics if you want to collect traffic statistics for a specific period.
Examples
# Clear the statistics on Eth-channel 2/4/0:0.
<Sysname> reset counters interface eth-channel 2/4/0:0
reset sim mqtt statistics
Use reset sim mqtt statistics to clear MQTT connection statistics.
Syntax
reset sim mqtt statistics { all | connect | connect-fail | disconnect | packet }
Views
User view
Predefined user roles
network-admin
Parameters
all: Clears all MQTT connection statistics.
connect: Clears successful MQTT connection statistics.
connect-fail: Clears failed MQTT connection statistics.
disconnect: Clears disconnected MQTT connection statistics.
packet: Clears MQTT message statistics.
Usage guidelines
This command is available only for devices installed with a 5G mobile communication modem.
Examples
# Clear all MQTT connection statistics.
<Sysname> reset sim mqtt statistics all
Related commands
display sim mqtt statistics
shutdown
Use shutdown to shut down an Eth-channel interface.
Use undo shutdown to bring up an Eth-channel interface.
Syntax
shutdown
undo shutdown
Default
An Eth-channel interface is up.
Views
Eth-channel interface view
Predefined user roles
network-admin
Examples
# Shut down Eth-channel 2/4/0:0.
<Sysname> system-view
[Sysname] interface eth-channel 2/4/0:0
[Sysname-Eth-channel2/4/0:0] shutdown
sim mqtt connect
Use sim mqtt connect to establish an MQTT connection.
Use undo sim mqtt connect to disconnect the MQTT connection.
Syntax
sim mqtt connect [ interval interval ] [ retry retries ]
undo sim mqtt connect
Default
The device does not establish an MQTT connection with an MQTT server.
Views
System view
Predefined user roles
network-admin
Parameters
interval interval: Specifies the interval at which the device retries connection to the MQTT server. The value is in the range of 0 to 3600, in seconds. The default value is 60 seconds.
retry retries: Specifies the maximum number of connection retries. The value is in the range of 1 to 255. The default value is 3.
Usage guidelines
After this command is configured, the device, acting as an MQTT client, will immediately attempt to establish an MQTT connection to the MQTT server. If the device fails to establish the connection, it will create an MQTT reconnection counter to count the reconnection attempts of the device to the MQTT server.
· If the device establishes a connection to the MQTT server successfully before the maximum number of connection retries is reached, the device will clear the reconnection count recorded on the device.
· If the device fails to establish a connection to the MQTT server when the maximum number of connection retries is reached, the connection establishment fails and the device will no longer attempt a reconnection. Check the settings of the MQTT server, including the IP address and domain name and then use this command to establish a connection again.
This command is available only for devices installed with a 5G mobile communication modem.
Examples
# Enable the device to establish an MQTT connection and to retry connection to the MQTT server at intervals of 5 seconds after the connection fails. Set the maximum number of connection retries to 10.
<Sysname> system-view
[Sysname] sim mqtt connect interval 5 retry 10
sim mqtt keepalive
Use sim mqtt keepalive to enable keepalive for the MQTT connection.
Use undo sim mqtt keepalive to disable keepalive for the MQTT connection.
Syntax
sim mqtt keepalive [ interval interval ] [ retry retries ]
undo sim mqtt keepalive
Default
Keepalive is disabled for the MQTT connection.
Views
System view
Predefined user roles
network-admin
Parameters
interval interval: Specifies the interval at which keepalive messages are sent. The value range for the argument is 1 to 65535, in seconds. The default value is 180 seconds.
retry retries: Specifies the maximum number of keepalive message transmission retries. The value range for the argument is 1 to 255. The default value is 3.
Usage guidelines
For information exchange between the MQTT client and MQTT server at any time, you can configure this command after the MQTT connection is established for the MQTT client and MQTT server to maintain the MQTT connection by exchanging keepalive messages.
The MQTT client sends a keepalive message to the MQTT server at the specified interval, and the MQTT server replies a response after receiving the keepalive message. If the device does not receive a response message from the MQTT server, it will create an MQTT connection keepalive counter to count the keepalive messages resent to the MQTT server.
· If the device receives a response message from the MQTT server before the maximum number of keepalive transmission retries is reached, the device will delete the keepalive counter.
· If the device does not receive a response message from the MQTT server when the maximum number of keepalive transmission retries is reached, the connection with the MQTT server is disconnected and the device will no longer send keepalive messages to the MQTT server and will disconnect from the MQTT server. After the MQTT connection is disconnected, reconfigure the sim mqtt connect command to try to re-establish a connection with the MQTT server.
This command is available only for devices installed with a 5G mobile communication modem.
Usage guidelines
# Set the interval at which the device sends a keepalive message to the MQTT server to 30 seconds and the maximum keepalive transmission retries to 5.
<Sysname> system-view
[Sysname] sim mqtt keepalive interval 30 retry 5
sim mqtt server
Use sim mqtt server to specify an MQTT server.
Use undo sim mqtt server to restore the default.
Syntax
sim mqtt server { hostname name | ip ipv4-address | ipv6 ipv6-address } [ ssl-client-policy policy-name ]
undo sim mqtt server
Default
No MQTT server is specified.
Views
System view
Predefined user roles
network-admin
Parameters
hostname name: Specifies an MQTT server by its host name, a case-insensitive string of 1 to 253 characters. The host name can contain letters, digits, hyphens (-), underscores (_), and dots (.).
ip ipv4-address: Specifies an MQTT server by its IPv4 address, in dotted decimal notation.
ipv6 ipv6-address: Specifies an MQTT server by its IPv6 address
ssl-client-policy policy-name: Specifies the SSL client policy that the device uses to establish an MQTT connection with the MQTT server. The argument is a case-insensitive string of 1 to 31 characters. If you do not specify this option, the MQTT client establishes a non-encrypted connection with the MQTT server.
Usage guidelines
This command is available only for devices installed with a 5G mobile communication modem.
The MQTT client and MQTT server can establish an unencrypted MQTT connection or an SSL-based encrypted MQTT connection.
· The server-end port number used for the unencrypted connection is 1883. By default, unencrypted MQTT connection is established.
· The server-end port number used for the encrypted connection is 8883. When establishing an encrypted MQTT connection, the device will act as an SSL client. You must configure the SSL client security policy matching the SSL server (MQTT server). For more information about SSL client policies, see SSL in the Security Configuration Guide.
Execute the undo sim mqtt server command with caution. It will disconnect the established MQTT connection.
Examples
# Specify the MQTT server with domain name www.example.com.
<Sysname> system-view
[Sysname] sim mqtt server hostname www.example.com
sim register enable
Use sim register enable to enable automatic SIM registration.
Use undo sim register enable to disable automatic SIM registration.
Syntax
sim register enable
undo sim register enable
Default
Automatic SIM registration is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
With automatic SIM registration enabled, when a new SIM is inserted into the device, the device will, within five minutes, send a registration request to the service provider's registration server and report device information and SIM information to the server.
· If the registration succeeds, the device saves the ICCID and registration time of the SIM card, and re-registers with the server every 30 days.
· If the registration fails, the device saves the ICCID and registration time of the SIM card, and resends a registration request to service provider's registration server at 1-hour intervals until the registration succeeds or the registration fails for 10 consecutive times.
This feature is supported only on a 5G modem.
Examples
# Enable automatic SIM registration.
<Sysname> system-view
[Sysname] sim register enable
Related commands
sim register server
sim register server
Use sim register server to specify a registration server.
Use undo sim register server to restore the default.
Syntax
sim register server { hostname name | ipv4 ipv4-address | ipv6 ipv6-address } [ port port-number ]
undo sim register server
Default
No registration server is specified.
Views
System view
Predefined user roles
network-admin
Parameters
hostname name: Specifies the registration server by its domain name. The value is case sensitive.
ipv4 ipv4-address: Specifies the registration server by its IPv4 address.
ipv6 ipv6-address: Specifies the registration server by its IPv6 address.
port port-number: Specifies the registration server listen port. The value is in the range of 1024 to 65535. The default is 9999.
Usage guidelines
After you specify a registration server and enable SIM registration, the device sends a registration request to the specified registration server if a new SIM is inserted or a SIM is replaced.
This feature is supported only on a 5G modem.
Examples
# Specify the registration server with domain name www.example.com and listen port 10000.
<Sysname> system-view
[Sysname] sim register server hostname www.example.com port 10000
Related commands
display sim register
sim register enable
sim register ssl-client-policy
sim register ssl-client-policy
Use sim register ssl-client-policy to configure an SSL client policy for automatic SIM registration.
Use undo sim register ssl-client-policy to restore the default.
Syntax
sim register ssl-client-policy policy-name
undo sim register ssl-client-policy
Default
No SSL client policy is configured for automatic SIM registration.
Views
System view
Predefined user roles
network-admin
Parameters
policy-name: Specifies an SSL client policy, a case-insensitive string of 1 to 31 characters.
Usage guidelines
After this command is configured, the device uses the SSL parameters specified in the SSL client policy to establish an HTTPS connection with the registration server. The SIM registration requests are sent to the registration server through the HTTPS connection. Only after the device is authenticated by the registration server, it can register with the server and report device information and SIM information to the server. For information about configuring an SSL client policy, see SSL configuration in Security Configuration Guide.
This feature is supported only on a 5G modem.
Examples
# Specify SSL client policy policy1 for SIM card registration.
<Sysname> system-view
[Sysname] sim register ssl-client-policy policy1
Related commands
display ssl client-policy (See SSL commands in Security Command Reference)
ssl client-policy (See SSL commands in Security Command Reference)