Fortinet white logo
Fortinet white logo

CLI Reference

config system lte-modem

config system lte-modem

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}
    config data-plan
        Description: Configure data plan.
        edit <name>
            set target-sim-slot [SIM-slot-1|SIM-slot-2]
            set data-limit {integer}
            set data-limit-alert {integer}
            set billing-period [monthly|weekly|...]
            set billing-date {integer}
            set billing-weekday [sunday|monday|...]
            set billing-hour {integer}
            set overage [enable|disable]
            set delay-switch-time {string}
            set iccid {string}
        next
    end
    set data-usage-tracking [enable|disable]
    set dhcp-relay [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 pdptype {option}
    config sim-switch
        Description: Configure SIM card switch.
        set by-sim-state [disable|enable]
        set by-connection-state [disable|enable]
        set by-data-plan [enable|disable]
        set by-link-monitor [disable|enable]
        set modem-disconnection-time {integer}
        set link-monitor {string}
        set sim-switch-log-alert-interval {integer}
        set sim-switch-log-alert-threshold {integer}
        set sim-slot {integer}
    end
    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

data-usage-tracking *

Enable/disable data usage tracking.

option

-

disable

Option

Description

enable

Enable data usage tracking.

disable

Disable data usage tracking.

dhcp-relay *

Enable/disable DHCP relay over modem.

option

-

disable

Option

Description

enable

Enable DHCP relay.

disable

Disable DHCP relay.

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

-

enable

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

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

pdptype

Packet Data Protocol (PDP) context type.

option

-

**

Option

Description

IPv4

Only IPv4.

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 data-plan

Parameter

Description

Type

Size

Default

name

Data plan name.

string

Maximum length: 35

target-sim-slot

Target sim slot <1 or 2>

option

-

Option

Description

SIM-slot-1

SIM slot 1

SIM-slot-2

SIM slot 2

data-limit

LTE MODEM data limit in megabytes.

integer

Minimum value: 0 Maximum value: 100000

4294967295

data-limit-alert

LTE MODEM data usage percentage at which to trigger log..

integer

Minimum value: 1 Maximum value: 99

75

billing-period

<MONTH, WEEK, DAY>

option

-

Option

Description

monthly

1-31(day)

weekly

Mon to Sun

daily

1-24(hour)

billing-date

LTE MODEM billing date.

integer

Minimum value: 1 Maximum value: 31

4294967295

billing-weekday

LTE MODEM billing weekday (Mon - Sun).

option

-

Option

Description

sunday

Sunday

monday

Monday

tuesday

Tuesday

wednesday

Wednesday

thursday

Thursday

friday

Friday

saturday

Saturday

billing-hour

LTE MODEM billing hour.

integer

Minimum value: 0 Maximum value: 23

4294967295

overage

Enable/disable allowance of data overage as configured by data-limit. If disabled, perform sim-swap/stop-network as configured by by-data-plan.

option

-

enable

Option

Description

enable

Allow data overage data-limit. This won't perform sim-swap/stop-network.

disable

Disable data overage data-limit. This will perform sim-swap/stop-network as configured by by-data-plan.

delay-switch-time

Instead of SIM switching shortly after data limit is reached, schedule a delay switch time in format hh:mm.

string

Maximum length: 35

NA

iccid

Dedicated data plan to specific ICCID.

string

Maximum length: 35

config sim-switch

Parameter

Description

Type

Size

Default

by-sim-state

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

option

-

enable

Option

Description

disable

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

enable

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

by-connection-state

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

option

-

enable

Option

Description

disable

Disable SIM auto switch by modem connection state.

enable

Enable SIM auto switch by modem connection state.

by-data-plan

Enable/disable SIM auto switch by data-plan config.

option

-

disable

Option

Description

enable

Enable automatic switch of SIM by data-plan configuration.

disable

Disable automatic switch of SIM by data-plan configuration.

by-link-monitor

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

option

-

disable

Option

Description

disable

Disable SIM auto switch by link monitor.

enable

Enable SIM auto switch by link monitor.

modem-disconnection-time

Configure connection-based automatic switch of SIM time interval in seconds.

integer

Minimum value: 30 Maximum value: 86400

300

link-monitor

Set link monitor name.

string

Maximum length: 35

sim-switch-log-alert-interval

When sim-switch > X threshold within Y interval, trigger log event.

integer

Minimum value: 1 Maximum value: 99999

15

sim-switch-log-alert-threshold

When sim-switch > X threshold within Y interval, trigger log event.

integer

Minimum value: 1 Maximum value: 1000

5

sim-slot

SIM card slot. 1: SIM-slot 1. 2: SIM-slot 2.

integer

Minimum value: 1 Maximum value: 2

1

config system lte-modem

config system lte-modem

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}
    config data-plan
        Description: Configure data plan.
        edit <name>
            set target-sim-slot [SIM-slot-1|SIM-slot-2]
            set data-limit {integer}
            set data-limit-alert {integer}
            set billing-period [monthly|weekly|...]
            set billing-date {integer}
            set billing-weekday [sunday|monday|...]
            set billing-hour {integer}
            set overage [enable|disable]
            set delay-switch-time {string}
            set iccid {string}
        next
    end
    set data-usage-tracking [enable|disable]
    set dhcp-relay [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 pdptype {option}
    config sim-switch
        Description: Configure SIM card switch.
        set by-sim-state [disable|enable]
        set by-connection-state [disable|enable]
        set by-data-plan [enable|disable]
        set by-link-monitor [disable|enable]
        set modem-disconnection-time {integer}
        set link-monitor {string}
        set sim-switch-log-alert-interval {integer}
        set sim-switch-log-alert-threshold {integer}
        set sim-slot {integer}
    end
    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

data-usage-tracking *

Enable/disable data usage tracking.

option

-

disable

Option

Description

enable

Enable data usage tracking.

disable

Disable data usage tracking.

dhcp-relay *

Enable/disable DHCP relay over modem.

option

-

disable

Option

Description

enable

Enable DHCP relay.

disable

Disable DHCP relay.

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

-

enable

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

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

pdptype

Packet Data Protocol (PDP) context type.

option

-

**

Option

Description

IPv4

Only IPv4.

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 data-plan

Parameter

Description

Type

Size

Default

name

Data plan name.

string

Maximum length: 35

target-sim-slot

Target sim slot <1 or 2>

option

-

Option

Description

SIM-slot-1

SIM slot 1

SIM-slot-2

SIM slot 2

data-limit

LTE MODEM data limit in megabytes.

integer

Minimum value: 0 Maximum value: 100000

4294967295

data-limit-alert

LTE MODEM data usage percentage at which to trigger log..

integer

Minimum value: 1 Maximum value: 99

75

billing-period

<MONTH, WEEK, DAY>

option

-

Option

Description

monthly

1-31(day)

weekly

Mon to Sun

daily

1-24(hour)

billing-date

LTE MODEM billing date.

integer

Minimum value: 1 Maximum value: 31

4294967295

billing-weekday

LTE MODEM billing weekday (Mon - Sun).

option

-

Option

Description

sunday

Sunday

monday

Monday

tuesday

Tuesday

wednesday

Wednesday

thursday

Thursday

friday

Friday

saturday

Saturday

billing-hour

LTE MODEM billing hour.

integer

Minimum value: 0 Maximum value: 23

4294967295

overage

Enable/disable allowance of data overage as configured by data-limit. If disabled, perform sim-swap/stop-network as configured by by-data-plan.

option

-

enable

Option

Description

enable

Allow data overage data-limit. This won't perform sim-swap/stop-network.

disable

Disable data overage data-limit. This will perform sim-swap/stop-network as configured by by-data-plan.

delay-switch-time

Instead of SIM switching shortly after data limit is reached, schedule a delay switch time in format hh:mm.

string

Maximum length: 35

NA

iccid

Dedicated data plan to specific ICCID.

string

Maximum length: 35

config sim-switch

Parameter

Description

Type

Size

Default

by-sim-state

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

option

-

enable

Option

Description

disable

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

enable

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

by-connection-state

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

option

-

enable

Option

Description

disable

Disable SIM auto switch by modem connection state.

enable

Enable SIM auto switch by modem connection state.

by-data-plan

Enable/disable SIM auto switch by data-plan config.

option

-

disable

Option

Description

enable

Enable automatic switch of SIM by data-plan configuration.

disable

Disable automatic switch of SIM by data-plan configuration.

by-link-monitor

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

option

-

disable

Option

Description

disable

Disable SIM auto switch by link monitor.

enable

Enable SIM auto switch by link monitor.

modem-disconnection-time

Configure connection-based automatic switch of SIM time interval in seconds.

integer

Minimum value: 30 Maximum value: 86400

300

link-monitor

Set link monitor name.

string

Maximum length: 35

sim-switch-log-alert-interval

When sim-switch > X threshold within Y interval, trigger log event.

integer

Minimum value: 1 Maximum value: 99999

15

sim-switch-log-alert-threshold

When sim-switch > X threshold within Y interval, trigger log event.

integer

Minimum value: 1 Maximum value: 1000

5

sim-slot

SIM card slot. 1: SIM-slot 1. 2: SIM-slot 2.

integer

Minimum value: 1 Maximum value: 2

1