fortinet.fortios.fortios_wireless_controller_global – Configure wireless controller global settings 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_global.
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 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.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_global
dictionary
|
Configure wireless controller global settings.
|
||
| ap_log_server
string
|
|
Enable/disable configuring APs or FortiAPs to send log messages to a syslog server .
|
|
| ap_log_server_ip
string
|
IP address that APs or FortiAPs send log messages to.
|
||
| ap_log_server_port
integer
|
Port that APs or FortiAPs send log messages to.
|
||
| control_message_offload
list / elements=string
|
|
Configure CAPWAP control message data channel offload.
|
|
| data_ethernet_II
string
|
|
Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3 data tunnel mode .
|
|
| discovery_mc_addr
string
|
Multicast IP address for AP discovery .
|
||
| fiapp_eth_type
integer
|
Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535).
|
||
| image_download
string
|
|
Enable/disable WTP image download at join time.
|
|
| ipsec_base_ip
string
|
Base IP address for IPsec VPN tunnels between the access points and the wireless controller .
|
||
| link_aggregation
string
|
|
Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes .
|
|
| location
string
|
Description of the location of the wireless controller.
|
||
| max_clients
integer
|
Maximum number of clients that can connect simultaneously .
|
||
| max_retransmit
integer
|
Maximum number of tunnel packet retransmissions (0 - 64).
|
||
| mesh_eth_type
integer
|
Mesh Ethernet identifier included in backhaul packets (0 - 65535).
|
||
| name
string
|
Name of the wireless controller.
|
||
| rogue_scan_mac_adjacency
integer
|
Maximum numerical difference between an AP"s Ethernet and wireless MAC values to match for rogue detection (0 - 31).
|
||
| wtp_share
string
|
|
Enable/disable sharing of WTPs between VDOMs.
|
|
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: Configure wireless controller global settings.
fortios_wireless_controller_global:
vdom: "{{ vdom }}"
wireless_controller_global:
ap_log_server: "enable"
ap_log_server_ip: "<your_own_value>"
ap_log_server_port: "5"
control_message_offload: "ebp-frame"
data_ethernet_II: "enable"
discovery_mc_addr: "<your_own_value>"
fiapp_eth_type: "9"
image_download: "enable"
ipsec_base_ip: "<your_own_value>"
link_aggregation: "enable"
location: "<your_own_value>"
max_clients: "14"
max_retransmit: "15"
mesh_eth_type: "16"
name: "default_name_17"
rogue_scan_mac_adjacency: "18"
wtp_share: "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_global_module.html