- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
07-Mobile communication modem management configuration | 273.35 KB |
Contents
Managing a mobile communication modem
About managing a mobile communication modem
Restrictions and guidelines: Mobile communication modem management
Restrictions and guidelines: Mobile communication modem management
Mobile communication modem management tasks at a glance
Configuring a 3G modem cellular interface
Configuring a 4G/5G modem cellular interface
Configuring the Eth-channel interface for a 4G/5G modem
Configuring basic parameters for the Eth-channel interface
Restoring the default settings for the Eth-channel interface
Configuring an IP address for the Eth-channel interface of a 4G/5G modem
Configuring wireless network connection settings
Configuring parameter profiles
Creating a parameter profile for a 3G modem
Creating a parameter profile for a 4G/5G modem
Specifying the primary and backup profiles
Specifying the primary or secondary SIM card
Setting the secondary SIM card as primary
Configuring automatic SIM registration
Establishing an MQTT connection
Issuing a configuration directive to a mobile communication modem
Configuring mobile communication modem reboot
Binding the IMSI of the SIM card to an interface
Display and maintenance commands for mobile communication modem management
Mobile communication modem management configuration examples
Example: Configuring 3G modem management
Managing a mobile communication modem
About managing a mobile communication modem
A mobile communication modem connects the device to a mobile communication network. Mobile communication modems include removable modems and built-in modems. The device supports only removable mobile communication modems.
Removable mobile communication modems include USB 3G modems, USB 4G modems, SIC-3G modems, SIC-4G modems, and SIC-5G modems. Built-in mobile communication modems include 5G modems.
USB 3G/4G modems and SIC-3G/4G/5G modems are available for the device.
· A USB 3G/4G modem is hot swappable. The device uses a fixed cellular interface to manage a USB 3G/4G modem. You can enter cellular interface view to perform configurations when the device does not have a USB 3G/4G modem installed. The configurations in cellular interface view remain after the USB 3G/4G modem is removed from the device.
· A SIC-3G/4G modem is not hot swappable. A SIC-5G modem is hot swappable. After a SIC-3G/4G/5G modem is installed in the device, the device creates a cellular interface automatically based on the number of the slot where the modem resides. The device uses this cellular interface to manage the SIC-3G/4G/5G modem. When the SIC-3G/4G/5G modem is removed, the system removes the cellular interface and the configurations on the interface.
A cellular interface can be channelized into a serial or an Eth-channel interface. The data link layer protocols of the serial interface and Eth-channel interface are PPP and Ethernet, respectively. The two interfaces support IP at the network layer.
The cellular interface of a 3G modem can only be channelized into a serial interface. The cellular interface of a 4G/5G modem can only be channelized into an Eth-channel interface.
Restrictions and guidelines: Mobile communication modem management
This feature is supported only on devices installed with USB 3G/4G mobile communication modems or SIC-3G/4G/5G mobile communication modems.
The MSR3620-X1, MSR3620-X1-WiNet, MSR3620-X1-XS, MSR3640-X1, MSR3640-XS, MSR3640-X1-HI, and MSR3660-XS do not support SIC-3G mobile communication modems.
Restrictions and guidelines: Mobile communication modem management
Follow these restrictions and guidelines when you configure mobile communication modem management:
· Do not remove a USB 3G/4G modem while it is transmitting data. As a best practice, execute the shutdown command to shut down the USB 3G/4G modem before removing it.
· A USB 3G/4G modem is not usable when the USB interface to which the modem is attached is shut down. For more information about shutting down a USB interface, see device management in Fundamentals Configuration Guide.
· Unless otherwise noted, the mobile communication modem configuration in this document is saved in the NVM of the mobile communication modem. To view the configuration, execute the display cellular command.
· You cannot manage USB 4G modems at the CLI. Therefore, some commands are not supported on devices that connect to a mobile communication network through a USB 4G modem. For more information, see the command reference.
Mobile communication modem management tasks at a glance
To management a mobile communication modem, perform the following tasks:
1. Configuring the mobile communication modem cellular interface
¡ Configuring a 3G modem cellular interface
¡ Configuring a 4G/5G modem cellular interface
2. Configuring the Eth-channel interface for a 4G/5G modem
3. Configuring wireless network connection settings
4. Configuring parameter profiles
5. (Optional.) Specifying the primary or secondary SIM card
6. (Optional.) Setting the secondary SIM card as primary
7. (Optional.) Configuring automatic SIM registration
8. (Optional.) Configuring PIN verification
9. (Optional.) Configuring a trusted IMSI
10. (Optional.) Configuring DM
11. (Optional.) Setting the RSSI thresholds
12. (Optional.) Establishing an MQTT connection
13. (Optional.) Issuing a configuration directive to a mobile communication modem
14. (Optional.) Configuring mobile communication modem reboot
¡ Configuring automatic reboot
15. (Optional.) Binding the IMSI of the SIM card to an interface
Configuring a 3G modem cellular interface
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular cellular-number
3. (Optional.) Configure a description for the cellular interface.
description text
By default, the description for a cellular interface is interface name Interface, for example, Cellular 2/4/0 Interface.
4. Channelize the cellular interface into a synchronous/asynchronous serial interface.
serial-set set-number
The serial interface name is in serial cellular-number:set-number format. You can configure PPP and DDR, and specify an IP address for the serial interface channelized from the cellular interface.
5. Bring up the cellular interface.
undo shutdown
By default, a cellular interface is up.
Configuring a 4G/5G modem cellular interface
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular cellular-number
3. Configure a description for the cellular interface.
description text
By default, the description for a cellular interface is interface name Interface, for example, Cellular 2/4/0 Interface.
4. Channelize the cellular interface into an Eth-channel interface.
eth-channel channel-number
The Eth-channel interface name is in eth-channel cellular-number:channel-number format. You can specify an IP address and configure DDR for the Eth-channel interface.
5. Bring up the cellular interface.
undo shutdown
By default, a cellular interface is up.
Configuring the Eth-channel interface for a 4G/5G modem
Configuring basic parameters for the Eth-channel interface
1. Enter system view.
system-view
2. Enter Eth-channel interface view.
interface eth-channel interface-number
3. Configure a description of the Eth-channel interface.
description text
By default, the description for an Eth-channel interface is interface name Interface, for example, Echannel2/4/0:0 Interface.
4. Set the MTU for the Eth-channel interface.
mtu size
By default, the MTU for an Eth-channel interface is 1500 bytes.
5. Set the expected bandwidth of the Eth-channel interface.
bandwidth bandwidth-value
By default, the expected bandwidth (in kbps) of an Eth-channel is the interface baud rate divided by 1000.
The baud rate of an Eth-channel interface is 100 Mbps.
6. Bring up the Eth-channel interface.
undo shutdown
By default, an Eth-channel interface is up.
Restoring the default settings for the Eth-channel interface
Restrictions and guidelines
CAUTION: Restoring the default interface settings might interrupt ongoing network services. Make sure you are fully aware of the impact of this command when you use it on a live network. |
The default 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 still fails, follow the error message instructions to resolve the problem.
Procedure
1. Enter system view.
system-view
2. Enter Eth-channel interface view.
interface eth-channel interface-number
3. Restore the default configurations.
default
Configuring an IP address for the Eth-channel interface of a 4G/5G modem
About this task
An Eth-channel interface can communicate with other devices only after it obtains an IP address. You can configure an IP address for an Eth-channel interface in the following ways:
· DHCP—The Eth-channel interface obtains the modem's IP address as its own IP address through DHCP. The modem's IP address is automatically allocated by the service provider.
· Modem manufacturer's proprietary protocol—The Eth-channel interface obtains the modem's IP address as its own IP address through the modem manufacturer's proprietary protocol. The modem's IP address is automatically allocated by the service provider.
· Manual configuration.
The ways for the Eth-channel interface to obtain an IP address are mutually exclusive. The most recent configuration overrides the previous one.
Restrictions and guidelines
Changing the IP address will result in dialup interruption. Immediate re-dialup upon interruption might not be supported by service providers.
Procedure
1. Enter system view.
system-view
2. Enter Eth-channel interface view.
interface eth-channel interface-number
3. Configure an IP address for the Eth-channel interface in one of the three ways.
¡ Obtain an IP address by using DHCP.
ip address dhcp-alloc
For more information about the command, see DHCP commands in Layer 3–IP Service Command Reference.
By default, an Eth-channel interface does not obtain an IP address through DHCP.
¡ Obtain an IP address by using the modem-manufacturer's proprietary protocol.
IPv4:
ip address cellular-alloc
IPv6:
ipv6 address cellular-alloc
By default, an Eth-channel interface does not obtain an IP address through the modem-manufacturer's proprietary protocol.
¡ Configure an IP address manually.
ip address ip-address { mask-length | mask } [ sub ]
By default, no IP address is specified for an Eth-channel interface.
Configuring wireless network connection settings
Restrictions and guidelines
A 3G modem can access a GSM, CDMA2000, TD-SCDMA, or WCDMA network. A 4G modem can access a GSM, CDMA2000, TD-SCDMA, WCDMA, or LTE network. A 5G modem can access a WCDMA, LTE, or 5G network.
A mobile communication modem selects a network to access from the available public land mobile networks (PLMNs). A PLMN is uniquely identified by the mobile country code (MCC) and the mobile network code (MNC). Some mobile communication modems can automatically access a mobile network. To manually specify a mobile network for a mobile communication modem, first search for available mobile networks.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. (Optional.) Search for PLMNs.
plmn search
4. Configure a PLMN searching mode.
plmn select { auto | manual mcc mnc }
The default setting depends on the modem model.
5. Specify the network connection mode.
mode { 1xrtt | auto | evdo | gsm | gsm-precedence | hybrid | lte | nr | td | td-precedence | wcdma | wcdma-precedence }
The default setting for this command and support for the arguments depend on the modem model.
6. (Optional.) Specify a GSM frequency band.
gsm band { egsm900 | gsm450 | gsm480 | gsm750 | gsm850 | gsm1800 | gsm1900 | pgsm900 | rsgm900 }
By default, no GSM frequency band is specified.
7. (Optional.) Specify a WCDMA frequency band.
wcdma band { wcdma800 | wcdma850 | wcdma900 | wcdma1700ip | wcdma1700us | wcdma1800 | wcdma1900 | wcdma2100 | wcdma2600 }
By default, no WCDMA frequency band is specified.
8. (Optional.) Specify an LTE frequency band.
lte band band-number
The default setting for this command and support for the band-number argument depend on the 4G/5G modem model.
9. Specify a 5G NR frequency band.
nr band nr-band-number
The default setting of this command and the value range for the nr-band-number argument depend on the modem model.
10. Specify the 5G NR network deployment mode for 5G modem network registration.
nr mode { nsa | sa | auto }
By default, a 5G modem registers with a 5G NR network deployed in SA mode preferentially than that deployed in NSA mode.
Configuring parameter profiles
About parameter profiles
A parameter profile defines the access point name (APN) and authentication mode for a mobile communication modem. When the authentication mode is None, no username and password are required for accessing a service provider's network. When the authentication mode is CHAP or PAP, a username and password must be configured as required by the service provider.
Creating a parameter profile for a 3G modem
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Create a parameter profile.
profile create profile-number { dynamic | static apn } authentication-mode { none | { chap | pap } user username [ password password ] }
The default setting depends on the modem model.
Creating a parameter profile for a 4G/5G modem
1. Enter system view.
system-view
2. Create a parameter profile and enter its view.
apn-profile profile-name
3. Specify the PDP data carrying protocol.
pdp-type { ipv4 | ipv6 | ipv4v6 }
By default, the data carrying protocol is IPv4 and IPv6.
4. Specify an APN.
apn { dynamic | static apn }
By default, no APN is specified.
5. Specify an authentication mode for accessing a 4G/5G network.
authentication-mode { pap | chap | pap-chap } user user-name password { cipher | simple } string
By default, no authentication is performed for accessing a 4G/5G network.
6. Specify a separator for the IMSI/SN binding authentication information.
attach-format imsi-sn split splitchart [ sn-lenth sn-lenth ]
By default, no separator is specified for the IMSI/SN binding authentication information and the truncation length of the SN during IMSI/SN binding authentication is 20.
Specifying the primary and backup profiles
About this task
By default, profile 1 is used for mobile communication modem dialup. The dialup fails if profile 1 does not exist.
You can also specify the primary and backup profiles for mobile communication modem dialup. The primary profile always has priority over the backup profile. For each dialup connection establishment, the mobile communication modem uses the backup profile only when it has failed to dial up using the primary profile.
Restrictions and guidelines
You must configure the same username and password for the primary and backup profiles.
Specifying the primary and backup profiles for a 3G modem
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Specify the primary and backup profiles for the 3G modem.
profile main main-profile-number backup backup-profile-number
By default, profile 1 is used for 3G modem dialup.
Specifying the primary and backup profiles for a 4G/5G modem
1. Enter system view.
system-view
2. Enter Eth-channel interface view.
interface eth-channel interface-number
3. Specify the primary and backup profiles for the 4G/5G modem.
apn-profile apply profile-name [ backup profile-name ]
By default, no profiles are specified for 4G/5G modem dialup.
Specifying the primary or secondary SIM card
About this task
On a device that uses dual SIM card, you can specify the use of the secondary SIM card when one of the following problems occurs:
· The mobile communication link signals of the primary SIM card are weak.
· The service provider network that the primary SIM card connects to is unavailable.
· The primary SIM card has failed.
If the problems of the primary SIM card are resolved, you can specify the use of the primary SIM card or enable the mobile communication modem to automatically switch back to the primary SIM card.
Hardware and feature compatibility
Only the MSR810-LMS and MSR810-LUS routers and routers installed with a SIC-4G-CNDE module support this feature.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Specify the primary or secondary SIM card.
sim switch-to card-number
By default, a mobile communication modem uses the primary SIM card.
4. Enable the mobile communication modem to automatically switch back to the primary SIM card.
sim switch-back enable [ wait-time time ]
By default, automatic switchback to the primary SIM card is disabled.
Setting the secondary SIM card as primary
About this task
This feature is applicable when you want to use the secondary SIM card of a dual-SIM single-standby (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 feature to set the secondary SIM card as the primary one.
After the set primary 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 feature is applicable to only DSSS mobile communication devices.
· This feature is supported only on the cellular interface inserted with the default secondary SIM card. If you configure this feature 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 feature is configured 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 configuring this feature, 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.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Set the secondary SIM card as the primary SIM card.
set primary
By default, the SIM card at the first cellular interface is the primary and the SIM card at the second cellular interface is the secondary.
Configuring automatic SIM registration
About this task
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.
After an SSL client policy is configured, the device will use the SSL parameters specified in the SSL client policy to establish an HTTPS connection with the registration server. 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.
· If the registration succeeds, the device saves the ICCID and registration time of the SIM, 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.
Hardware and feature compatibility
Hardware |
Feature compatibility |
MSR610 |
Yes |
MSR810, MSR810-W, MSR810-W-DB, MSR810-LM, MSR810-W-LM, MSR810-10-PoE, MSR810-LM-HK, MSR810-W-LM-HK, MSR810-LM-CNDE-SJK, MSR810-CNDE-SJK, MSR810-EI, MSR810-LM-EA, MSR810-LM-EI |
Yes |
MSR810-LMS, MSR810-LUS |
Yes |
MSR810-SI, MSR810-LM-SI |
Yes |
MSR810-LMS-EA, MSR810-LME |
Yes |
MSR1004S-5G, MSR1004S-5G-CN |
No |
MSR1104S-W, MSR1104S-W-CAT6, MSR1104S-5G-CN, MSR1104S-W-5G-CN |
Yes |
MSR2600-6-X1, MSR2600-15-X1, MSR2600-15-X1-T |
Yes |
MSR2600-10-X1 |
Yes |
MSR 2630 |
Yes |
MSR3600-28, MSR3600-51 |
Yes |
MSR3600-28-SI, MSR3600-51-SI |
Yes |
MSR3600-28-X1, MSR3600-28-X1-DP, MSR3600-51-X1, MSR3600-51-X1-DP |
Yes |
MSR3600-28-G-DP, MSR3600-51-G-DP |
Yes |
MSR3610-I-DP, MSR3610-IE-DP, MSR3610-IE-ES, MSR3610-IE-EAD, MSR-EAD-AK770, MSR3610-I-IG, MSR3610-IE-IG |
Yes |
MSR3610-X1, MSR3610-X1-DP, MSR3610-X1-DC, MSR3610-X1-DP-DC, MSR3620-X1, MSR3640-X1 |
Yes |
MSR3610, MSR3620, MSR3620-DP, MSR3640, MSR3660 |
Yes |
MSR3610-G, MSR3620-G |
Yes |
MSR3640-G |
Yes |
MSR3640-X1-HI |
Yes |
Hardware |
Feature compatibility |
MSR810-W-WiNet, MSR810-LM-WiNet |
Yes |
MSR830-4LM-WiNet |
Yes |
MSR830-5BEI-WiNet, MSR830-6EI-WiNet, MSR830-10BEI-WiNet |
Yes |
MSR830-6BHI-WiNet, MSR830-10BHI-WiNet |
No |
MSR2600-6-WiNet |
Yes |
MSR2600-10-X1-WiNet |
Yes |
MSR2630-WiNet |
Yes |
MSR3600-28-WiNet |
Yes |
MSR3610-X1-WiNet |
Yes |
MSR3610-WiNet, MSR3620-10-WiNet, MSR3620-DP-WiNet, MSR3620-WiNet, MSR3660-WiNet |
Yes |
Hardware |
Feature compatibility |
MSR860-6EI-XS |
Yes |
MSR860-6HI-XS |
Yes |
MSR2630-XS |
Yes |
MSR3600-28-XS |
Yes |
MSR3610-XS |
Yes |
MSR3620-XS |
Yes |
MSR3610-I-XS |
Yes |
MSR3610-IE-XS |
Yes |
MSR3620-X1-XS |
Yes |
MSR3640-XS |
Yes |
MSR3660-XS |
Yes |
Hardware |
Feature compatibility |
MSR810-LM-GL |
Yes |
MSR810-W-LM-GL |
Yes |
MSR830-6EI-GL |
Yes |
MSR830-10EI-GL |
Yes |
MSR830-6HI-GL |
No |
MSR830-10HI-GL |
No |
MSR1004S-5G-GL |
No |
MSR2600-6-X1-GL |
Yes |
MSR3600-28-SI-GL |
Yes |
Restrictions and guidelines
This feature is supported only on a 5G modem.
Procedure
1. Enter system view.
system-view
2. Specify a registration server by its IP address or domain name.
sim register server { hostname name | ipv4 ipv4-address | ipv6 ipv6-address } [ port port-number ]
By default, no registration server is specified.
3. Specify an SSL client policy for SIM registration.
sim register ssl-client-policy policy-name
By default, no SSL client policy is configured for SIM registration.
4. Enable automatic SIM registration.
sim register enable
By default, automatic SIM registration is disabled.
Configuring PIN verification
About this task
A UIM card is used in the CDMA network and a SIM card is used in other mobile networks. Each SIM/UIM card has a Personal Identification Number (PIN). PIN verification prevents unauthorized access to the SIM/UIM card.
To perform PIN verification, you need to save the PIN of the SIM/UIM card on the device by using the pin verify command and enable PIN verification. The pin verify command can be executed before and after you enable PIN verification. After the PIN is saved on the device, the PIN is used for verification automatically when required.
When PIN verification is enabled, PIN verification is performed after you perform any of the following tasks:
· Install a mobile communication modem.
· Reboot the device where a USB mobile communication modem is attached.
· 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.
If PIN verification fails after a maximum number of attempts, the SIM/UIM card is locked, and a PIN Unlocking Key (PUK) is required to unlock the card. The maximum number of attempts depends on the mobile communication modem model.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Enable PIN verification.
pin verification enable [ pin ]
The default setting depends on the modem model.
Whether you are required to enter the PIN when enabling PIN verification depends on the modem model.
4. Specify the PIN for verification.
pin verify { cipher | simple } string
By default, no PIN is configured on a device for mobile communication modem verification.
This command saves the PIN on the device.
5. (Optional.) Specify a PUK to unlock the SIM/UIM card.
pin unlock puk new-pin
After the SIM/UIM card is unlocked, execute the pin verify command to save the new PIN on the device.
6. (Optional.) Modify the PIN of the SIM/UIM card.
pin modify current-pin new-pin
The new PIN is saved in the SIM/UIM card.
After the PIN is modified, execute the pin verify command to save the new PIN on the device.
Configuring a trusted IMSI
About this task
For a successful dialup, configure the IMSI on the SIM card as a trusted IMSI.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Configure a trusted IMSI.
trust-imsi string-imsi
You can configure a maximum of 16 trusted IMSIs.
Configuring DM
|
NOTE: Support for DM depends on the modem model. |
About this task
Diagnostic and monitoring (DM) allows third-party debugging tools to diagnose and monitor the mobile communication modem through cellular interface debugging output. For more information about DM, see related mobile communication modem user manuals.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Enable DM.
dm-port open
The default setting for this command depends on the modem model.
Setting the RSSI thresholds
About this task
After setting the RSSI thresholds, you will stay informed about the RSSI changes.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Set the RSSI thresholds.
rssi { gsm | 1xrtt | evdo | lte } { low lowthreshold | medium mediumthreshold }
By default, the lower and upper RSSI thresholds for a mobile communication modem are –150 dBm and 0 dBm, respectively.
The value of lowthreshold cannot be smaller than the value of mediumthreshold because the system automatically adds a negative sign to the RSSI thresholds.
Establishing an MQTT connection
About this task
Message Queuing Telemetry Transport (MQTT) is a TCP/IP-based message transfer protocol in client/server model. It can provide real-time and reliable messaging services with lower overhead and bandwidth in remote connection.
As shown in Figure 1, in the MQTT protocol model, the device, acting as an MQTT client, proactively establishes an MQTT connection with the MQTT server. Over the MQTT connection, the device can publish messages to the MQTT server, or subscribe to the MQTT server for messages of other clients. For example, Client A, Client B, and Client C each have established an MQTT connection with the MQTT Server. When Client A publishes information about application A to the MQTT Server, Client B and Client C can subscribe to the MQTT Server for information about application A.
|
NOTE: In the current software version, the device supports only establishing an MQTT connection and does not support publishing and subscribing to application messages. |
Figure 1 MQTT message publish/subscribe pattern
Restrictions and guidelines
This feature is available only for a device installed with a 5G mobile communication modem.
If you specify an SSL client policy, make sure the policy is correct.
Procedure
1. Enter system view.
system-view
2. Specify an MQTT server.
sim mqtt server { hostname name | ip ipv4-address | ipv6 ipv6-address } [ ssl-client-policy policy-name ]
By default, no MQTT server is specified.
3. Establish an MQTT connection.
sim mqtt connect [ interval interval ] [ retry retries ]
By default, the device does not establish an MQTT connection with an MQTT server.
4. Enable keepalive for the MQTT connection.
sim mqtt keepalive [ interval interval ] [ retry retries ]
By default, keepalive is disabled for an MQTT connection.
Issuing a configuration directive to a mobile communication modem
Restrictions and guidelines
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.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Issue a configuration directive to the mobile communication modem.
sendat at-string
Configuring mobile communication modem reboot
Configuring automatic reboot
About this task
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 within the timeout interval, a response failure occurs. When the number of consecutive response failures reaches the threshold, the device restarts the mobile communication modem automatically.
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.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Configure the response timeout and the threshold for the number of consecutive timeouts to enable automatic reboot of the mobile communication modem.
modem response timer time auto-recovery threshold
By default, the response timeout is 10 seconds and the consecutive timeout threshold is 3.
The configuration is saved on the device rather than the mobile communication modem.
Configuring manual reboot
About this task
A mobile communication modem can automatically detect running errors and reboot. If the mobile communication modem fails to reboot by itself, you can use this command to manually reboot it.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Manually reboot the mobile communication modem.
modem reboot
CAUTION: This command will disconnect the established modem connections. Before executing this command, make sure you understand its impact on the live network. |
Binding the IMSI of the SIM card to an interface
About this task
A 4G/5G router must support PPP LCP negotiation of the IMSI/SI when it acts as a LAC to access the LNS in LAC-auto-initiated mode. After you bind the IMSI on the SIM card to a virtual PPP interface, the packets sent by the router carry the IMSI.
Restrictions and guidelines
This feature is not available for distributed devices or devices operating in IRF mode.
Procedure
1. Enter system view.
system-view
2. Enter cellular interface view.
controller cellular interface-number
3. Bind the IMSI on the SIM card to an interface.
imsi bind interface-type interface-number
By default, the IMSI on the SIM card is not bound to any interface.
Display and maintenance commands for mobile communication modem management
Execute display commands in any view and the reset command in user view.
Task |
Command |
Display the call connection information for the mobile communication modem. |
display cellular [ interface-number ] |
Display information about a cellular interface. |
display controller [ cellular [ interface-number ] ] |
Display information about an Eth-channel interface. |
display interface [ eth-channel [ channel-id ] ] [ brief [ description | down ] ] |
Display MQTT connection statistics. |
display sim mqtt statistics { all | connect | connect-fail | disconnect | packet } |
Display the MQTT connection status. |
display sim mqtt status |
Display SIM registration information. |
display sim register |
Clear the statistics for a cellular interface. |
reset counters controller [ cellular [ interface-number ] ] |
Clear the statistics for an Eth-channel interface. |
reset counters interface [ eth-channel [ channel-id ] ] |
Clear MQTT connection statistics. |
reset sim mqtt statistics { all | connect | connect-fail | disconnect | packet } |
Mobile communication modem management configuration examples
Example: Configuring 3G modem management
Network configuration
As shown in Figure 2:
· The router provides a USB 3G or SIC-3G modem.
· The PC dials up to access a 3G network through Dial-on-Demand Routing (DDR).
For more information about DDR dialup, see "Configuring DDR."
Procedure
# Create dialer group 1 and configure DDR to place calls for IP packets.
<Router> system-view
[Router] dialer-group 1 rule ip permit
# Channelize the cellular interface into a synchronous/asynchronous serial interface.
[Router] controller cellular 2/4/0
[Router-Cellular2/4/0] serial-set 0
[Router-Cellular2/4/0] quit
# Assign an IP address to interface Serial 2/4/0:0.
[Router] interface serial 2/4/0:0
[Router-Serial2/4/0:0] ip address 1.1.1.1 255.255.0.0
# Enable traditional DDR on interface Serial 2/4/0:0.
[Router-Serial2/4/0:0] dialer circular enable
# Associate interface Serial 2/4/0:0 with dialer group 1.
[Router-Serial2/4/0:0] dialer-group 1
# Set the interval for DDR to make the next call attempt to 5 seconds.
[Router-Serial2/4/0:0] dialer timer autodial 5
# Configure the dial string for placing calls as 666666.
[Router-Serial2/4/0:0] dialer number 666666
[Router-Serial2/4/0:0] quit
# Enable modem dial-in and dial-out on user line TTY 1.
[Router] line tty 1
[Router-line-tty1] modem enable both
Example: Configuring 4G/5G modem management
Network configuration
As shown in Figure 3:
· The router provides a USB 4G or SIC-4G/5G modem.
· The PC dials up to access a 4G/5G network through Dial-on-Demand Routing (DDR).
For more information about DDR dialup, see "Configuring DDR."
Procedure
# Configure dialer group 1 and configure DDR to place calls for IP packets.
<Router> system-view
[Router] dialer-group 1 rule ip permit
# Create a parameter profile for the 5G modem, and specify an APN automatically assigned by the service provider.
[Router] apn-profile dynamic1
[Router-apn-profile-dynamic] apn dynamic
[Router-apn-profile-dynamic] quit
# Channelize the cellular interface into an Eth-channel interface.
[Router] controller cellular 2/4/0
[Router-Cellular2/4/0] eth-channel 0
[Router-Cellular2/4/0] quit
# Enable Eth-channel 2/4/0:0 to obtain an IP address by using the modem-manufacturer's proprietary protocol.
[Router] interface eth-channel 2/4/0:0
[Router-Eth-channel2/4/0:0] ip address cellular-alloc
# Specify primary 5G modem profile test for Eth-channel interface 2/4/0:0.
[Sysname-Eth-channel2/4/0:0] apn-profile apply dynamic1
# Enable traditional DDR on Eth-channel 2/4/0:0.
[Router-Eth-channel2/4/0:0] dialer circular enable
# Associate Eth-channel 2/4/0:0 with dialer group 1.
[Router-Eth-channel2/4/0:0] dialer-group 1
# Set the interval for DDR to make the next call attempt to 5 seconds.
[Router-Eth-channel2/4/0:0] dialer timer autodial 5
# Configure the dial string for placing calls as *99#.(for China Mobile or China Unicom). For China Telecommunications, set the value to #777.
[Router-Eth-channel2/4/0:0] dialer number *99# autodial
# Configure an outbound dynamic rule on Eth-channel 2/4/0:0 to translate the source addresses of outgoing packets.
[Router-Eth-channel2/4/0:0] nat outbound
[Router-Eth-channel2/4/0:0] quit
# Configure a static route to 0.0.0.0/0.
[Router] ip route-static 0.0.0.0 0.0.0.0 eth-channel 2/4/0:0
Troubleshooting
Symptom
A mobile communication modem fails to function correctly. For example, the mobile communication modem receives no signals or fails to connect to service providers' networks.
Solution
To resolve the issue:
1. Execute the shutdown command and the undo shutdown command on the cellular interface.
2. If the mobile communication modem still fails to function, execute the modem reboot command on the cellular interface.
3. If the issue persists, contact H3C Support.