fortios_wireless_controller_global – Configure wireless controller global settings in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_wireless_controller_global | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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_global - Configure wireless controller global settings. type: dict more...
- ap_log_server - Enable/disable configuring FortiGate to redirect wireless event log messages or FortiAPs to send UTM log messages to a syslog server . type: str choices: enable, disable more...
- ap_log_server_ip - IP address that FortiGate or FortiAPs send log messages to. type: str more...
- ap_log_server_port - Port that FortiGate or FortiAPs send log messages to. type: int more...
- control_message_offload - Configure CAPWAP control message data channel offload. type: list choices: ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu, sta-health, spectral-analysis more...
- 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 more...
- discovery_mc_addr - Multicast IP address for AP discovery . type: str more...
- fiapp_eth_type - Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535). type: int more...
- image_download - Enable/disable WTP image download at join time. type: str choices: enable, disable more...
- ipsec_base_ip - Base IP address for IPsec VPN tunnels between the access points and the wireless controller . type: str more...
- link_aggregation - Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes . type: str choices: enable, disable more...
- location - Description of the location of the wireless controller. type: str more...
- max_clients - Maximum number of clients that can connect simultaneously . type: int more...
- max_retransmit - Maximum number of tunnel packet retransmissions (0 - 64). type: int more...
- mesh_eth_type - Mesh Ethernet identifier included in backhaul packets (0 - 65535). type: int more...
- nac_interval - Interval in seconds between two WiFi network access control (NAC) checks (10 - 600). type: int more...
- name - Name of the wireless controller. type: str more...
- 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 more...
- tunnel_mode - Compatible/strict tunnel mode. type: str choices: compatible, strict more...
- wtp_share - Enable/disable sharing of WTPs between VDOMs. type: str choices: enable, disable more...
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: "0"
control_message_offload: "ebp-frame"
data_ethernet_II: "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_clients: "0"
max_retransmit: "3"
mesh_eth_type: "8755"
nac_interval: "120"
name: "default_name_18"
rogue_scan_mac_adjacency: "7"
tunnel_mode: "compatible"
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