Try SpotterSpeed test schedule for each interface in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This 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
- 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"
interface: "<your_own_value> (source system.interface.name)"
mode: "UDP"
schedules:
-
name: "default_name_9 (source firewall.schedule.recurring.name)"
server_name: "<your_own_value>"
server_port: "5201"
status: "disable"
update_inbandwidth: "disable"
update_inbandwidth_maximum: "0"
update_inbandwidth_minimum: "0"
update_outbandwidth: "disable"
update_outbandwidth_maximum: "0"
update_outbandwidth_minimum: "0"
update_shaper: "disable"
vdom:
default: root
description:
- 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.
type: str
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- 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.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
system_speed_test_schedule:
default: null
description:
- Speed test schedule for each interface.
suboptions:
ctrl_port:
description:
- Port of the controller to get access token.
type: int
diffserv:
description:
- DSCP used for speed test.
type: str
dynamic_server:
choices:
- disable
- enable
description:
- Enable/disable dynamic server option.
type: str
interface:
description:
- Interface name. Source system.interface.name.
required: true
type: str
mode:
choices:
- UDP
- TCP
- Auto
description:
- Protocol Auto(default), TCP or UDP used for speed test.
type: str
schedules:
description:
- Schedules for the interface.
elements: dict
suboptions:
name:
description:
- Name of a firewall recurring schedule. Source firewall.schedule.recurring.name.
required: true
type: str
type: list
server_name:
description:
- Speed test server name.
type: str
server_port:
description:
- Port of the server to run speed test.
type: int
status:
choices:
- disable
- enable
description:
- Enable/disable scheduled speed test.
type: str
update_inbandwidth:
choices:
- disable
- enable
description:
- Enable/disable bypassing interface"s inbound bandwidth setting.
type: str
update_inbandwidth_maximum:
description:
- Maximum downloading bandwidth (kbps) to be used in a speed test.
type: int
update_inbandwidth_minimum:
description:
- Minimum downloading bandwidth (kbps) to be considered effective.
type: int
update_outbandwidth:
choices:
- disable
- enable
description:
- Enable/disable bypassing interface"s outbound bandwidth setting.
type: str
update_outbandwidth_maximum:
description:
- Maximum uploading bandwidth (kbps) to be used in a speed test.
type: int
update_outbandwidth_minimum:
description:
- Minimum uploading bandwidth (kbps) to be considered effective.
type: int
update_shaper:
choices:
- disable
- local
- remote
- both
description:
- Set egress shaper based on the test result.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str