Fortinet white logo
Fortinet white logo

CLI Reference

config system 5g-modem

config system 5g-modem

Note

This command is available for model(s): FortiGate 50G 5G.

It is not available for: FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 120G, FortiGate 121G, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 200G, FortiGate 201E, FortiGate 201F, FortiGate 201G, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3200F, FortiGate 3201F, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 4800F, FortiGate 4801F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 50G DSL, FortiGate 50G SFP-POE, FortiGate 50G SFP, FortiGate 50G, FortiGate 51G, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 61E, FortiGate 61F, FortiGate 70F, FortiGate 71F, FortiGate 800D, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90E, FortiGate 90G, FortiGate 91E, FortiGate 91G, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 50G DSL, FortiWiFi 50G SFP, FortiWiFi 50G, FortiWiFi 60E DSLJ, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 80F 2R 3G4G DSL, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G DSL, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

Configure USB 5G modems.

config system 5g-modem
    Description: Configure USB 5G modems.
    config data-plan
        Description: Configure data plan.
        edit <name>
            set apn {string}
            set auth-type [none|pap|...]
            set password {password}
            set pdp-type [ipv4|ipv6|...]
            set username {string}
        next
    end
    config modem1
        Description: Configure 5G Modem1.
        set carrier-config [auto-gcf|auto-ptcrb|...]
        set custom-ipv4-netmask {ipv4-netmask}
        set default-gateway [auto|none]
        set default-netmask [auto|custom]
        set gps-service [enable|disable]
        set network-type [auto|4g|5g|...]
        config sim-switch
            Description: Configure SIM card switch.
            set active-sim-slot [slot-1|slot-2]
            set by-connection-state [enable|disable]
            set by-link-monitor [enable|disable]
            set by-sim-state [enable|disable]
            set link-monitor {string}
            set modem-disconnection-time {integer}
            set sim-switch-log-alert-interval {integer}
            set sim-switch-log-alert-threshold {integer}
        end
        set sim1-data-plan {string}
        set sim1-pin {password}
        set sim2-data-plan {string}
        set sim2-pin {password}
        set status [online|low-power]
    end
    set status [enable|disable]
end

config system 5g-modem

Parameter

Description

Type

Size

Default

status

Enable/disable USB 5G modem daemon.

option

-

enable

Option

Description

enable

Enable USB 5G modem daemon.

disable

Disable USB 5G modem daemon.

config data-plan

Parameter

Description

Type

Size

Default

apn

Login APN string for PDP-IP packet data calls.

string

Maximum length: 127

auth-type

Authentication type for PDP-IP packet data calls.

option

-

none

Option

Description

none

Username and password not required

pap

Use PAP authentication.

chap

Use CHAP authentication.

name

Data plan name.

string

Maximum length: 35

password

Authentication password for PDP-IP packet data calls.

password

Not Specified

pdp-type

Packet Data Protocol (PDP) context type.

option

-

ipv4v6

Option

Description

ipv4

IPv4 only

ipv6

IPv6 only.

ipv4v6

Dual stack for IPv4 and IPv6.

username

Authentication username for PDP-IP packet data calls.

string

Maximum length: 63

config modem1

Parameter

Description

Type

Size

Default

carrier-config

carrier-config selection mode.

option

-

auto-gcf

Option

Description

auto-gcf

Auto select carrier-config by SIM. When unrecognized SIM, use Generic GCF(World).

auto-ptcrb

Auto select carrier-config by SIM. When unrecognized SIM, use Generic PTCRB(North America).

manual

Manual select carrier-config by execute 5g-modem carrier-config switch command.

custom-ipv4-netmask

Netmask assigned by the DHCP server.

ipv4-netmask

Not Specified

255.255.255.255

default-gateway

Modem interface default gateway.

option

-

auto

Option

Description

auto

populate the gateway as assigned by modem internal DHCP server.

none

no default gateway, populate gateway to 0.0.0.0 without any next-hop gateway.

default-netmask

Modem interface default netmask.

option

-

auto

Option

Description

auto

populate the netmask as assigned by modem internal DHCP server.

custom

custom netmask via custom-ipv4-netmask configuration.

gps-service

Enable/disable Modem online mode.

option

-

enable

Option

Description

enable

Enable GPS service.

disable

Disable GPS service.

network-type

Modem network type.

option

-

auto

Option

Description

auto

Automatic detection

4g|5g

connect to 4G and 5G network only. Applies to 5G Non-Standalone (NSA) networks.

3g|4g

connect to 3G and 4G network only.

3g|5g

connect to 3G and 5G network only.

5g

connect to 5G network only, for networks use MIMO/mm waves technology. Applies to 5G Standalone(SA) networks.

4g

connect to 4G network only, for networks use LTE technology.

3g

connect to 3G network only, for networks use WCDMA technology

sim1-data-plan

data plan for SIM #1.

string

Maximum length: 35

sim1-pin

PIN code for SIM #1 (if applicable).

password

Not Specified

sim2-data-plan

data plan for SIM #2.

string

Maximum length: 35

sim2-pin

PIN code for SIM #2 (if applicable).

password

Not Specified

status

Enable/disable Modem online mode.

option

-

online

Option

Description

online

set modem to online mode.

low-power

set modem to persistant low power mode.(no RF signal)

config sim-switch

Parameter

Description

Type

Size

Default

active-sim-slot

set active SIM card slot to slot-1 or slot-2.

option

-

slot-1

Option

Description

slot-1

SIM slot 1

slot-2

SIM slot 2

by-connection-state

Enable/disable automatic switch of SIM by MODEM connection state (mobile data usage charges not incurred).

option

-

enable

Option

Description

enable

Enable SIM auto switch by modem connection state.

disable

Disable SIM auto switch by modem connection state.

by-link-monitor

Enable/disable automatic switch of SIM by link monitor (mobile data usage charges incurred).

option

-

disable

Option

Description

enable

Enable SIM auto switch by link monitor.

disable

Disable SIM auto switch by link monitor.

by-sim-state

Enable/disable automatic switch of SIM when MODEM SIM state is empty or in error.

option

-

enable

Option

Description

enable

Enable SIM auto switch when SIM state is empty or in error.

disable

Disable SIM auto switch when SIM state is empty or in error.

link-monitor

Set link monitor name.

string

Maximum length: 35

modem-disconnection-time

Configure connection-based automatic switch of SIM time interval in seconds (30 - 86400).

integer

Minimum value: 30 Maximum value: 86400

300

sim-switch-log-alert-interval

When sim-switch > X threshold within Y interval, trigger log event (Y:1 - 99999 min, default = 15).

integer

Minimum value: 1 Maximum value: 99999

15

sim-switch-log-alert-threshold

When sim-switch > X threshold within Y interval, trigger log event (X:1 - 1000 times, default = 5).

integer

Minimum value: 1 Maximum value: 1000

5

config system 5g-modem

config system 5g-modem

Note

This command is available for model(s): FortiGate 50G 5G.

It is not available for: FortiGate 1000D, FortiGate 1000F, FortiGate 1001F, FortiGate 100F, FortiGate 101F, FortiGate 1100E, FortiGate 1101E, FortiGate 120G, FortiGate 121G, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 200G, FortiGate 201E, FortiGate 201F, FortiGate 201G, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 3000F, FortiGate 3001F, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3200F, FortiGate 3201F, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3700F, FortiGate 3701F, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 400F, FortiGate 401E, FortiGate 401F, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 4800F, FortiGate 4801F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 50G DSL, FortiGate 50G SFP-POE, FortiGate 50G SFP, FortiGate 50G, FortiGate 51G, FortiGate 600E, FortiGate 600F, FortiGate 601E, FortiGate 601F, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 61E, FortiGate 61F, FortiGate 70F, FortiGate 71F, FortiGate 800D, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F DSL, FortiGate 80F-POE, FortiGate 80F, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 900G, FortiGate 901G, FortiGate 90E, FortiGate 90G, FortiGate 91E, FortiGate 91G, FortiGate-VM64 Aliyun, FortiGate-VM64 AWS, FortiGate-VM64 Azure, FortiGate-VM64 GCP, FortiGate-VM64 OPC, FortiGate-VM64, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiGateRugged 70F 3G4G, FortiGateRugged 70F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 50G DSL, FortiWiFi 50G SFP, FortiWiFi 50G, FortiWiFi 60E DSLJ, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 80F 2R 3G4G DSL, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G DSL, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

Configure USB 5G modems.

config system 5g-modem
    Description: Configure USB 5G modems.
    config data-plan
        Description: Configure data plan.
        edit <name>
            set apn {string}
            set auth-type [none|pap|...]
            set password {password}
            set pdp-type [ipv4|ipv6|...]
            set username {string}
        next
    end
    config modem1
        Description: Configure 5G Modem1.
        set carrier-config [auto-gcf|auto-ptcrb|...]
        set custom-ipv4-netmask {ipv4-netmask}
        set default-gateway [auto|none]
        set default-netmask [auto|custom]
        set gps-service [enable|disable]
        set network-type [auto|4g|5g|...]
        config sim-switch
            Description: Configure SIM card switch.
            set active-sim-slot [slot-1|slot-2]
            set by-connection-state [enable|disable]
            set by-link-monitor [enable|disable]
            set by-sim-state [enable|disable]
            set link-monitor {string}
            set modem-disconnection-time {integer}
            set sim-switch-log-alert-interval {integer}
            set sim-switch-log-alert-threshold {integer}
        end
        set sim1-data-plan {string}
        set sim1-pin {password}
        set sim2-data-plan {string}
        set sim2-pin {password}
        set status [online|low-power]
    end
    set status [enable|disable]
end

config system 5g-modem

Parameter

Description

Type

Size

Default

status

Enable/disable USB 5G modem daemon.

option

-

enable

Option

Description

enable

Enable USB 5G modem daemon.

disable

Disable USB 5G modem daemon.

config data-plan

Parameter

Description

Type

Size

Default

apn

Login APN string for PDP-IP packet data calls.

string

Maximum length: 127

auth-type

Authentication type for PDP-IP packet data calls.

option

-

none

Option

Description

none

Username and password not required

pap

Use PAP authentication.

chap

Use CHAP authentication.

name

Data plan name.

string

Maximum length: 35

password

Authentication password for PDP-IP packet data calls.

password

Not Specified

pdp-type

Packet Data Protocol (PDP) context type.

option

-

ipv4v6

Option

Description

ipv4

IPv4 only

ipv6

IPv6 only.

ipv4v6

Dual stack for IPv4 and IPv6.

username

Authentication username for PDP-IP packet data calls.

string

Maximum length: 63

config modem1

Parameter

Description

Type

Size

Default

carrier-config

carrier-config selection mode.

option

-

auto-gcf

Option

Description

auto-gcf

Auto select carrier-config by SIM. When unrecognized SIM, use Generic GCF(World).

auto-ptcrb

Auto select carrier-config by SIM. When unrecognized SIM, use Generic PTCRB(North America).

manual

Manual select carrier-config by execute 5g-modem carrier-config switch command.

custom-ipv4-netmask

Netmask assigned by the DHCP server.

ipv4-netmask

Not Specified

255.255.255.255

default-gateway

Modem interface default gateway.

option

-

auto

Option

Description

auto

populate the gateway as assigned by modem internal DHCP server.

none

no default gateway, populate gateway to 0.0.0.0 without any next-hop gateway.

default-netmask

Modem interface default netmask.

option

-

auto

Option

Description

auto

populate the netmask as assigned by modem internal DHCP server.

custom

custom netmask via custom-ipv4-netmask configuration.

gps-service

Enable/disable Modem online mode.

option

-

enable

Option

Description

enable

Enable GPS service.

disable

Disable GPS service.

network-type

Modem network type.

option

-

auto

Option

Description

auto

Automatic detection

4g|5g

connect to 4G and 5G network only. Applies to 5G Non-Standalone (NSA) networks.

3g|4g

connect to 3G and 4G network only.

3g|5g

connect to 3G and 5G network only.

5g

connect to 5G network only, for networks use MIMO/mm waves technology. Applies to 5G Standalone(SA) networks.

4g

connect to 4G network only, for networks use LTE technology.

3g

connect to 3G network only, for networks use WCDMA technology

sim1-data-plan

data plan for SIM #1.

string

Maximum length: 35

sim1-pin

PIN code for SIM #1 (if applicable).

password

Not Specified

sim2-data-plan

data plan for SIM #2.

string

Maximum length: 35

sim2-pin

PIN code for SIM #2 (if applicable).

password

Not Specified

status

Enable/disable Modem online mode.

option

-

online

Option

Description

online

set modem to online mode.

low-power

set modem to persistant low power mode.(no RF signal)

config sim-switch

Parameter

Description

Type

Size

Default

active-sim-slot

set active SIM card slot to slot-1 or slot-2.

option

-

slot-1

Option

Description

slot-1

SIM slot 1

slot-2

SIM slot 2

by-connection-state

Enable/disable automatic switch of SIM by MODEM connection state (mobile data usage charges not incurred).

option

-

enable

Option

Description

enable

Enable SIM auto switch by modem connection state.

disable

Disable SIM auto switch by modem connection state.

by-link-monitor

Enable/disable automatic switch of SIM by link monitor (mobile data usage charges incurred).

option

-

disable

Option

Description

enable

Enable SIM auto switch by link monitor.

disable

Disable SIM auto switch by link monitor.

by-sim-state

Enable/disable automatic switch of SIM when MODEM SIM state is empty or in error.

option

-

enable

Option

Description

enable

Enable SIM auto switch when SIM state is empty or in error.

disable

Disable SIM auto switch when SIM state is empty or in error.

link-monitor

Set link monitor name.

string

Maximum length: 35

modem-disconnection-time

Configure connection-based automatic switch of SIM time interval in seconds (30 - 86400).

integer

Minimum value: 30 Maximum value: 86400

300

sim-switch-log-alert-interval

When sim-switch > X threshold within Y interval, trigger log event (Y:1 - 99999 min, default = 15).

integer

Minimum value: 1 Maximum value: 99999

15

sim-switch-log-alert-threshold

When sim-switch > X threshold within Y interval, trigger log event (X:1 - 1000 times, default = 5).

integer

Minimum value: 1 Maximum value: 1000

5