Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

config extender-controller extender-profile

FortiExtender extender profile configuration.

config extender-controller extender-profile

Description: FortiExtender extender profile configuration.

edit <name>

set id {integer}

set model [FX201E|FX211E|...]

set extension [wan-extension|lan-extension]

set allowaccess {option1}, {option2}, ...

set login-password-change [yes|default|...]

set login-password {password}

set enforce-bandwidth [enable|disable]

set bandwidth-limit {integer}

config cellular

Description: FortiExtender cellular configuration.

set dataplan <name1>, <name2>, ...

config controller-report

Description: FortiExtender controller report configuration.

set status [disable|enable]

set interval {integer}

set signal-threshold {integer}

end

config sms-notification

Description: FortiExtender cellular SMS notification configuration.

set status [disable|enable]

config alert

Description: SMS alert list.

set system-reboot {string}

set data-exhausted {string}

set session-disconnect {string}

set low-signal-strength {string}

set os-image-fallback {string}

set mode-switch {string}

set fgt-backup-mode-switch {string}

end

config receiver

Description: SMS notification receiver list.

edit <name>

set status [disable|enable]

set phone-number {string}

set alert {option1}, {option2}, ...

next

end

end

config modem1

Description: Configuration options for modem 1.

set redundant-mode [disable|enable]

set redundant-intf {string}

set conn-status {integer}

set default-sim [sim1|sim2|...]

set gps [disable|enable]

set sim1-pin [disable|enable]

set sim2-pin [disable|enable]

set sim1-pin-code {password}

set sim2-pin-code {password}

set preferred-carrier {string}

config auto-switch

Description: FortiExtender auto switch configuration.

set disconnect [disable|enable]

set disconnect-threshold {integer}

set disconnect-period {integer}

set signal [disable|enable]

set dataplan [disable|enable]

set switch-back {option1}, {option2}, ...

set switch-back-time {string}

set switch-back-timer {integer}

end

end

config modem2

Description: Configuration options for modem 2.

set redundant-mode [disable|enable]

set redundant-intf {string}

set conn-status {integer}

set default-sim [sim1|sim2|...]

set gps [disable|enable]

set sim1-pin [disable|enable]

set sim2-pin [disable|enable]

set sim1-pin-code {password}

set sim2-pin-code {password}

set preferred-carrier {string}

config auto-switch

Description: FortiExtender auto switch configuration.

set disconnect [disable|enable]

set disconnect-threshold {integer}

set disconnect-period {integer}

set signal [disable|enable]

set dataplan [disable|enable]

set switch-back {option1}, {option2}, ...

set switch-back-time {string}

set switch-back-timer {integer}

end

end

end

config lan-extension

Description: FortiExtender lan extension configuration.

set link-loadbalance [activebackup|loadbalance]

set ipsec-tunnel {string}

set backhaul-interface {string}

set backhaul-ip {string}

config backhaul

Description: LAN extension backhaul tunnel configuration.

edit <name>

set port [wan|lte1|...]

set role [primary|secondary]

set weight {integer}

next

end

end

next

end

config extender-controller extender-profile

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 102400000

32

model

Model.

option

-

FX201E

 

Option

Description

FX201E

FEX-201E model.

FX211E

FEX-211E model.

FX200F

FEX-200F model.

FXA11F

FEX-101F-AM model.

FXE11F

FEX-101F-EA model.

FXA21F

FEX-201F-AM model.

FXE21F

FEX-201F-EA model.

FXA22F

FEX-202F-AM model.

FXE22F

FEX-202F-EA model.

FX212F

FEX-212F model.

FX311F

FEX-311F model.

FX312F

FEX-312F model.

FX511F

FEX-511F model.

FVG21F

FEV-211F model.

FVA21F

FEV-211F-AM model.

FVG22F

FEV-212F model.

FVA22F

FEV-212F-AM model.

FX04DA

FX40D-AMEU model.

extension

Extension option.

option

-

wan-extension

 

Option

Description

wan-extension

WAN extension.

lan-extension

LAN extension.

allowaccess

Control management access to the managed extender. Separate entries with a space.

option

-

 

Option

Description

ping

PING access.

telnet

TELNET access.

http

HTTP access.

https

HTTPS access.

ssh

SSH access.

snmp

SNMP access.

login-password-change

Change or reset the administrator password of a managed extender .

option

-

no

 

Option

Description

yes

Change the managed extender's administrator password. Use the login-password option to set the password.

default

Keep the managed extender's administrator password set to the factory default.

no

Do not change the managed extender's administrator password.

login-password

Set the managed extender's administrator password.

password

Not Specified

enforce-bandwidth

Enable/disable enforcement of bandwidth on LAN extension interface.

option

-

disable

 

Option

Description

enable

Enable to enforce bandwidth limit on LAN extension interface.

disable

Disable to enforce bandwidth limit on LAN extension interface.

bandwidth-limit

FortiExtender LAN extension bandwidth limit (Mbps).

integer

Minimum value: 1 Maximum value: 16776000

1024

config cellular

Parameter

Description

Type

Size

Default

dataplan <name>

Dataplan names.

Dataplan name.

string

Maximum length: 79

config controller-report

Parameter

Description

Type

Size

Default

status

FortiExtender controller report status.

option

-

disable

 

Option

Description

disable

Controller is configured to not provide service to this FortiExtender.

enable

Controller is configured to provide service to this FortiExtender.

interval

Controller report interval.

integer

Minimum value: 0 Maximum value: 4294967295

300

signal-threshold

Controller report signal threshold.

integer

Minimum value: 10 Maximum value: 50

10

config sms-notification

Parameter

Description

Type

Size

Default

status

FortiExtender SMS notification status.

option

-

disable

 

Option

Description

disable

SMS notification is configured to not provide service to this FortiExtender.

enable

SMS notification is configured to provide service to this FortiExtender.

config alert

Parameter

Description

Type

Size

Default

system-reboot

Display string when system rebooted.

string

Maximum length: 63

system will reboot

data-exhausted

Display string when data exhausted.

string

Maximum length: 63

data plan is exhausted

session-disconnect

Display string when session disconnected.

string

Maximum length: 63

LTE data session is disconnected

low-signal-strength

Display string when signal strength is low.

string

Maximum length: 63

LTE signal strength is too low

os-image-fallback

Display string when falling back to a previous OS image.

string

Maximum length: 63

system start to fallback OS image

mode-switch

Display string when mode is switched.

string

Maximum length: 63

system networking mode switched

fgt-backup-mode-switch

Display string when FortiGate backup mode switched.

string

Maximum length: 63

FortiGate backup work mode switched

config receiver

Parameter

Description

Type

Size

Default

status

SMS notification receiver status.

option

-

disable

 

Option

Description

disable

Disable SMS notification receiver.

enable

Enable SMS notification receiver.

phone-number

Receiver phone number. Format: [+][country code][area code][local phone number]. For example, +16501234567.

string

Maximum length: 31

alert

Alert multi-options.

option

-

 

Option

Description

system-reboot

System will reboot.

data-exhausted

Data plan is exhausted.

session-disconnect

LTE data session is disconnected.

low-signal-strength

LTE signal strength is too low.

mode-switch

System is starting to use fallback OS image.

os-image-fallback

System networking mode switched.

fgt-backup-mode-switch

FortiGate backup work mode switched.

config modem1

Parameter

Description

Type

Size

Default

redundant-mode

FortiExtender mode.

option

-

disable

 

Option

Description

disable

Disable interface redundancy.

enable

Enable interface redundancy.

redundant-intf

Redundant interface.

string

Maximum length: 15

conn-status

Connection status.

integer

Minimum value: 0 Maximum value: 4294967295

0

default-sim

Default SIM selection.

option

-

sim1

 

Option

Description

sim1

Use SIM #1 by default.

sim2

Use SIM #2 by default.

carrier

Assign default SIM based on carrier.

cost

Assign default SIM based on cost.

gps

FortiExtender GPS enable/disable.

option

-

enable

 

Option

Description

disable

Disable GPS.

enable

Enable GPS.

sim1-pin

SIM #1 PIN status.

option

-

disable

 

Option

Description

disable

Disable SIM #1 PIN.

enable

Enable SIM #1 PIN.

sim2-pin

SIM #2 PIN status.

option

-

disable

 

Option

Description

disable

Disable SIM #2 PIN.

enable

Enable SIM #2 PIN.

sim1-pin-code

SIM #1 PIN password.

password

Not Specified

sim2-pin-code

SIM #2 PIN password.

password

Not Specified

preferred-carrier

Preferred carrier.

string

Maximum length: 31

config auto-switch

Parameter

Description

Type

Size

Default

disconnect

Auto switch by disconnect.

option

-

disable

 

Option

Description

disable

Disable switching of SIM card based on cellular disconnections.

enable

Enable switching of SIM card based on cellular disconnections.

disconnect-threshold

Automatically switch based on disconnect threshold.

integer

Minimum value: 1 Maximum value: 100

3

disconnect-period

Automatically switch based on disconnect period.

integer

Minimum value: 600 Maximum value: 18000

600

signal

Automatically switch based on signal strength.

option

-

disable

 

Option

Description

disable

Disable switching of SIM card based on cellular signal quality.

enable

Enable switching of SIM card based on cellular signal quality.

dataplan

Automatically switch based on data usage.

option

-

disable

 

Option

Description

disable

Disable switching of SIM card based on cellular data usage.

enable

Enable switching of SIM card based on cellular data usage.

switch-back

Auto switch with switch back multi-options.

option

-

 

Option

Description

time

Switch back based on specific time in UTC (HH:MM).

timer

Switch back based on an interval.

switch-back-time

Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM).

string

Maximum length: 31

00:01

switch-back-timer

Automatically switch over to preferred SIM/carrier after the given time .

integer

Minimum value: 3600 Maximum value: 2147483647

86400

config modem2

Parameter

Description

Type

Size

Default

redundant-mode

FortiExtender mode.

option

-

disable

 

Option

Description

disable

Disable interface redundancy.

enable

Enable interface redundancy.

redundant-intf

Redundant interface.

string

Maximum length: 15

conn-status

Connection status.

integer

Minimum value: 0 Maximum value: 4294967295

0

default-sim

Default SIM selection.

option

-

sim1

 

Option

Description

sim1

Use SIM #1 by default.

sim2

Use SIM #2 by default.

carrier

Assign default SIM based on carrier.

cost

Assign default SIM based on cost.

gps

FortiExtender GPS enable/disable.

option

-

enable

 

Option

Description

disable

Disable GPS.

enable

Enable GPS.

sim1-pin

SIM #1 PIN status.

option

-

disable

 

Option

Description

disable

Disable SIM #1 PIN.

enable

Enable SIM #1 PIN.

sim2-pin

SIM #2 PIN status.

option

-

disable

 

Option

Description

disable

Disable SIM #2 PIN.

enable

Enable SIM #2 PIN.

sim1-pin-code

SIM #1 PIN password.

password

Not Specified

sim2-pin-code

SIM #2 PIN password.

password

Not Specified

preferred-carrier

Preferred carrier.

string

Maximum length: 31

config auto-switch

Parameter

Description

Type

Size

Default

disconnect

Auto switch by disconnect.

option

-

disable

disconnect-threshold

Automatically switch based on disconnect threshold.

integer

Minimum value: 1 Maximum value: 100

3

disconnect-period

Automatically switch based on disconnect period.

integer

Minimum value: 600 Maximum value: 18000

600

signal

Automatically switch based on signal strength.

option

-

disable

dataplan

Automatically switch based on data usage.

option

-

disable

switch-back

Auto switch with switch back multi-options.

option

-

switch-back-time

Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM).

string

Maximum length: 31

00:01

switch-back-timer

Automatically switch over to preferred SIM/carrier after the given time .

integer

Minimum value: 3600 Maximum value: 2147483647

86400

config lan-extension

Parameter

Description

Type

Size

Default

link-loadbalance

LAN extension link load balance strategy.

option

-

activebackup

 

Option

Description

activebackup

FortiExtender LAN extension active-backup.

loadbalance

FortiExtender LAN extension load-balance.

ipsec-tunnel

IPsec tunnel name.

string

Maximum length: 15

backhaul-interface

IPsec phase1 interface.

string

Maximum length: 15

backhaul-ip

IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.

string

Maximum length: 63

config backhaul

Parameter

Description

Type

Size

Default

port

FortiExtender uplink port.

option

-

wan

 

Option

Description

wan

FortiExtender WAN port.

lte1

FortiExtender LTE1 port.

lte2

FortiExtender LTE2 port.

port1

FortiExtender port1 port.

port2

FortiExtender port2 port.

port3

FortiExtender port3 port.

port4

FortiExtender port4 port.

port5

FortiExtender port5 port.

sfp

FortiExtender SFP port.

role

FortiExtender uplink port.

option

-

primary

 

Option

Description

primary

FortiExtender LAN extension primary role.

secondary

FortiExtender LAN extension secondary role.

weight

WRR weight parameter.

integer

Minimum value: 1 Maximum value: 256

1

config extender-controller extender-profile

FortiExtender extender profile configuration.

config extender-controller extender-profile

Description: FortiExtender extender profile configuration.

edit <name>

set id {integer}

set model [FX201E|FX211E|...]

set extension [wan-extension|lan-extension]

set allowaccess {option1}, {option2}, ...

set login-password-change [yes|default|...]

set login-password {password}

set enforce-bandwidth [enable|disable]

set bandwidth-limit {integer}

config cellular

Description: FortiExtender cellular configuration.

set dataplan <name1>, <name2>, ...

config controller-report

Description: FortiExtender controller report configuration.

set status [disable|enable]

set interval {integer}

set signal-threshold {integer}

end

config sms-notification

Description: FortiExtender cellular SMS notification configuration.

set status [disable|enable]

config alert

Description: SMS alert list.

set system-reboot {string}

set data-exhausted {string}

set session-disconnect {string}

set low-signal-strength {string}

set os-image-fallback {string}

set mode-switch {string}

set fgt-backup-mode-switch {string}

end

config receiver

Description: SMS notification receiver list.

edit <name>

set status [disable|enable]

set phone-number {string}

set alert {option1}, {option2}, ...

next

end

end

config modem1

Description: Configuration options for modem 1.

set redundant-mode [disable|enable]

set redundant-intf {string}

set conn-status {integer}

set default-sim [sim1|sim2|...]

set gps [disable|enable]

set sim1-pin [disable|enable]

set sim2-pin [disable|enable]

set sim1-pin-code {password}

set sim2-pin-code {password}

set preferred-carrier {string}

config auto-switch

Description: FortiExtender auto switch configuration.

set disconnect [disable|enable]

set disconnect-threshold {integer}

set disconnect-period {integer}

set signal [disable|enable]

set dataplan [disable|enable]

set switch-back {option1}, {option2}, ...

set switch-back-time {string}

set switch-back-timer {integer}

end

end

config modem2

Description: Configuration options for modem 2.

set redundant-mode [disable|enable]

set redundant-intf {string}

set conn-status {integer}

set default-sim [sim1|sim2|...]

set gps [disable|enable]

set sim1-pin [disable|enable]

set sim2-pin [disable|enable]

set sim1-pin-code {password}

set sim2-pin-code {password}

set preferred-carrier {string}

config auto-switch

Description: FortiExtender auto switch configuration.

set disconnect [disable|enable]

set disconnect-threshold {integer}

set disconnect-period {integer}

set signal [disable|enable]

set dataplan [disable|enable]

set switch-back {option1}, {option2}, ...

set switch-back-time {string}

set switch-back-timer {integer}

end

end

end

config lan-extension

Description: FortiExtender lan extension configuration.

set link-loadbalance [activebackup|loadbalance]

set ipsec-tunnel {string}

set backhaul-interface {string}

set backhaul-ip {string}

config backhaul

Description: LAN extension backhaul tunnel configuration.

edit <name>

set port [wan|lte1|...]

set role [primary|secondary]

set weight {integer}

next

end

end

next

end

config extender-controller extender-profile

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 102400000

32

model

Model.

option

-

FX201E

 

Option

Description

FX201E

FEX-201E model.

FX211E

FEX-211E model.

FX200F

FEX-200F model.

FXA11F

FEX-101F-AM model.

FXE11F

FEX-101F-EA model.

FXA21F

FEX-201F-AM model.

FXE21F

FEX-201F-EA model.

FXA22F

FEX-202F-AM model.

FXE22F

FEX-202F-EA model.

FX212F

FEX-212F model.

FX311F

FEX-311F model.

FX312F

FEX-312F model.

FX511F

FEX-511F model.

FVG21F

FEV-211F model.

FVA21F

FEV-211F-AM model.

FVG22F

FEV-212F model.

FVA22F

FEV-212F-AM model.

FX04DA

FX40D-AMEU model.

extension

Extension option.