Fortinet white logo
Fortinet white logo

CLI Reference

config plan

config plan

Description: Configure LTE plans for SIM cards.

config lte plan
    edit <name>
        set modem [all | modem1 | modem2]
        set type [by-iccid | by-slot | by-carrier | by-default]
        set *carrier {string}
        set *slot [sim1 | sim2]
        set *iccid {integer}
        set apn {string}
        set auth [NONE | PAP | CHAP]
        set user {string}
        set pwd {string}
        set pdn [ipv4-only | ipv-only | ipv4-ipv6]
        set signal-threshold (-100 - -50)
        set signal-period (600 – 18000)
        set capacity (0 – 102400000)
        set monthly-fee (0 – 1000000)
        set billing-date (1 – 31)
        set overage [enable | disable]
        set preferred-subnet (0 – 32)
        set private-network [enable | disable]
        set session-dial-timeout (0 – 180)
next
delete <name>
purge
show
end

Sample command:

config lte plan
    edit ATTPlan
        set modem modem1
        set type by-carrier
        set carrier AT&T
        set apn broadband
        set auth none
        set user
        set pwd
        set pdn ipv4-only
        set signal-threshold -100
        set signal-period 3600
        set capacity 1024
        set monthly-fee 0
        set billing-date 1
        set overage disable
        set preferred-subnet 0
        set private-network disable
        set session-dial-timeout 0
    next
end
Parameter Description Type Size Default
modem Modem that will be using this plan. option - all
Option Description
all All modems in the device.
modem1 Only modem 1 will be used.
modem2 Only modem 2 will be used. (This option applies to devices with two modems.)
type Method to assign the plan. option - by-default
Option Description
by-carrier Assign the plan to the SIM card with the specified carrier.
by-iccid Assign the plan to the SIM card with the specified iccid.
by-slot Assign the plan to the SIM card in the specified SIM slot.
by-default Assign the plan to the default SIM card as set in LTE settings.
carrier Carrier option if type is set to by-carrier. string none
slot SIM slot to which the plan is assigned. option sim1
Option Description
sim1 Assign the plan to the SIM card in SIM slot 1.
sim2 Assign the plan to the SIM card in SIM slot 2.
iccid The ICCID of the SIM card to which the plan is assigned. integer - none

apn

APN of the carrier.

string

-

none

auth

Authentication method

option

-

NONE

Option Description
NONE No authentication.
PAP Password authentication protocol.
CHAP Challenge-and-response authentication protocol.

user

username.

string

-

none

pwd

password.

string

-

none

pdn

Request Packet Data Network (PDN) IP address family.

option

-

ipv4-only

Option Definition
ipv4-only Only the IPv4 protocol is used.
ipv6-only Only the IPv6 protocol is used.
ipv4-ipv6 Both IPv4 and IPv6 are tried.

signal-threshold

SIM switch if signal drops below the set threshold.

integer

-100 - -50

-100

signal-period

SIM switch if signal drops below the threshold for more than half of the set period.

integer

600 - 18000

3600

capacity

The amount of data allotted to the SIM card’s plan.

integer

0 - 10240000

0

monthly-fee

The amount paid each month for the plan.

integer

0 - 1000000

0

billing-date

The day of the month when the payment for the plan is renewed.

integer

1 - 31

1

overage

Whether the SIM card can continue to use data once the allotted amount is used up.

option

-

disable

Option Description
enable Enable data usage over capacity.
disable Disable data usage once the capacity has been reached.

preferred-subnet

DHCP address netmask overwriting with modem assignment.

integer

0 - 32

0

private-network

Whether the cellular modem forwards DHCP packets to the WAN/Internet through the LTE/5G model interface.

option

-

disable

Option Description
enable Enable DHCP traffic on port UDP 67 so cellular modems can forward them from the internal to the external side.
disable Block DHCP traffic on port UDP 67, preventing them from passing from the internal to the external side.

session-dial-timeout

Timeout value when dialing up a session.

integer

0 - 180

0

config plan

config plan

Description: Configure LTE plans for SIM cards.

config lte plan
    edit <name>
        set modem [all | modem1 | modem2]
        set type [by-iccid | by-slot | by-carrier | by-default]
        set *carrier {string}
        set *slot [sim1 | sim2]
        set *iccid {integer}
        set apn {string}
        set auth [NONE | PAP | CHAP]
        set user {string}
        set pwd {string}
        set pdn [ipv4-only | ipv-only | ipv4-ipv6]
        set signal-threshold (-100 - -50)
        set signal-period (600 – 18000)
        set capacity (0 – 102400000)
        set monthly-fee (0 – 1000000)
        set billing-date (1 – 31)
        set overage [enable | disable]
        set preferred-subnet (0 – 32)
        set private-network [enable | disable]
        set session-dial-timeout (0 – 180)
next
delete <name>
purge
show
end

Sample command:

config lte plan
    edit ATTPlan
        set modem modem1
        set type by-carrier
        set carrier AT&T
        set apn broadband
        set auth none
        set user
        set pwd
        set pdn ipv4-only
        set signal-threshold -100
        set signal-period 3600
        set capacity 1024
        set monthly-fee 0
        set billing-date 1
        set overage disable
        set preferred-subnet 0
        set private-network disable
        set session-dial-timeout 0
    next
end
Parameter Description Type Size Default
modem Modem that will be using this plan. option - all
Option Description
all All modems in the device.
modem1 Only modem 1 will be used.
modem2 Only modem 2 will be used. (This option applies to devices with two modems.)
type Method to assign the plan. option - by-default
Option Description
by-carrier Assign the plan to the SIM card with the specified carrier.
by-iccid Assign the plan to the SIM card with the specified iccid.
by-slot Assign the plan to the SIM card in the specified SIM slot.
by-default Assign the plan to the default SIM card as set in LTE settings.
carrier Carrier option if type is set to by-carrier. string none
slot SIM slot to which the plan is assigned. option sim1
Option Description
sim1 Assign the plan to the SIM card in SIM slot 1.
sim2 Assign the plan to the SIM card in SIM slot 2.
iccid The ICCID of the SIM card to which the plan is assigned. integer - none

apn

APN of the carrier.

string

-

none

auth

Authentication method

option

-

NONE

Option Description
NONE No authentication.
PAP Password authentication protocol.
CHAP Challenge-and-response authentication protocol.

user

username.

string

-

none

pwd

password.

string

-

none

pdn

Request Packet Data Network (PDN) IP address family.

option

-

ipv4-only

Option Definition
ipv4-only Only the IPv4 protocol is used.
ipv6-only Only the IPv6 protocol is used.
ipv4-ipv6 Both IPv4 and IPv6 are tried.

signal-threshold

SIM switch if signal drops below the set threshold.

integer

-100 - -50

-100

signal-period

SIM switch if signal drops below the threshold for more than half of the set period.

integer

600 - 18000

3600

capacity

The amount of data allotted to the SIM card’s plan.

integer

0 - 10240000

0

monthly-fee

The amount paid each month for the plan.

integer

0 - 1000000

0

billing-date

The day of the month when the payment for the plan is renewed.

integer

1 - 31

1

overage

Whether the SIM card can continue to use data once the allotted amount is used up.

option

-

disable

Option Description
enable Enable data usage over capacity.
disable Disable data usage once the capacity has been reached.

preferred-subnet

DHCP address netmask overwriting with modem assignment.

integer

0 - 32

0

private-network

Whether the cellular modem forwards DHCP packets to the WAN/Internet through the LTE/5G model interface.

option

-

disable

Option Description
enable Enable DHCP traffic on port UDP 67 so cellular modems can forward them from the internal to the external side.
disable Block DHCP traffic on port UDP 67, preventing them from passing from the internal to the external side.

session-dial-timeout

Timeout value when dialing up a session.

integer

0 - 180

0