Fortinet white logo
Fortinet white logo

CLI Reference

config system speed-test-schedule

config system speed-test-schedule

Speed test schedule for each interface.

config system speed-test-schedule
    Description: Speed test schedule for each interface.
    edit <interface>
        set ctrl-port {integer}
        set diffserv {user}
        set dynamic-server [disable|enable]
        set expected-inbandwidth-maximum {integer}
        set expected-inbandwidth-minimum {integer}
        set expected-outbandwidth-maximum {integer}
        set expected-outbandwidth-minimum {integer}
        set mode [UDP|TCP|...]
        set retries {integer}
        set retry-pause {integer}
        set schedules <name1>, <name2>, ...
        set server-name {string}
        set server-port {integer}
        set status [disable|enable]
        set update-inbandwidth [disable|enable]
        set update-inbandwidth-maximum {integer}
        set update-inbandwidth-minimum {integer}
        set update-interface-shaping [disable|enable]
        set update-outbandwidth [disable|enable]
        set update-outbandwidth-maximum {integer}
        set update-outbandwidth-minimum {integer}
        set update-shaper [disable|local|...]
    next
end

config system speed-test-schedule

Parameter

Description

Type

Size

Default

ctrl-port

Port of the controller to get access token.

integer

Minimum value: 1 Maximum value: 65535

5200

diffserv

DSCP used for speed test.

user

Not Specified

dynamic-server

Enable/disable dynamic server option.

option

-

disable

Option

Description

disable

Disable dynamic server.

enable

Enable dynamic server.The speed test server will be found automatically.

expected-inbandwidth-maximum

Set the maximum inbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

expected-inbandwidth-minimum

Set the minimum inbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

expected-outbandwidth-maximum

Set the maximum outbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

expected-outbandwidth-minimum

Set the minimum outbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

interface

Interface name.

string

Maximum length: 35

mode

Protocol Auto(default), TCP or UDP used for speed test.

option

-

Auto

Option

Description

UDP

Protocol UDP for speed test.

TCP

Protocol TCP for speed test.

Auto

Dynamically selects TCP or UDP based on the speed test setting

retries

Maximum number of times the FortiGate unit will attempt to contact the same server before considering the speed test has failed (1 - 10, default = 5).

integer

Minimum value: 1 Maximum value: 10

5

retry-pause

Number of seconds the FortiGate pauses between successive speed tests before trying a different server (60 - 3600, default = 300).

integer

Minimum value: 60 Maximum value: 3600

300

schedules <name>

Schedules for the interface.

Name of a firewall recurring schedule.

string

Maximum length: 31

server-name

Speed test server name in system.speed-test-server list or leave it as empty to choose default server "FTNT_Auto".

string

Maximum length: 35

server-port

Port of the server to run speed test.

integer

Minimum value: 1 Maximum value: 65535

5201

status

Enable/disable scheduled speed test.

option

-

enable

Option

Description

disable

Disable scheduled speed test.

enable

Enable scheduled speed test.

update-inbandwidth

Enable/disable bypassing interface's inbound bandwidth setting.

option

-

disable

Option

Description

disable

Honor interface's inbandwidth shaping.

enable

Ignore interface's inbandwidth shaping.

update-inbandwidth-maximum

Maximum downloading bandwidth (kbps) to be used in a speed test.

integer

Minimum value: 0 Maximum value: 16776000

0

update-inbandwidth-minimum

Minimum downloading bandwidth (kbps) to be considered effective.

integer

Minimum value: 0 Maximum value: 16776000

0

update-interface-shaping

Enable/disable using the speedtest results as reference for interface shaping (overriding configured in/outbandwidth).

option

-

disable

Option

Description

disable

Disable updating interface shaping.

enable

Enable updating interface shaping.

update-outbandwidth

Enable/disable bypassing interface's outbound bandwidth setting.

option

-

disable

Option

Description

disable

Honor interface's outbandwidth shaping.

enable

Ignore updating interface's outbandwidth shaping.

update-outbandwidth-maximum

Maximum uploading bandwidth (kbps) to be used in a speed test.

integer

Minimum value: 0 Maximum value: 16776000

0

update-outbandwidth-minimum

Minimum uploading bandwidth (kbps) to be considered effective.

integer

Minimum value: 0 Maximum value: 16776000

0

update-shaper

Set egress shaper based on the test result.

option

-

disable

Option

Description

disable

Disable updating egress shaper.

local

Update local-side egress shaper.

remote

Update remote-side egress shaper.

both

Update both local-side and remote-side egress shaper.

config system speed-test-schedule

config system speed-test-schedule

Speed test schedule for each interface.

config system speed-test-schedule
    Description: Speed test schedule for each interface.
    edit <interface>
        set ctrl-port {integer}
        set diffserv {user}
        set dynamic-server [disable|enable]
        set expected-inbandwidth-maximum {integer}
        set expected-inbandwidth-minimum {integer}
        set expected-outbandwidth-maximum {integer}
        set expected-outbandwidth-minimum {integer}
        set mode [UDP|TCP|...]
        set retries {integer}
        set retry-pause {integer}
        set schedules <name1>, <name2>, ...
        set server-name {string}
        set server-port {integer}
        set status [disable|enable]
        set update-inbandwidth [disable|enable]
        set update-inbandwidth-maximum {integer}
        set update-inbandwidth-minimum {integer}
        set update-interface-shaping [disable|enable]
        set update-outbandwidth [disable|enable]
        set update-outbandwidth-maximum {integer}
        set update-outbandwidth-minimum {integer}
        set update-shaper [disable|local|...]
    next
end

config system speed-test-schedule

Parameter

Description

Type

Size

Default

ctrl-port

Port of the controller to get access token.

integer

Minimum value: 1 Maximum value: 65535

5200

diffserv

DSCP used for speed test.

user

Not Specified

dynamic-server

Enable/disable dynamic server option.

option

-

disable

Option

Description

disable

Disable dynamic server.

enable

Enable dynamic server.The speed test server will be found automatically.

expected-inbandwidth-maximum

Set the maximum inbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

expected-inbandwidth-minimum

Set the minimum inbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

expected-outbandwidth-maximum

Set the maximum outbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

expected-outbandwidth-minimum

Set the minimum outbandwidth threshold for applying speedtest results on shaping-profile.

integer

Minimum value: 0 Maximum value: 16776000

0

interface

Interface name.

string

Maximum length: 35

mode

Protocol Auto(default), TCP or UDP used for speed test.

option

-

Auto

Option

Description

UDP

Protocol UDP for speed test.

TCP

Protocol TCP for speed test.

Auto

Dynamically selects TCP or UDP based on the speed test setting

retries

Maximum number of times the FortiGate unit will attempt to contact the same server before considering the speed test has failed (1 - 10, default = 5).

integer

Minimum value: 1 Maximum value: 10

5

retry-pause

Number of seconds the FortiGate pauses between successive speed tests before trying a different server (60 - 3600, default = 300).

integer

Minimum value: 60 Maximum value: 3600

300

schedules <name>

Schedules for the interface.

Name of a firewall recurring schedule.

string

Maximum length: 31

server-name

Speed test server name in system.speed-test-server list or leave it as empty to choose default server "FTNT_Auto".

string

Maximum length: 35

server-port

Port of the server to run speed test.

integer

Minimum value: 1 Maximum value: 65535

5201

status

Enable/disable scheduled speed test.

option

-

enable

Option

Description

disable

Disable scheduled speed test.

enable

Enable scheduled speed test.

update-inbandwidth

Enable/disable bypassing interface's inbound bandwidth setting.

option

-

disable

Option

Description

disable

Honor interface's inbandwidth shaping.

enable

Ignore interface's inbandwidth shaping.

update-inbandwidth-maximum

Maximum downloading bandwidth (kbps) to be used in a speed test.

integer

Minimum value: 0 Maximum value: 16776000

0

update-inbandwidth-minimum

Minimum downloading bandwidth (kbps) to be considered effective.

integer

Minimum value: 0 Maximum value: 16776000

0

update-interface-shaping

Enable/disable using the speedtest results as reference for interface shaping (overriding configured in/outbandwidth).

option

-

disable

Option

Description

disable

Disable updating interface shaping.

enable

Enable updating interface shaping.

update-outbandwidth

Enable/disable bypassing interface's outbound bandwidth setting.

option

-

disable

Option

Description

disable

Honor interface's outbandwidth shaping.

enable

Ignore updating interface's outbandwidth shaping.

update-outbandwidth-maximum

Maximum uploading bandwidth (kbps) to be used in a speed test.

integer

Minimum value: 0 Maximum value: 16776000

0

update-outbandwidth-minimum

Minimum uploading bandwidth (kbps) to be considered effective.

integer

Minimum value: 0 Maximum value: 16776000

0

update-shaper

Set egress shaper based on the test result.

option

-

disable

Option

Description

disable

Disable updating egress shaper.

local

Update local-side egress shaper.

remote

Update remote-side egress shaper.

both

Update both local-side and remote-side egress shaper.