fortinet.fortios.fortios_system_speed_test_schedule module – Speed test schedule for each interface in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.5.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_speed_test_schedule.
New in fortinet.fortios 2.0.0
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and speed_test_schedule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.16
Parameters
Parameter | Comments |
|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. |
enable_log boolean | Enable/Disable logging for task. Choices:
|
member_path string | Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
member_state string | Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
state string / required | Indicates whether to create or remove the object. Choices:
|
system_speed_test_schedule dictionary | Speed test schedule for each interface. |
|
ctrl_port integer |
Port of the controller to get access token. |
|
diffserv string |
DSCP used for speed test. |
|
dynamic_server string |
Enable/disable dynamic server option. Choices:
|
|
expected_inbandwidth_maximum integer |
Set the maximum inbandwidth threshold for applying speedtest results on shaping-profile. |
|
expected_inbandwidth_minimum integer |
Set the minimum inbandwidth threshold for applying speedtest results on shaping-profile. |
|
expected_outbandwidth_maximum integer |
Set the maximum outbandwidth threshold for applying speedtest results on shaping-profile. |
|
expected_outbandwidth_minimum integer |
Set the minimum outbandwidth threshold for applying speedtest results on shaping-profile. |
|
interface string / required |
Interface name. Source system.interface.name. |
|
mode string |
Protocol Auto(default), TCP or UDP used for speed test. Choices:
|
|
retries integer |
Maximum number of times the FortiGate unit will attempt to contact the same server before considering the speed test has failed (1 - 10). |
|
retry_pause integer |
Number of seconds the FortiGate pauses between successive speed tests before trying a different server (60 - 3600). |
|
schedules list / elements=dictionary |
Schedules for the interface. |
|
name string / required |
Name of a firewall recurring schedule. Source firewall.schedule.recurring.name. |
|
server_name string |
Speed test server name in system.speed-test-server list or leave it as empty to choose default server “FTNT_Auto”. Source system .speed-test-server.name. |
|
server_port integer |
Port of the server to run speed test. |
|
status string |
Enable/disable scheduled speed test. Choices:
|
|
update_inbandwidth string |
Enable/disable bypassing interface”s inbound bandwidth setting. Choices:
|
|
update_inbandwidth_maximum integer |
Maximum downloading bandwidth (kbps) to be used in a speed test. |
|
update_inbandwidth_minimum integer |
Minimum downloading bandwidth (kbps) to be considered effective. |
|
update_interface_shaping string |
Enable/disable using the speedtest results as reference for interface shaping (overriding configured in/outbandwidth). Choices:
|
|
update_outbandwidth string |
Enable/disable bypassing interface”s outbound bandwidth setting. Choices:
|
|
update_outbandwidth_maximum integer |
Maximum uploading bandwidth (kbps) to be used in a speed test. |
|
update_outbandwidth_minimum integer |
Minimum uploading bandwidth (kbps) to be considered effective. |
|
update_shaper string |
Set egress shaper based on the test result. Choices:
|
vdom string | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
- name: Speed test schedule for each interface.
fortinet.fortios.fortios_system_speed_test_schedule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_speed_test_schedule:
ctrl_port: "5200"
diffserv: "<your_own_value>"
dynamic_server: "disable"
expected_inbandwidth_maximum: "0"
expected_inbandwidth_minimum: "0"
expected_outbandwidth_maximum: "0"
expected_outbandwidth_minimum: "0"
interface: "<your_own_value> (source system.interface.name)"
mode: "UDP"
retries: "5"
retry_pause: "300"
schedules:
-
name: "default_name_15 (source firewall.schedule.recurring.name)"
server_name: "<your_own_value> (source system.speed-test-server.name)"
server_port: "5201"
status: "disable"
update_inbandwidth: "disable"
update_inbandwidth_maximum: "0"
update_inbandwidth_minimum: "0"
update_interface_shaping: "disable"
update_outbandwidth: "disable"
update_outbandwidth_maximum: "0"
update_outbandwidth_minimum: "0"
update_shaper: "disable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
build string | Build number of the fortigate image Returned: always Sample: |
http_method string | Last method used to provision the content into FortiGate Returned: always Sample: |
http_status string | Last result given by FortiGate on last operation applied Returned: always Sample: |
mkey string | Master key (id) used in the last call to FortiGate Returned: success Sample: |
name string | Name of the table used to fulfill the request Returned: always Sample: |
path string | Path of the table used to fulfill the request Returned: always Sample: |
revision string | Internal revision number Returned: always Sample: |
serial string | Serial number of the unit Returned: always Sample: |
status string | Indication of the operation’s result Returned: always Sample: |
vdom string | Virtual domain used Returned: always Sample: |
version string | Version of the FortiGate Returned: always Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_speed_test_schedule_module.html
