fortios_system_speed_test_schedule – Speed test schedule for each interface in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_system_speed_test_schedule | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_speed_test_schedule - Speed test schedule for each interface. type: dict more...
- diffserv - DSCP used for speed test. type: str more...
- dynamic_server - Enable/disable dynamic server option. type: str choices: disable, enable more...
- interface - Interface name. Source system.interface.name. type: str required: true more...
- schedules - Schedules for the interface. type: list more...
- name - Name of a firewall recurring schedule. Source firewall.schedule.recurring.name. type: str more...
- server_name - Speed test server name. type: str more...
- status - Enable/disable scheduled speed test. type: str choices: disable, enable more...
- update_inbandwidth - Enable/disable bypassing interface"s inbound bandwidth setting. type: str choices: disable, enable more...
- update_inbandwidth_maximum - Maximum downloading bandwidth (kbps) to be used in a speed test. type: int more...
- update_inbandwidth_minimum - Minimum downloading bandwidth (kbps) to be considered effective. type: int more...
- update_outbandwidth - Enable/disable bypassing interface"s outbound bandwidth setting. type: str choices: disable, enable more...
- update_outbandwidth_maximum - Maximum uploading bandwidth (kbps) to be used in a speed test. type: int more...
- update_outbandwidth_minimum - Minimum uploading bandwidth (kbps) to be considered effective. type: int more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Speed test schedule for each interface.
fortios_system_speed_test_schedule:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_speed_test_schedule:
diffserv: "<your_own_value>"
dynamic_server: "disable"
interface: "<your_own_value> (source system.interface.name)"
schedules:
-
name: "default_name_7 (source firewall.schedule.recurring.name)"
server_name: "<your_own_value>"
status: "disable"
update_inbandwidth: "disable"
update_inbandwidth_maximum: "0"
update_inbandwidth_minimum: "0"
update_outbandwidth: "disable"
update_outbandwidth_maximum: "0"
update_outbandwidth_minimum: "0"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3