fortios_wireless_controller_setting – VDOM wireless controller configuration 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 wireless_controller feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.2.0 |
|
fortios_wireless_controller_setting | yes | yes | yes | yes | yes | 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
- wireless_controller_setting - VDOM wireless controller configuration. type: dict more...
- account_id - FortiCloud customer account ID. type: str more...
- 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: --, AF, AL, DZ, AS, AO, AR, AM, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, BN, BG, BF, KH, CM, KY, CF, TD, CL, CN, CX, CO, CG, CD, CR, HR, CY, CZ, DK, DM, DO, EC, EG, SV, ET, EE, GF, PF, FO, FJ, FI, FR, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GY, HT, HN, HK, HU, IS, IN, ID, IQ, IE, IM, IL, IT, CI, JM, JO, KZ, KE, KR, KW, LA, LV, LB, LS, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MA, MZ, MM, NA, NP, NL, AN, AW, NZ, NI, NE, False, MP, OM, PK, PW, PA, PG, PY, PE, PH, PL, PT, PR, QA, RE, RO, RU, RW, BL, KN, LC, MF, PM, VC, SA, SN, RS, ME, SL, SG, SK, SI, ZA, ES, LK, SE, SR, CH, TW, TZ, TH, TG, TT, TN, TR, TM, AE, TC, UG, UA, GB, US, PS, UY, UZ, VU, VE, VN, VI, WF, YE, ZM, ZW, JP, CA, IR, KP, SD, SY, ZB more...
- darrp_optimize - Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). type: int more...
- 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 more...
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str more...
- device_holdoff - Lower limit of creation time of device for identification in minutes (0 - 60). type: int more...
- device_idle - Upper limit of idle time of device for identification in minutes (0 - 14400). type: int more...
- device_weight - Upper limit of confidence of device for identification (0 - 255). type: int more...
- duplicate_ssid - Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name in the same VDOM. type: str choices: enable, disable more...
- fake_ssid_action - Actions taken for detected fake SSID. type: list choices: log, suppress more...
- fapc_compatibility - Enable/disable FAP-C series compatibility. type: str choices: enable, disable more...
- firmware_provision_on_authorization - Enable/disable automatic provisioning of latest firmware on authorization. type: str choices: enable, disable more...
- offending_ssid - Configure offending SSID. type: list more...
- action - Actions taken for detected offending SSID. type: str choices: log, suppress more...
- id - ID. type: int more...
- ssid_pattern - Define offending SSID pattern (case insensitive). For example, word, word*, *word, wo*rd. type: str more...
- phishing_ssid_detect - Enable/disable phishing SSID detection. type: str choices: enable, disable more...
- wfa_compatibility - Enable/disable WFA compatibility. type: str choices: enable, disable 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: VDOM wireless controller configuration.
fortios_wireless_controller_setting:
vdom: "{{ vdom }}"
wireless_controller_setting:
account_id: "<your_own_value>"
country: "--"
darrp_optimize: "5"
darrp_optimize_schedules:
-
name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
device_holdoff: "8"
device_idle: "9"
device_weight: "10"
duplicate_ssid: "enable"
fake_ssid_action: "log"
fapc_compatibility: "enable"
firmware_provision_on_authorization: "enable"
offending_ssid:
-
action: "log"
id: "17"
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