fortios_wireless_controller_global – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- wireless_controller_global - Configure wireless controller global settings. type: dict
- ap_log_server - Enable/disable configuring APs or FortiAPs to send log messages to a syslog server . type: str choices: enable, disable
- ap_log_server_ip - IP address that APs or FortiAPs send log messages to. type: str
- ap_log_server_port - Port that APs or FortiAPs send log messages to. type: int
- control_message_offload - Configure CAPWAP control message data channel offload. type: str choices: ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu
- data_ethernet_II - Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3 data tunnel mode . type: str choices: enable, disable
- discovery_mc_addr - Multicast IP address for AP discovery . type: str
- fiapp_eth_type - Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535). type: int
- image_download - Enable/disable WTP image download at join time. type: str choices: enable, disable
- ipsec_base_ip - Base IP address for IPsec VPN tunnels between the access points and the wireless controller . type: str
- link_aggregation - Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes . type: str choices: enable, disable
- location - Description of the location of the wireless controller. type: str
- max_clients - Maximum number of clients that can connect simultaneously . type: int
- max_retransmit - Maximum number of tunnel packet retransmissions (0 - 64). type: int
- mesh_eth_type - Mesh Ethernet identifier included in backhaul packets (0 - 65535). type: int
- name - Name of the wireless controller. type: str
- rogue_scan_mac_adjacency - Maximum numerical difference between an AP"s Ethernet and wireless MAC values to match for rogue detection (0 - 31). type: int
- wtp_share - Enable/disable sharing of WTPs between VDOMs. type: str choices: enable, disable
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: 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