:source: fortios_wireless_controller_global.py
:orphan:
.. fortios_wireless_controller_global:
fortios_wireless_controller_global -- Configure wireless controller global settings in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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...
| Supported Version Ranges |
| wireless_controller_global |
v6.0.0 -> 7.6.6 |
- acd_process_count - Configure the number cw_acd daemons for multi-core CPU support . type: int
more...
|
Supported Version Ranges |
| acd_process_count |
v7.2.4 -> 7.6.6 |
- 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...
|
Supported Version Ranges |
| ap_log_server |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ap_log_server_ip - IP address that FortiGate or FortiAPs send log messages to. type: str
more...
|
Supported Version Ranges |
| ap_log_server_ip |
v6.0.0 -> 7.6.6 |
- ap_log_server_port - Port that FortiGate or FortiAPs send log messages to. type: int
more...
|
Supported Version Ranges |
| ap_log_server_port |
v6.0.0 -> 7.6.6 |
- 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...
|
Supported Version Ranges |
| control_message_offload |
v6.0.0 -> 7.6.6 |
| [ebp-frame] |
v6.0.0 -> 7.6.6 |
| [aeroscout-tag] |
v6.0.0 -> 7.6.6 |
| [ap-list] |
v6.0.0 -> 7.6.6 |
| [sta-list] |
v6.0.0 -> 7.6.6 |
| [sta-cap-list] |
v6.0.0 -> 7.6.6 |
| [stats] |
v6.0.0 -> 7.6.6 |
| [aeroscout-mu] |
v6.0.0 -> 7.6.6 |
| [sta-health] |
v6.2.0 -> 7.6.6 |
| [spectral-analysis] |
v6.4.0 -> 7.6.6 |
- 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...
|
Supported Version Ranges |
| data_ethernet_II |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dfs_lab_test - Enable/disable DFS certificate lab test mode. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dfs_lab_test |
v7.0.12 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.0.12 -> v7.0.12 |
| [disable] |
v7.0.12 -> v7.0.12 |
- discovery_mc_addr - Multicast IP address for AP discovery . type: str
more...
|
Supported Version Ranges |
| discovery_mc_addr |
v6.0.0 -> 7.6.6 |
- discovery_mc_addr6 - Multicast IPv6 address for AP discovery . type: str
more...
|
Supported Version Ranges |
| discovery_mc_addr6 |
v7.6.5 -> 7.6.6 |
- fiapp_eth_type - Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535). type: int
more...
|
Supported Version Ranges |
| fiapp_eth_type |
v6.0.0 -> 7.6.6 |
- image_download - Enable/disable WTP image download at join time. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| image_download |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ipsec_base_ip - Base IP address for IPsec VPN tunnels between the access points and the wireless controller . type: str
more...
|
Supported Version Ranges |
| ipsec_base_ip |
v6.0.0 -> 7.6.6 |
- link_aggregation - Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| link_aggregation |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- location - Description of the location of the wireless controller. type: str
more...
|
Supported Version Ranges |
| location |
v6.0.0 -> 7.6.6 |
- max_ble_device - Maximum number of BLE devices stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_ble_device |
v7.4.4 -> 7.6.6 |
- max_clients - Maximum number of clients that can connect simultaneously . type: int
more...
|
Supported Version Ranges |
| max_clients |
v6.0.0 -> 7.6.6 |
- max_retransmit - Maximum number of tunnel packet retransmissions (0 - 64). type: int
more...
|
Supported Version Ranges |
| max_retransmit |
v6.0.0 -> 7.6.6 |
- max_rogue_ap - Maximum number of rogue APs stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_rogue_ap |
v7.4.4 -> 7.6.6 |
- max_rogue_ap_wtp - Maximum number of rogue AP"s wtp info stored on the controller (1 - 16). type: int
more...
|
Supported Version Ranges |
| max_rogue_ap_wtp |
v7.4.4 -> 7.6.6 |
- max_rogue_sta - Maximum number of rogue stations stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_rogue_sta |
v7.4.4 -> 7.6.6 |
- max_sta_cap - Maximum number of station cap stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_sta_cap |
v7.4.4 -> 7.6.6 |
- max_sta_cap_wtp - Maximum number of station cap"s wtp info stored on the controller (1 - 16). type: int
more...
|
Supported Version Ranges |
| max_sta_cap_wtp |
v7.4.4 -> 7.6.6 |
- max_sta_offline - Maximum number of station offline stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_sta_offline |
v7.6.3 -> 7.6.6 |
- max_sta_offline_ip2mac - Maximum number of station offline ip2mac stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_sta_offline_ip2mac |
v7.6.3 -> 7.6.6 |
- max_wids_entry - Maximum number of wids entries stored on the controller . type: int
more...
|
Supported Version Ranges |
| max_wids_entry |
v7.6.1 -> 7.6.6 |
- mesh_eth_type - Mesh Ethernet identifier included in backhaul packets (0 - 65535). type: int
more...
|
Supported Version Ranges |
| mesh_eth_type |
v6.0.0 -> 7.6.6 |
- nac_interval - Interval in seconds between two WiFi network access control (NAC) checks (10 - 600). type: int
more...
|
Supported Version Ranges |
| nac_interval |
v7.0.2 -> 7.6.6 |
- name - Name of the wireless controller. type: str
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- 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...
|
Supported Version Ranges |
| rogue_scan_mac_adjacency |
v6.0.0 -> 7.6.6 |
- rolling_wtp_upgrade - Enable/disable rolling WTP upgrade . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rolling_wtp_upgrade |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
- rolling_wtp_upgrade_threshold - Minimum signal level/threshold in dBm required for the managed WTP to be included in rolling WTP upgrade (-95 to -20). type: str
more...
|
Supported Version Ranges |
| rolling_wtp_upgrade_threshold |
v7.4.2 -> 7.6.6 |
- tunnel_mode - Compatible/strict tunnel mode. type: str choices: compatible, strict
more...
|
Supported Version Ranges |
| tunnel_mode |
v7.0.1 -> 7.6.6 |
| [compatible] |
v7.0.1 -> 7.6.6 |
| [strict] |
v7.0.1 -> 7.6.6 |
- wpad_process_count - Wpad daemon process count for multi-core CPU support. type: int
more...
|
Supported Version Ranges |
| wpad_process_count |
v7.4.0 -> 7.6.6 |
- wtp_share - Enable/disable sharing of WTPs between VDOMs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| wtp_share |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- 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: ""
ap_log_server_port: "0"
control_message_offload: "ebp-frame"
data_ethernet_II: "enable"
dfs_lab_test: "enable"
discovery_mc_addr: ""
discovery_mc_addr6: ""
fiapp_eth_type: "5252"
image_download: "enable"
ipsec_base_ip: ""
link_aggregation: "enable"
location: ""
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"
max_sta_offline: "0"
max_sta_offline_ip2mac: "0"
max_wids_entry: "0"
mesh_eth_type: "8755"
nac_interval: "120"
name: "default_name_30"
rogue_scan_mac_adjacency: "7"
rolling_wtp_upgrade: "enable"
rolling_wtp_upgrade_threshold: ""
tunnel_mode: "compatible"
wpad_process_count: "0"
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:
.. raw:: html
- 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
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.