Fortinet white logo
Fortinet white logo

CLI Reference

config lte setting

config lte setting

Description: Configure LTE modem settings.

config lte setting
    config controller-report
        set status [enable | disable]
        set interval (30 – 86400)
        set signal-threshold (10 – 50)
end
    config modem1
        set pause-modem-manager [enable | disable]
        set default-sim [sim1 | sim2 | by-carrier | by-cost]
        set preferred-carrier {string}
        set session-down-detection (1 – 60)
        set gps [enable | disable]
        set sim1-pin [enable | disable]
        set sim1-pin-code {0, 4}
        set sim2-pin [enable | disable]
        set sim2-pin-code {0, 4}
        config auto-switch
            set by-disconnect [enable | disable]
            set by-signal [enable | disable]
            set by-data-plan [enable | disable]
            set by-health-monitor [enable | disable]
            config health-monitor
                set event <name>
                set fail-cnt (1 – 10)
                set recovery-cnt (1 – 10)
                set by-latency [enable |disable]
                set latency-threshold (0 - 10000000)
                set by-jitter [enable |disable]
                set jitter-threshold (0 - 10000000)
                set recover-by-reboot [enable | disable]
                set max-switches-allowed (1 - 20)
                set max-switches-interval (300 - 3600)
            end 
            set disconnect-threshold (1 – 100)
            set disconnect-period (600 – 18000)
            set switch-back [by-timer | by-time ] 
            set switch-back-time (HH:MM)
            set switch-back-timer (3600 – 2147483647)
        end
end
   config modem2
        set pause-modem-manager [enable | disable]
        set default-sim sim1 | sim2 | by-carrier | by-cost]
        set preferred-carrier {string}
        set session-down-detection (1 – 60)
        set gps [enable | disable]
        set sim1-pin [enable | disable]
        set sim1-pin-code {0, 4}
        set sim2-pin [enable | disable]
        set sim2-pin-code {0, 4}
        config auto-switch
            set by-disconnect [enable | disable]
            set by-signal [enable | disable]
            set by-data-plan [enable | disable]
            set by-health-monitor [enable | disable]
            config health-monitor
                set event <name>
                set fail-cnt (1 – 10)
                set recovery-cnt (1 – 10)
                set by-latency [enable |disable]
                set latency-threshold (0 - 10000000)
                set by-jitter [enable |disable]
                set jitter-threshold (0 - 10000000)
                set recover-by-reboot [enable | disable]
                set max-switches-allowed (1 - 20)
                set max-switches-interval (300 - 3600)
            end 
            set disconnect-threshold (1 – 100)
            set disconnect-period (600 – 18000)
            set switch-back [by-timer | by-time ] 
            set switch-back-time (HH:MM)
            set switch-back-timer (3600 – 2147483647)
        end
    end
    set advanced [enable | disable]
    config advanced-settings
        set sim-activation-delay (5 – 600)
        set force-ipv4 [enable | disable]
end
end
unset
show

Sample command:

config lte setting
    config controller-report
        set status enable
        set interval 300
        set signal-threshold 10
    end
    config modem1
        set pause-modem-manager disable
        set default-sim sim1
        set session-down-detection 3
        set gps enable
        set sim1-pin disable
        set sim2-pin disable
        config auto-switch
            set by-disconnect enable
            set by-signal disable
            set by-data-plan disable
            set by-health-monitor enable
            config health-monitor
                set event
                set fail-cnt 5
                set recovery-cnt 5
                set by-latency enable
                set latency-threshold 150
                set by-jitter enable
                set jitter-threshold 150
                set recover-by-reboot disable
            end
            set disconnect-threshold 3
            set disconnect-period 600
            set switch-back by-time by-timer
            set switch-back-time 00:01
            set switch-back-timer 86400
        end
    end
    set advanced enable
    config advanced-settings
        set sim-activation-delay 300
        set force-ipv4 disable
    end
end
Parameter Description Type Size Default
status Status of controller reporting. option - enable
Option Description
enable Enable LTE controller report.
disable Disable LTE controller report.
interval Reporting interval. integer 30 - 86400 300
signal-threshold Signal threshold that needs to be reached before a report is sent. integer 10 - 50 10
Parameter Description Type Size Default
pause-modem-manager Delay the modem if the SIM needs a longer activation period. option - disable
Option Description
enable Enable delayed modem activation.
disable Disable delay of modem activation.
default-sim The first SIM card which the modem will try and connect with. option - sim1
Option Description
sim1 SIM card in SIM slot 1.
sim2 SIM card in SIM slot 2.
by-carrier SIM card from the carrier specified in preferred-carrier.
by-cost SIM card whose plan has the lowest cost.
preferred-carrier Preferred carrier which the modem will try and connect with. string - none
session-down-detection Period to confirm a session has been disconnected. integer 1 - 60 3
gps GPS location. option - enable
Option Description
enable Enable GPS location.
disable Disable GPS location.

sim1-pin

Whether or not SIM 1 requires a pin code.

option

-

disable

Option Description
enable SIM 1 requires a pin.
disable SIM 1 does not require a pin.

sim1-pin-code

The 4-digit pin code provided by the carrier.

integer

none

sim2-pin

Whether or not SIM 2 requires a pin code.

option

disable

Option Description
enable SIM 2 requires a pin.
disable SIM 2 does not require a pin.

sim2-pin-code

The 4-digit pin code provided by the carrier.

integer

none

by-disconnect

SIM switching occurs based on disconnects.

option

disable

Option Description
enable Enable SIM switching based on disconnects.
disable Disable SIM switching based on disconnects.

disconnect-threshold

Number of disconnects that can happen before SIM switching is triggered.

integer

1 - 100

3

disconnect-period

Evaluation period in seconds for SIM switching.

integer

600 - 18000

600

by-signal

SIM switching occurs based on signal strength.

option

disable

Option Description
enable Enable SIM switching based on signal strength.
disable Disable SIM switching based on signal strength.

by-data-plan

SIM switching occurs when the data plan for the active SIM is used up.

option

disable

Option Description
enable Enable SIM switching based on data plan usage.
disable Disable SIM switching based on data plan usage.

by-health-monitor

Sim switching occurs based on health checks like Ping/RTT.

option

disable

Option Description
enable Enable SIM switching based on health checks.
disable Disable SIM switching based on health checks.

event

Hmon hchk member

string

none

fail-cnt

Number of failures before the member is considered dead.

integer

1 - 10

5

recovery-cnt

Number of successes before the member is considered alive.

integer

1 - 10

5

by latency

Latency monitoring on the active SIM.

option

disable

Option Decription
enable Enable SIM switching based on latency.
disable Disable SIM switching based on latency.

latency-threshold

Latency in milliseconds for SLA to make decision.

integer

0 - 10000000

150

by jitter

Jitter monitoring on the active SIM.

option

disable

Option Description
enable Enable SIM switching based on jitter.
disable Disable SIM switching based on jitter.

recover-by-reboot

Reboot to recover the modem from excessive SIM switches.

option

disable

Option Description
enable Enable device reboot after excessive SIM switching.
disable Disable device reboot after excessive SIM switching.

max-switches-allowed

Number of SIM switches allowed for a given duration.

integer

1 - 20

5

max-switches-interval

Duration to monitor SIM switches (in seconds).

integer

300 - 3600

1800

switch-back

Direct modem to switch back to a preferred SIM when the secondary SIM is active.

option

none

Option Description
by-time Switch back at a specified time using the HH:MM format.
by-timer Switch back after the specified duration is over.

switch-back-time

Switch over to the preferred SIM/carrier at the specified UTC time in HH:MM format.

string

00:01

switch-back-timer

Switch over to the preferred SIM/carrier after the given duration.

integer

3600 - 2147483647

86400

Parameter Description Type Size Default
advanced Advanced options for modem configuration. option disable
Option Decription
enable Enable advanced settings.
disable Disable advanced settings.
sim-activation-delay Period for SIM card activation. integer 5 - 600 300
force-ipv4 Reconfigure the modem to use IPv4; register to ISP with IPv4 only; plan/PDN must be IPv4 only. option disable
Option Description
enable Force the modem to use IPv4 only.
disable Do not force the modem to use IPv4 only.

config lte setting

config lte setting

Description: Configure LTE modem settings.

config lte setting
    config controller-report
        set status [enable | disable]
        set interval (30 – 86400)
        set signal-threshold (10 – 50)
end
    config modem1
        set pause-modem-manager [enable | disable]
        set default-sim [sim1 | sim2 | by-carrier | by-cost]
        set preferred-carrier {string}
        set session-down-detection (1 – 60)
        set gps [enable | disable]
        set sim1-pin [enable | disable]
        set sim1-pin-code {0, 4}
        set sim2-pin [enable | disable]
        set sim2-pin-code {0, 4}
        config auto-switch
            set by-disconnect [enable | disable]
            set by-signal [enable | disable]
            set by-data-plan [enable | disable]
            set by-health-monitor [enable | disable]
            config health-monitor
                set event <name>
                set fail-cnt (1 – 10)
                set recovery-cnt (1 – 10)
                set by-latency [enable |disable]
                set latency-threshold (0 - 10000000)
                set by-jitter [enable |disable]
                set jitter-threshold (0 - 10000000)
                set recover-by-reboot [enable | disable]
                set max-switches-allowed (1 - 20)
                set max-switches-interval (300 - 3600)
            end 
            set disconnect-threshold (1 – 100)
            set disconnect-period (600 – 18000)
            set switch-back [by-timer | by-time ] 
            set switch-back-time (HH:MM)
            set switch-back-timer (3600 – 2147483647)
        end
end
   config modem2
        set pause-modem-manager [enable | disable]
        set default-sim sim1 | sim2 | by-carrier | by-cost]
        set preferred-carrier {string}
        set session-down-detection (1 – 60)
        set gps [enable | disable]
        set sim1-pin [enable | disable]
        set sim1-pin-code {0, 4}
        set sim2-pin [enable | disable]
        set sim2-pin-code {0, 4}
        config auto-switch
            set by-disconnect [enable | disable]
            set by-signal [enable | disable]
            set by-data-plan [enable | disable]
            set by-health-monitor [enable | disable]
            config health-monitor
                set event <name>
                set fail-cnt (1 – 10)
                set recovery-cnt (1 – 10)
                set by-latency [enable |disable]
                set latency-threshold (0 - 10000000)
                set by-jitter [enable |disable]
                set jitter-threshold (0 - 10000000)
                set recover-by-reboot [enable | disable]
                set max-switches-allowed (1 - 20)
                set max-switches-interval (300 - 3600)
            end 
            set disconnect-threshold (1 – 100)
            set disconnect-period (600 – 18000)
            set switch-back [by-timer | by-time ] 
            set switch-back-time (HH:MM)
            set switch-back-timer (3600 – 2147483647)
        end
    end
    set advanced [enable | disable]
    config advanced-settings
        set sim-activation-delay (5 – 600)
        set force-ipv4 [enable | disable]
end
end
unset
show

Sample command:

config lte setting
    config controller-report
        set status enable
        set interval 300
        set signal-threshold 10
    end
    config modem1
        set pause-modem-manager disable
        set default-sim sim1
        set session-down-detection 3
        set gps enable
        set sim1-pin disable
        set sim2-pin disable
        config auto-switch
            set by-disconnect enable
            set by-signal disable
            set by-data-plan disable
            set by-health-monitor enable
            config health-monitor
                set event
                set fail-cnt 5
                set recovery-cnt 5
                set by-latency enable
                set latency-threshold 150
                set by-jitter enable
                set jitter-threshold 150
                set recover-by-reboot disable
            end
            set disconnect-threshold 3
            set disconnect-period 600
            set switch-back by-time by-timer
            set switch-back-time 00:01
            set switch-back-timer 86400
        end
    end
    set advanced enable
    config advanced-settings
        set sim-activation-delay 300
        set force-ipv4 disable
    end
end
Parameter Description Type Size Default
status Status of controller reporting. option - enable
Option Description
enable Enable LTE controller report.
disable Disable LTE controller report.
interval Reporting interval. integer 30 - 86400 300
signal-threshold Signal threshold that needs to be reached before a report is sent. integer 10 - 50 10
Parameter Description Type Size Default
pause-modem-manager Delay the modem if the SIM needs a longer activation period. option - disable
Option Description
enable Enable delayed modem activation.
disable Disable delay of modem activation.
default-sim The first SIM card which the modem will try and connect with. option - sim1
Option Description
sim1 SIM card in SIM slot 1.
sim2 SIM card in SIM slot 2.
by-carrier SIM card from the carrier specified in preferred-carrier.
by-cost SIM card whose plan has the lowest cost.
preferred-carrier Preferred carrier which the modem will try and connect with. string - none
session-down-detection Period to confirm a session has been disconnected. integer 1 - 60 3
gps GPS location. option - enable
Option Description
enable Enable GPS location.
disable Disable GPS location.

sim1-pin

Whether or not SIM 1 requires a pin code.

option

-

disable

Option Description
enable SIM 1 requires a pin.
disable SIM 1 does not require a pin.

sim1-pin-code

The 4-digit pin code provided by the carrier.

integer

none

sim2-pin

Whether or not SIM 2 requires a pin code.

option

disable

Option Description
enable SIM 2 requires a pin.
disable SIM 2 does not require a pin.

sim2-pin-code

The 4-digit pin code provided by the carrier.

integer

none

by-disconnect

SIM switching occurs based on disconnects.

option

disable

Option Description
enable Enable SIM switching based on disconnects.
disable Disable SIM switching based on disconnects.

disconnect-threshold

Number of disconnects that can happen before SIM switching is triggered.

integer

1 - 100

3

disconnect-period

Evaluation period in seconds for SIM switching.

integer

600 - 18000

600

by-signal

SIM switching occurs based on signal strength.

option

disable

Option Description
enable Enable SIM switching based on signal strength.
disable Disable SIM switching based on signal strength.

by-data-plan

SIM switching occurs when the data plan for the active SIM is used up.

option

disable

Option Description
enable Enable SIM switching based on data plan usage.
disable Disable SIM switching based on data plan usage.

by-health-monitor

Sim switching occurs based on health checks like Ping/RTT.

option

disable

Option Description
enable Enable SIM switching based on health checks.
disable Disable SIM switching based on health checks.

event

Hmon hchk member

string

none

fail-cnt

Number of failures before the member is considered dead.

integer

1 - 10

5

recovery-cnt

Number of successes before the member is considered alive.

integer

1 - 10

5

by latency

Latency monitoring on the active SIM.

option

disable

Option Decription
enable Enable SIM switching based on latency.
disable Disable SIM switching based on latency.

latency-threshold

Latency in milliseconds for SLA to make decision.

integer

0 - 10000000

150

by jitter

Jitter monitoring on the active SIM.

option

disable

Option Description
enable Enable SIM switching based on jitter.
disable Disable SIM switching based on jitter.

recover-by-reboot

Reboot to recover the modem from excessive SIM switches.

option

disable

Option Description
enable Enable device reboot after excessive SIM switching.
disable Disable device reboot after excessive SIM switching.

max-switches-allowed

Number of SIM switches allowed for a given duration.

integer

1 - 20

5

max-switches-interval

Duration to monitor SIM switches (in seconds).

integer

300 - 3600

1800

switch-back

Direct modem to switch back to a preferred SIM when the secondary SIM is active.

option

none

Option Description
by-time Switch back at a specified time using the HH:MM format.
by-timer Switch back after the specified duration is over.

switch-back-time

Switch over to the preferred SIM/carrier at the specified UTC time in HH:MM format.

string

00:01

switch-back-timer

Switch over to the preferred SIM/carrier after the given duration.

integer

3600 - 2147483647

86400

Parameter Description Type Size Default
advanced Advanced options for modem configuration. option disable
Option Decription
enable Enable advanced settings.
disable Disable advanced settings.
sim-activation-delay Period for SIM card activation. integer 5 - 600 300
force-ipv4 Reconfigure the modem to use IPv4; register to ISP with IPv4 only; plan/PDN must be IPv4 only. option disable
Option Description
enable Force the modem to use IPv4 only.
disable Do not force the modem to use IPv4 only.