Fortinet white logo
Fortinet white logo

CLI Reference

config system lte-modem

config system lte-modem

Note

This command is available for model(s): FortiGate 1000D, FortiGate 100EF, FortiGate 100E, FortiGate 101E, FortiGate 1100E, FortiGate 1101E, FortiGate 1200D, FortiGate 140E-POE, FortiGate 140E, FortiGate 1500DT, FortiGate 1500D, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 201E, FortiGate 201F, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3800D, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 401E, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 600E, FortiGate 601E, FortiGate 60E DSLJ, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 61E, FortiGate 61F, FortiGate 800D, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F-POE, FortiGate 80F, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 90E, FortiGate 91E, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60E DSLJ, FortiWiFi 60E DSL, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate VM64.

Configure USB LTE/WIMAX devices.

config system lte-modem
    Description: Configure USB LTE/WIMAX devices.
    set allow-modify-mtu-size [enable|disable]
    set allow-modify-wireless-profile-table [enable|disable]
    set apn {string}
    set authtype [none|pap|...]
    set auto-connect [enable|disable]
    set band-restrictions {string}
    set billing-date {integer}
    set connection-hot-swap [5-minutes|10-minutes|...]
    set data-limit {integer}
    set data-usage-tracking [enable|disable]
    set extra-init {string}
    set force-wireless-profile {integer}
    set gps-port {integer}
    set gps-service [enable|disable]
    set holddown-timer {integer}
    set image-preference [generic|att|...]
    set interface {string}
    set manual-handover [enable|disable]
    set mode [standalone|redundant]
    set modem-port {integer}
    set network-type [auto|umts-3g|...]
    set override-gateway [enable|disable]
    set passwd {password}
    set sim-hot-swap [enable|disable]
    set sim-slot {integer}
    set sim1-pin {password}
    set sim2-pin {password}
    set status [enable|disable]
    set username {string}
end

config system lte-modem

Parameter

Description

Type

Size

Default

allow-modify-mtu-size *

Allow FortiGate to modify the wireless WAN interface MTU size.

option

-

enable

Option

Description

enable

Allow LTE daemon to modify wireless profile table.

disable

Do not allow LTE daemon to modify wireless profile table.

allow-modify-wireless-profile-table *

Allow FortiGate to modify the wireless profile table if the internal LTE modem is running the GENERIC modem firmware.

option

-

enable

Option

Description

enable

Allow LTE daemon to modify wireless profile table.

disable

Do not allow LTE daemon to modify wireless profile table.

apn

Login APN string for PDP-IP packet data calls.

string

Maximum length: 127

authtype

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.

auto-connect *

Enable/disable modem auto connect.

option

-

disable

Option

Description

enable

Enable modem auto connect.

disable

Disable modem auto connect.

band-restrictions *

Bitmaps for the allowed 3G and LTE bands.Ex: 0000000000000000-0000000000001008 (3G Mask-LTE Mask)

string

Maximum length: 35

billing-date *

LTE Modem billing date.

integer

Minimum value: 1 Maximum value: 31

1

connection-hot-swap *

Set connection-based SIM card hot swap time interval.

option

-

5-minutes

Option

Description

5-minutes

Perform SIM card hot swap if current card is not able to connect for 5 minutes.

10-minutes

Perform SIM card hot swap if current card is not able to connect for 10 minutes.

never

SIM card hot swap based on card presence only.

data-limit *

LTE Modem data limit mega bytes, 0 for unlimited data.

integer

Minimum value: 0 Maximum value: 100000

0

data-usage-tracking *

Enable/disable data usage tracking.

option

-

disable

Option

Description

enable

Enable data usage tracking.

disable

Disable data usage tracking.

extra-init

Extra initialization string for USB LTE/WIMAX devices.

string

Maximum length: 127

force-wireless-profile *

Force to use wireless profile index , 0 if don't force.

integer

Minimum value: 0 Maximum value: 16

0

gps-port *

Modem GPS port index.

integer

Minimum value: 0 Maximum value: 20

255

gps-service *

Enable/disable GPS daemon.

option

-

disable

Option

Description

enable

Enable GPS daemon.

disable

Disable GPS daemon.

holddown-timer

Hold down timer.

integer

Minimum value: 10 Maximum value: 60

30

image-preference *

Modem Image Preference.

option

-

auto-sim

Option

Description

generic

Generic Firmware.

att

AT&T Firmware.

verizon

Verizon Firmware.

telus

Telus Firmware.

docomo

DOCOMO Firmware.

softbank

Softbank Firmware.

sprint

Sprint Firmware.

auto-sim

Auto Select Firmware.

no-change

Do not change.

interface

The interface that the modem is acting as a redundant interface for.

string

Maximum length: 63

manual-handover *

Enable/Disable manual handover from 3G to LTE network.

option

-

disable

Option

Description

enable

Enable 3G to LTE manual handover.

disable

Disable 3G to LTE manual handover.

mode

Modem operation mode.

option

-

standalone

Option

Description

standalone

Standalone modem operation mode.

redundant

Redundant modem operation mode where the modem is used as a backup interface.

modem-port

Modem port index.

integer

Minimum value: 0 Maximum value: 20

255

network-type *

Wireless network type.

option

-

auto

Option

Description

auto

Automatic detection

umts-3g

UMTS 3G -- For networks use GSM technology

lte

LTE

cdma-hrpd

CDMA and HRPD -- For networks use CDMA technology

override-gateway *

Enable/disable LTE gateway override.

option

-

disable

Option

Description

enable

Override gateway to 0.0.0.0

disable

Use gateway as assigned by ISP DHCP server.

passwd

Authentication password for PDP-IP packet data calls.

password

Not Specified

sim-hot-swap *

Enable/disable SIM card auto detection and hot swap.

option

-

enable

Option

Description

enable

Enable SIM card auto detection.

disable

Disable SIM card auto detection.

sim-slot *

SIM card slot. 1: right slot. 2: left slot.

integer

Minimum value: 1 Maximum value: 2

1

sim1-pin *

PIN code for SIM #1 (if applicable).

password

Not Specified

sim2-pin *

PIN code for SIM #2 (if applicable).

password

Not Specified

status

Enable/disable USB LTE/WIMAX device.

option

-

disable **

Option

Description

enable

Enable USB LTE/WIMA device.

disable

Disable USB LTE/WIMA device.

username

Authentication username for PDP-IP packet data calls.

string

Maximum length: 63

* This parameter may not exist in some models.

** Values may differ between models.

config system lte-modem

config system lte-modem

Note

This command is available for model(s): FortiGate 1000D, FortiGate 100EF, FortiGate 100E, FortiGate 101E, FortiGate 1100E, FortiGate 1101E, FortiGate 1200D, FortiGate 140E-POE, FortiGate 140E, FortiGate 1500DT, FortiGate 1500D, FortiGate 1800F, FortiGate 1801F, FortiGate 2000E, FortiGate 200E, FortiGate 200F, FortiGate 201E, FortiGate 201F, FortiGate 2200E, FortiGate 2201E, FortiGate 2500E, FortiGate 2600F, FortiGate 2601F, FortiGate 3000D, FortiGate 300E, FortiGate 301E, FortiGate 3100D, FortiGate 3200D, FortiGate 3300E, FortiGate 3301E, FortiGate 3400E, FortiGate 3401E, FortiGate 3500F, FortiGate 3501F, FortiGate 3600E, FortiGate 3601E, FortiGate 3700D, FortiGate 3800D, FortiGate 3960E, FortiGate 3980E, FortiGate 400E Bypass, FortiGate 400E, FortiGate 401E, FortiGate 40F 3G4G, FortiGate 40F, FortiGate 4200F, FortiGate 4201F, FortiGate 4400F, FortiGate 4401F, FortiGate 5001E1, FortiGate 5001E, FortiGate 500E, FortiGate 501E, FortiGate 600E, FortiGate 601E, FortiGate 60E DSLJ, FortiGate 60E DSL, FortiGate 60E-POE, FortiGate 60E, FortiGate 60F, FortiGate 61E, FortiGate 61F, FortiGate 800D, FortiGate 80E-POE, FortiGate 80E, FortiGate 80F Bypass, FortiGate 80F-POE, FortiGate 80F, FortiGate 81E-POE, FortiGate 81E, FortiGate 81F-POE, FortiGate 81F, FortiGate 900D, FortiGate 90E, FortiGate 91E, FortiGateRugged 60F 3G4G, FortiGateRugged 60F, FortiWiFi 40F 3G4G, FortiWiFi 40F, FortiWiFi 60E DSLJ, FortiWiFi 60E DSL, FortiWiFi 60E, FortiWiFi 60F, FortiWiFi 61E, FortiWiFi 61F, FortiWiFi 80F 2R, FortiWiFi 81F 2R 3G4G-POE, FortiWiFi 81F 2R-POE, FortiWiFi 81F 2R.

It is not available for: FortiGate VM64.

Configure USB LTE/WIMAX devices.

config system lte-modem
    Description: Configure USB LTE/WIMAX devices.
    set allow-modify-mtu-size [enable|disable]
    set allow-modify-wireless-profile-table [enable|disable]
    set apn {string}
    set authtype [none|pap|...]
    set auto-connect [enable|disable]
    set band-restrictions {string}
    set billing-date {integer}
    set connection-hot-swap [5-minutes|10-minutes|...]
    set data-limit {integer}
    set data-usage-tracking [enable|disable]
    set extra-init {string}
    set force-wireless-profile {integer}
    set gps-port {integer}
    set gps-service [enable|disable]
    set holddown-timer {integer}
    set image-preference [generic|att|...]
    set interface {string}
    set manual-handover [enable|disable]
    set mode [standalone|redundant]
    set modem-port {integer}
    set network-type [auto|umts-3g|...]
    set override-gateway [enable|disable]
    set passwd {password}
    set sim-hot-swap [enable|disable]
    set sim-slot {integer}
    set sim1-pin {password}
    set sim2-pin {password}
    set status [enable|disable]
    set username {string}
end

config system lte-modem

Parameter

Description

Type

Size

Default

allow-modify-mtu-size *

Allow FortiGate to modify the wireless WAN interface MTU size.

option

-

enable

Option

Description

enable

Allow LTE daemon to modify wireless profile table.

disable

Do not allow LTE daemon to modify wireless profile table.

allow-modify-wireless-profile-table *

Allow FortiGate to modify the wireless profile table if the internal LTE modem is running the GENERIC modem firmware.

option

-

enable

Option

Description

enable

Allow LTE daemon to modify wireless profile table.

disable

Do not allow LTE daemon to modify wireless profile table.

apn

Login APN string for PDP-IP packet data calls.

string

Maximum length: 127

authtype

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.

auto-connect *

Enable/disable modem auto connect.

option

-

disable

Option

Description

enable

Enable modem auto connect.

disable

Disable modem auto connect.

band-restrictions *

Bitmaps for the allowed 3G and LTE bands.Ex: 0000000000000000-0000000000001008 (3G Mask-LTE Mask)

string

Maximum length: 35

billing-date *

LTE Modem billing date.

integer

Minimum value: 1 Maximum value: 31

1

connection-hot-swap *

Set connection-based SIM card hot swap time interval.

option

-

5-minutes

Option

Description

5-minutes

Perform SIM card hot swap if current card is not able to connect for 5 minutes.

10-minutes

Perform SIM card hot swap if current card is not able to connect for 10 minutes.

never

SIM card hot swap based on card presence only.

data-limit *

LTE Modem data limit mega bytes, 0 for unlimited data.

integer

Minimum value: 0 Maximum value: 100000

0

data-usage-tracking *

Enable/disable data usage tracking.

option

-

disable

Option

Description

enable

Enable data usage tracking.

disable

Disable data usage tracking.

extra-init

Extra initialization string for USB LTE/WIMAX devices.

string

Maximum length: 127

force-wireless-profile *

Force to use wireless profile index , 0 if don't force.

integer

Minimum value: 0 Maximum value: 16

0

gps-port *

Modem GPS port index.

integer

Minimum value: 0 Maximum value: 20

255

gps-service *

Enable/disable GPS daemon.

option

-

disable

Option

Description

enable

Enable GPS daemon.

disable

Disable GPS daemon.

holddown-timer

Hold down timer.

integer

Minimum value: 10 Maximum value: 60

30

image-preference *

Modem Image Preference.

option

-

auto-sim

Option

Description

generic

Generic Firmware.

att

AT&T Firmware.

verizon

Verizon Firmware.

telus

Telus Firmware.

docomo

DOCOMO Firmware.

softbank

Softbank Firmware.

sprint

Sprint Firmware.

auto-sim

Auto Select Firmware.

no-change

Do not change.

interface

The interface that the modem is acting as a redundant interface for.

string

Maximum length: 63

manual-handover *

Enable/Disable manual handover from 3G to LTE network.

option

-

disable

Option

Description

enable

Enable 3G to LTE manual handover.

disable

Disable 3G to LTE manual handover.

mode

Modem operation mode.

option

-

standalone

Option

Description

standalone

Standalone modem operation mode.

redundant

Redundant modem operation mode where the modem is used as a backup interface.

modem-port

Modem port index.

integer

Minimum value: 0 Maximum value: 20

255

network-type *

Wireless network type.

option

-

auto

Option

Description

auto

Automatic detection

umts-3g

UMTS 3G -- For networks use GSM technology

lte

LTE

cdma-hrpd

CDMA and HRPD -- For networks use CDMA technology

override-gateway *

Enable/disable LTE gateway override.

option

-

disable

Option

Description

enable

Override gateway to 0.0.0.0

disable

Use gateway as assigned by ISP DHCP server.

passwd

Authentication password for PDP-IP packet data calls.

password

Not Specified

sim-hot-swap *

Enable/disable SIM card auto detection and hot swap.

option

-

enable

Option

Description

enable

Enable SIM card auto detection.

disable

Disable SIM card auto detection.

sim-slot *

SIM card slot. 1: right slot. 2: left slot.

integer

Minimum value: 1 Maximum value: 2

1

sim1-pin *

PIN code for SIM #1 (if applicable).

password

Not Specified

sim2-pin *

PIN code for SIM #2 (if applicable).

password

Not Specified

status

Enable/disable USB LTE/WIMAX device.

option

-

disable **

Option

Description

enable

Enable USB LTE/WIMA device.

disable

Disable USB LTE/WIMA device.

username

Authentication username for PDP-IP packet data calls.

string

Maximum length: 63

* This parameter may not exist in some models.

** Values may differ between models.