Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

config extender-controller extender

Extender controller configuration.

config extender-controller extender

Description: Extender controller configuration.

edit <name>

set id {string}

set authorized [disable|enable]

set ext-name {string}

set description {string}

set vdom {integer}

set login-password {password}

config controller-report

Description: FortiExtender controller report configuration.

set status [disable|enable]

set interval {integer}

set signal-threshold {integer}

end

config modem1

Description: Configuration options for modem 1.

set ifname {string}

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 ifname {string}

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

next

end

config extender-controller extender

Parameter

Description

Type

Size

Default

id

FortiExtender serial number.

string

Maximum length: 19

authorized

FortiExtender Administration (enable or disable).

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.

ext-name

FortiExtender name.

string

Maximum length: 31

description

Description.

string

Maximum length: 255

vdom

VDOM

integer

Minimum value: 0 Maximum value: 4294967295

0

login-password

FortiExtender login password.

password

Not Specified

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: 0 Maximum value: 4294967295

10

config modem1

Parameter

Description

Type

Size

Default

ifname

FortiExtender interface name.

string

Maximum length: 15

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: 0 Maximum value: 4294967295

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

ifname

FortiExtender interface name.

string

Maximum length: 15

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: 0 Maximum value: 4294967295

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 extender-controller extender

Extender controller configuration.

config extender-controller extender

Description: Extender controller configuration.

edit <name>

set id {string}

set authorized [disable|enable]

set ext-name {string}

set description {string}

set vdom {integer}

set login-password {password}

config controller-report

Description: FortiExtender controller report configuration.

set status [disable|enable]

set interval {integer}

set signal-threshold {integer}

end

config modem1

Description: Configuration options for modem 1.

set ifname {string}

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 ifname {string}

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

next

end

config extender-controller extender

Parameter

Description

Type

Size

Default

id

FortiExtender serial number.

string

Maximum length: 19

authorized

FortiExtender Administration (enable or disable).

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.

ext-name

FortiExtender name.

string

Maximum length: 31

description

Description.

string

Maximum length: 255

vdom

VDOM

integer

Minimum value: 0 Maximum value: 4294967295

0

login-password

FortiExtender login password.

password

Not Specified

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: 0 Maximum value: 4294967295

10

config modem1

Parameter

Description

Type

Size

Default

ifname

FortiExtender interface name.

string

Maximum length: 15

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: 0 Maximum value: 4294967295

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

ifname

FortiExtender interface name.

string

Maximum length: 15

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: 0 Maximum value: 4294967295

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