fortinet.fortios.fortios_wireless_controller_global module – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_global.
New in fortinet.fortios 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 global 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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: |
|
Configure wireless controller global settings. |
|
Configure the number cw_acd daemons for multi-core CPU support . |
|
Enable/disable configuring FortiGate to redirect wireless event log messages or FortiAPs to send UTM log messages to a syslog server . Choices:
|
|
IP address that FortiGate or FortiAPs send log messages to. |
|
Port that FortiGate or FortiAPs send log messages to. |
|
Configure CAPWAP control message data channel offload. Choices:
|
|
Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3 data tunnel mode . Choices:
|
|
Enable/disable DFS certificate lab test mode. Choices:
|
|
Multicast IP address for AP discovery . |
|
Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535). |
|
Enable/disable WTP image download at join time. Choices:
|
|
Base IP address for IPsec VPN tunnels between the access points and the wireless controller . |
|
Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes . Choices:
|
|
Description of the location of the wireless controller. |
|
Maximum number of BLE devices stored on the controller . |
|
Maximum number of clients that can connect simultaneously . |
|
Maximum number of tunnel packet retransmissions (0 - 64). |
|
Maximum number of rogue APs stored on the controller . |
|
Maximum number of rogue AP”s wtp info stored on the controller (1 - 16). |
|
Maximum number of rogue stations stored on the controller . |
|
Maximum number of station cap stored on the controller . |
|
Maximum number of station cap”s wtp info stored on the controller (1 - 16). |
|
Mesh Ethernet identifier included in backhaul packets (0 - 65535). |
|
Interval in seconds between two WiFi network access control (NAC) checks (10 - 600). |
|
Name of the wireless controller. |
|
Maximum numerical difference between an AP”s Ethernet and wireless MAC values to match for rogue detection (0 - 31). |
|
Enable/disable rolling WTP upgrade . Choices:
|
|
Minimum signal level/threshold in dBm required for the managed WTP to be included in rolling WTP upgrade (-95 to -20). |
|
Compatible/strict tunnel mode. Choices:
|
|
Wpad daemon process count for multi-core CPU support. |
|
Enable/disable sharing of WTPs between VDOMs. Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure wireless controller global settings.
fortinet.fortios.fortios_wireless_controller_global:
vdom: "{{ vdom }}"
wireless_controller_global:
acd_process_count: "0"
ap_log_server: "enable"
ap_log_server_ip: "<your_own_value>"
ap_log_server_port: "0"
control_message_offload: "ebp-frame"
data_ethernet_II: "enable"
dfs_lab_test: "enable"
discovery_mc_addr: "<your_own_value>"
fiapp_eth_type: "5252"
image_download: "enable"
ipsec_base_ip: "<your_own_value>"
link_aggregation: "enable"
location: "<your_own_value>"
max_ble_device: "0"
max_clients: "0"
max_retransmit: "3"
max_rogue_ap: "0"
max_rogue_ap_wtp: "16"
max_rogue_sta: "0"
max_sta_cap: "0"
max_sta_cap_wtp: "8"
mesh_eth_type: "8755"
nac_interval: "120"
name: "default_name_26"
rogue_scan_mac_adjacency: "7"
rolling_wtp_upgrade: "enable"
rolling_wtp_upgrade_threshold: "<your_own_value>"
tunnel_mode: "compatible"
wpad_process_count: "0"
wtp_share: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |