fortinet.fortios.fortios_wireless_controller_setting – VDOM wireless controller configuration in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_setting.
New in version 2.10: of fortinet.fortios
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.9.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| vdom
string
|
Default:
"root"
|
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.
|
||
| wireless_controller_setting
dictionary
|
VDOM wireless controller configuration.
|
|||
| account_id
string
|
FortiCloud customer account ID.
|
|||
| country
string
|
|
Country or region in which the FortiGate is located. The country determines the 802.11 bands and channels that are available.
|
||
| darrp_optimize
integer
|
Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec).
|
|||
| darrp_optimize_schedules
list / elements=string
|
Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space.
|
|||
| name
string / required
|
Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name.
|
|||
| device_holdoff
integer
|
Lower limit of creation time of device for identification in minutes (0 - 60).
|
|||
| device_idle
integer
|
Upper limit of idle time of device for identification in minutes (0 - 14400).
|
|||
| device_weight
integer
|
Upper limit of confidence of device for identification (0 - 255).
|
|||
| duplicate_ssid
string
|
|
Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name in the same VDOM.
|
||
| fake_ssid_action
list / elements=string
|
|
Actions taken for detected fake SSID.
|
||
| fapc_compatibility
string
|
|
Enable/disable FAP-C series compatibility.
|
||
| offending_ssid
list / elements=string
|
Configure offending SSID.
|
|||
| action
string
|
|
Actions taken for detected offending SSID.
|
||
| id
integer / required
|
ID.
|
|||
| ssid_pattern
string
|
Define offending SSID pattern (case insensitive), eg: word, word*, *word, wo*rd.
|
|||
| phishing_ssid_detect
string
|
|
Enable/disable phishing SSID detection.
|
||
| wfa_compatibility
string
|
|
Enable/disable WFA compatibility.
|
||
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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)"
device_holdoff: "8"
device_idle: "9"
device_weight: "10"
duplicate_ssid: "enable"
fake_ssid_action: "log"
fapc_compatibility: "enable"
offending_ssid:
-
action: "log"
id: "16"
ssid_pattern: "<your_own_value>"
phishing_ssid_detect: "enable"
wfa_compatibility: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_setting_module.html