fortios_wireless_controller_setting – VDOM wireless controller configuration in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- wireless_controller_setting - VDOM wireless controller configuration. type: dict
- account_id - FortiCloud customer account ID. type: str
- country - Country or region in which the FortiGate is located. The country determines the 802.11 bands and channels that are available. type: str choices: NA, AL, DZ, AO, AR, AM, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BO, BA, BR, BN, BG, KH, CF, CL, CN, CO, CR, HR, CY, CZ, DK, DO, EC, EG, SV, EE, FI, FR, GE, DE, GR, GL, GD, GU, GT, HT, HN, HK, HU, IS, IN, ID, IR, IE, IL, IT, JM, JO, KZ, KE, KP, KR, KW, LV, LB, LI, LT, LU, MO, MK, MY, MT, MX, MC, MA, MZ, MM, NP, NL, AN, AW, NZ, False, OM, PK, PA, PG, PY, PE, PH, PL, PT, PR, QA, RO, RU, RW, SA, RS, ME, SG, SK, SI, ZA, ES, LK, SE, SD, CH, SY, TW, TZ, TH, TT, TN, TR, AE, UA, GB, US, PS, UY, UZ, VE, VN, YE, ZB, ZW, JP, CA
- darrp_optimize - Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). type: int
- darrp_optimize_schedules - Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. type: list
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: True
- duplicate_ssid - Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name in the same VDOM. type: str choices: enable, disable
- fake_ssid_action - Actions taken for detected fake SSID. type: str choices: log, suppress
- fapc_compatibility - Enable/disable FAP-C series compatibility. type: str choices: enable, disable
- offending_ssid - Configure offending SSID. type: list
- action - Actions taken for detected offending SSID. type: str choices: log, suppress
- id - ID. type: int required: True
- ssid_pattern - Define offending SSID pattern (case insensitive), eg: word, word*, *word, wo*rd. type: str
- phishing_ssid_detect - Enable/disable phishing SSID detection. type: str choices: enable, disable
- wfa_compatibility - Enable/disable WFA compatibility. type: str choices: enable, disable
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: VDOM wireless controller configuration.
fortios_wireless_controller_setting:
vdom: "{{ vdom }}"
wireless_controller_setting:
account_id: "<your_own_value>"
country: "NA"
darrp_optimize: "5"
darrp_optimize_schedules:
-
name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
duplicate_ssid: "enable"
fake_ssid_action: "log"
fapc_compatibility: "enable"
offending_ssid:
-
action: "log"
id: "13"
ssid_pattern: "<your_own_value>"
phishing_ssid_detect: "enable"
wfa_compatibility: "enable"
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