:source: fortios_wireless_controller_setting.py
:orphan:
.. fortios_wireless_controller_setting:
fortios_wireless_controller_setting -- VDOM wireless controller configuration in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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...
| Supported Version Ranges |
| wireless_controller_setting |
v6.0.0 -> 7.6.6 |
- account_id - FortiCloud customer account ID. type: str
more...
|
Supported Version Ranges |
| account_id |
v6.0.0 -> 7.6.6 |
- 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, DJ, DM, DO, EC, EG, SV, ET, EE, GF, PF, FO, FJ, FI, FR, GA, GE, GM, 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, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MA, MZ, MM, NA, NP, NL, AN, AW, NZ, NI, NE, NG, NO, 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, SO, ZA, ES, LK, SR, SZ, SE, CH, TW, TZ, TH, TL, 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...
|
Supported Version Ranges |
| country |
v6.0.0 -> 7.6.6 |
| [--] |
v7.0.1 -> 7.6.6 |
| [AF] |
v7.0.0 -> 7.6.6 |
| [AL] |
v6.0.0 -> 7.6.6 |
| [DZ] |
v6.0.0 -> 7.6.6 |
| [AS] |
v7.0.0 -> 7.6.6 |
| [AO] |
v6.0.0 -> 7.6.6 |
| [AR] |
v6.0.0 -> 7.6.6 |
| [AM] |
v6.0.0 -> 7.6.6 |
| [AU] |
v6.0.0 -> 7.6.6 |
| [AT] |
v6.0.0 -> 7.6.6 |
| [AZ] |
v6.0.0 -> 7.6.6 |
| [BS] |
v6.4.0 -> 7.6.6 |
| [BH] |
v6.0.0 -> 7.6.6 |
| [BD] |
v6.0.0 -> 7.6.6 |
| [BB] |
v6.0.0 -> 7.6.6 |
| [BY] |
v6.0.0 -> 7.6.6 |
| [BE] |
v6.0.0 -> 7.6.6 |
| [BZ] |
v6.0.0 -> 7.6.6 |
| [BJ] |
v7.0.0 -> 7.6.6 |
| [BM] |
v7.0.0 -> 7.6.6 |
| [BT] |
v7.0.0 -> 7.6.6 |
| [BO] |
v6.0.0 -> 7.6.6 |
| [BA] |
v6.0.0 -> 7.6.6 |
| [BW] |
v7.0.0 -> 7.6.6 |
| [BR] |
v6.0.0 -> 7.6.6 |
| [BN] |
v6.0.0 -> 7.6.6 |
| [BG] |
v6.0.0 -> 7.6.6 |
| [BF] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [KH] |
v6.0.0 -> 7.6.6 |
| [CM] |
v7.0.0 -> 7.6.6 |
| [KY] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [CF] |
v6.2.0 -> 7.6.6 |
| [TD] |
v7.0.0 -> 7.6.6 |
| [CL] |
v6.0.0 -> 7.6.6 |
| [CN] |
v6.0.0 -> 7.6.6 |
| [CX] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [CO] |
v6.0.0 -> 7.6.6 |
| [CG] |
v7.0.0 -> 7.6.6 |
| [CD] |
v7.0.0 -> 7.6.6 |
| [CR] |
v6.0.0 -> 7.6.6 |
| [HR] |
v6.0.0 -> 7.6.6 |
| [CY] |
v6.0.0 -> 7.6.6 |
| [CZ] |
v6.0.0 -> 7.6.6 |
| [DK] |
v6.0.0 -> 7.6.6 |
| [DJ] |
v7.4.1 -> 7.6.6 |
| [DM] |
v7.0.0 -> 7.6.6 |
| [DO] |
v6.0.0 -> 7.6.6 |
| [EC] |
v6.0.0 -> 7.6.6 |
| [EG] |
v6.0.0 -> 7.6.6 |
| [SV] |
v6.0.0 -> 7.6.6 |
| [ET] |
v7.0.0 -> 7.6.6 |
| [EE] |
v6.0.0 -> 7.6.6 |
| [GF] |
v7.0.0 -> 7.6.6 |
| [PF] |
v7.0.0 -> 7.6.6 |
| [FO] |
v7.0.0 -> 7.6.6 |
| [FJ] |
v7.0.0 -> 7.6.6 |
| [FI] |
v6.0.0 -> 7.6.6 |
| [FR] |
v6.0.0 -> 7.6.6 |
| [GA] |
v7.4.1 -> 7.6.6 |
| [GE] |
v6.0.0 -> 7.6.6 |
| [GM] |
v7.4.1 -> 7.6.6 |
| [DE] |
v6.0.0 -> 7.6.6 |
| [GH] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [GI] |
v7.0.0 -> 7.6.6 |
| [GR] |
v6.0.0 -> 7.6.6 |
| [GL] |
v6.0.0 -> 7.6.6 |
| [GD] |
v6.0.0 -> 7.6.6 |
| [GP] |
v7.0.0 -> 7.6.6 |
| [GU] |
v6.0.0 -> 7.6.6 |
| [GT] |
v6.0.0 -> 7.6.6 |
| [GY] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [HT] |
v6.0.0 -> 7.6.6 |
| [HN] |
v6.0.0 -> 7.6.6 |
| [HK] |
v6.0.0 -> 7.6.6 |
| [HU] |
v6.0.0 -> 7.6.6 |
| [IS] |
v6.0.0 -> 7.6.6 |
| [IN] |
v6.0.0 -> 7.6.6 |
| [ID] |
v6.0.0 -> 7.6.6 |
| [IQ] |
v7.0.0 -> 7.6.6 |
| [IE] |
v6.0.0 -> 7.6.6 |
| [IM] |
v7.0.0 -> 7.6.6 |
| [IL] |
v6.0.0 -> 7.6.6 |
| [IT] |
v6.0.0 -> 7.6.6 |
| [CI] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [JM] |
v6.0.0 -> 7.6.6 |
| [JO] |
v6.0.0 -> 7.6.6 |
| [KZ] |
v6.0.0 -> 7.6.6 |
| [KE] |
v6.0.0 -> 7.6.6 |
| [KR] |
v6.0.0 -> 7.6.6 |
| [KW] |
v6.0.0 -> 7.6.6 |
| [LA] |
v7.0.0 -> 7.6.6 |
| [LV] |
v6.0.0 -> 7.6.6 |
| [LB] |
v6.0.0 -> 7.6.6 |
| [LS] |
v7.0.0 -> 7.6.6 |
| [LR] |
v7.4.1 -> 7.6.6 |
| [LY] |
v7.0.0 -> 7.6.6 |
| [LI] |
v6.0.0 -> 7.6.6 |
| [LT] |
v6.0.0 -> 7.6.6 |
| [LU] |
v6.0.0 -> 7.6.6 |
| [MO] |
v6.0.0 -> 7.6.6 |
| [MK] |
v6.0.0 -> 7.6.6 |
| [MG] |
v7.0.0 -> 7.6.6 |
| [MW] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [MY] |
v6.0.0 -> 7.6.6 |
| [MV] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [ML] |
v7.0.0 -> 7.6.6 |
| [MT] |
v6.0.0 -> 7.6.6 |
| [MH] |
v7.0.0 -> 7.6.6 |
| [MQ] |
v7.0.0 -> 7.6.6 |
| [MR] |
v7.0.0 -> 7.6.6 |
| [MU] |
v7.0.0 -> 7.6.6 |
| [YT] |
v7.0.0 -> 7.6.6 |
| [MX] |
v6.0.0 -> 7.6.6 |
| [FM] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [MD] |
v7.0.0 -> 7.6.6 |
| [MC] |
v6.0.0 -> 7.6.6 |
| [MN] |
v7.0.8 -> v7.0.12 |
v7.2.4 -> 7.6.6 |
| [MA] |
v6.0.0 -> 7.6.6 |
| [MZ] |
v6.0.0 -> 7.6.6 |
| [MM] |
v6.0.0 -> 7.6.6 |
| [NA] |
v6.0.0 -> 7.6.6 |
| [NP] |
v6.0.0 -> 7.6.6 |
| [NL] |
v6.0.0 -> 7.6.6 |
| [AN] |
v6.0.0 -> 7.6.6 |
| [AW] |
v6.0.0 -> 7.6.6 |
| [NZ] |
v6.0.0 -> 7.6.6 |
| [NI] |
v7.0.0 -> 7.6.6 |
| [NE] |
v7.0.0 -> 7.6.6 |
| [NG] |
v7.4.1 -> 7.6.6 |
| [NO] |
v6.0.0 -> 7.6.6 |
| [MP] |
v7.0.0 -> 7.6.6 |
| [OM] |
v6.0.0 -> 7.6.6 |
| [PK] |
v6.0.0 -> 7.6.6 |
| [PW] |
v7.0.0 -> 7.6.6 |
| [PA] |
v6.0.0 -> 7.6.6 |
| [PG] |
v6.0.0 -> 7.6.6 |
| [PY] |
v6.0.0 -> 7.6.6 |
| [PE] |
v6.0.0 -> 7.6.6 |
| [PH] |
v6.0.0 -> 7.6.6 |
| [PL] |
v6.0.0 -> 7.6.6 |
| [PT] |
v6.0.0 -> 7.6.6 |
| [PR] |
v6.0.0 -> 7.6.6 |
| [QA] |
v6.0.0 -> 7.6.6 |
| [RE] |
v7.0.0 -> 7.6.6 |
| [RO] |
v6.0.0 -> 7.6.6 |
| [RU] |
v6.0.0 -> 7.6.6 |
| [RW] |
v6.0.0 -> 7.6.6 |
| [BL] |
v7.0.0 -> 7.6.6 |
| [KN] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [LC] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [MF] |
v7.0.0 -> 7.6.6 |
| [PM] |
v7.0.0 -> 7.6.6 |
| [VC] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [SA] |
v6.0.0 -> 7.6.6 |
| [SN] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [RS] |
v6.0.0 -> 7.6.6 |
| [ME] |
v6.0.0 -> 7.6.6 |
| [SL] |
v7.0.0 -> 7.6.6 |
| [SG] |
v6.0.0 -> 7.6.6 |
| [SK] |
v6.0.0 -> 7.6.6 |
| [SI] |
v6.0.0 -> 7.6.6 |
| [SO] |
v7.4.1 -> 7.6.6 |
| [ZA] |
v6.0.0 -> 7.6.6 |
| [ES] |
v6.0.0 -> 7.6.6 |
| [LK] |
v6.0.0 -> 7.6.6 |
| [SR] |
v7.0.0 -> 7.6.6 |
| [SZ] |
v7.4.1 -> 7.6.6 |
| [SE] |
v6.0.0 -> 7.6.6 |
| [CH] |
v6.0.0 -> 7.6.6 |
| [TW] |
v6.0.0 -> 7.6.6 |
| [TZ] |
v6.0.0 -> 7.6.6 |
| [TH] |
v6.0.0 -> 7.6.6 |
| [TL] |
v7.6.3 -> 7.6.6 |
| [TG] |
v7.0.0 -> 7.6.6 |
| [TT] |
v6.0.0 -> 7.6.6 |
| [TN] |
v6.0.0 -> 7.6.6 |
| [TR] |
v6.0.0 -> 7.6.6 |
| [TM] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [AE] |
v6.0.0 -> 7.6.6 |
| [TC] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [UG] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [UA] |
v6.0.0 -> 7.6.6 |
| [GB] |
v6.0.0 -> 7.6.6 |
| [US] |
v6.0.0 -> 7.6.6 |
| [PS] |
v6.0.0 -> 7.6.6 |
| [UY] |
v6.0.0 -> 7.6.6 |
| [UZ] |
v6.0.0 -> 7.6.6 |
| [VU] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [VE] |
v6.0.0 -> 7.6.6 |
| [VN] |
v6.0.0 -> 7.6.6 |
| [VI] |
v7.0.0 -> 7.6.6 |
| [WF] |
v7.0.0 -> 7.6.6 |
| [YE] |
v6.0.0 -> 7.6.6 |
| [ZM] |
v7.0.0 -> 7.6.6 |
| [ZW] |
v6.0.0 -> 7.6.6 |
| [JP] |
v6.0.0 -> 7.6.6 |
| [CA] |
v6.0.0 -> 7.6.6 |
| [IR] |
v6.0.0 -> v6.4.4 |
| [KP] |
v6.0.0 -> v6.4.4 |
| [SD] |
v6.0.0 -> v6.4.4 |
| [SY] |
v6.0.0 -> v6.4.4 |
| [ZB] |
v6.0.0 -> v6.4.4 |
- darrp_optimize - Time for running Distributed Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). type: int
more...
|
Supported Version Ranges |
| darrp_optimize |
v6.2.0 -> 7.6.6 |
- 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 member_path: darrp_optimize_schedules:name
more...
| Supported Version Ranges |
| darrp_optimize_schedules |
v6.2.0 -> 7.6.6 |
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- device_holdoff - Lower limit of creation time of device for identification in minutes (0 - 60). type: int
more...
|
Supported Version Ranges |
| device_holdoff |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- device_idle - Upper limit of idle time of device for identification in minutes (0 - 14400). type: int
more...
|
Supported Version Ranges |
| device_idle |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- device_weight - Upper limit of confidence of device for identification (0 - 255). type: int
more...
|
Supported Version Ranges |
| device_weight |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- 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...
|
Supported Version Ranges |
| duplicate_ssid |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- fake_ssid_action - Actions taken for detected fake SSID. type: list choices: log, suppress
more...
|
Supported Version Ranges |
| fake_ssid_action |
v6.2.0 -> 7.6.6 |
| [log] |
v6.2.0 -> 7.6.6 |
| [suppress] |
v6.2.0 -> 7.6.6 |
- fapc_compatibility - Enable/disable FAP-C series compatibility. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fapc_compatibility |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- firmware_provision_on_authorization - Enable/disable automatic provisioning of latest firmware on authorization. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| firmware_provision_on_authorization |
v7.0.2 -> 7.6.6 |
| [enable] |
v7.0.2 -> 7.6.6 |
| [disable] |
v7.0.2 -> 7.6.6 |
- offending_ssid - Configure offending SSID. type: list member_path: offending_ssid:id
more...
| Supported Version Ranges |
| offending_ssid |
v6.2.0 -> 7.6.6 |
- action - Actions taken for detected offending SSID. type: list choices: log, suppress
more...
|
Supported Version Ranges |
| action |
v6.2.0 -> 7.6.6 |
| [log] |
v6.2.0 -> 7.6.6 |
| [suppress] |
v6.2.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.2.0 -> 7.6.6 |
- ssid_pattern - Define offending SSID pattern (case insensitive). For example, word, word*, *word, wo*rd. type: str
more...
|
Supported Version Ranges |
| ssid_pattern |
v6.2.0 -> 7.6.6 |
- phishing_ssid_detect - Enable/disable phishing SSID detection. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| phishing_ssid_detect |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- rolling_wtp_upgrade - Enable/disable rolling WTP upgrade . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rolling_wtp_upgrade |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
- wfa_compatibility - Enable/disable WFA compatibility. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| wfa_compatibility |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: VDOM wireless controller configuration.
fortinet.fortios.fortios_wireless_controller_setting:
vdom: "{{ vdom }}"
wireless_controller_setting:
account_id: ""
country: "--"
darrp_optimize: "86400"
darrp_optimize_schedules:
-
name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
device_holdoff: "5"
device_idle: "1440"
device_weight: "1"
duplicate_ssid: "enable"
fake_ssid_action: "log"
fapc_compatibility: "enable"
firmware_provision_on_authorization: "enable"
offending_ssid:
-
action: "log"
id: "17"
ssid_pattern: ""
phishing_ssid_detect: "enable"
rolling_wtp_upgrade: "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:
.. raw:: html
- 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
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.