:source: fortios_wireless_controller_wtp.py
:orphan:
.. fortios_wireless_controller_wtp:
fortios_wireless_controller_wtp -- Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate 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 wtp 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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_wtp - Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate. type: dict
more...
| Supported Version Ranges |
| wireless_controller_wtp |
v6.0.0 -> 7.6.6 |
- admin - Configure how the FortiGate operating as a wireless controller discovers and manages this WTP, AP or FortiAP. type: str choices: discovered, disable, enable
more...
|
Supported Version Ranges |
| admin |
v6.0.0 -> 7.6.6 |
| [discovered] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- allowaccess - Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space. type: list choices: https, ssh, snmp, telnet, http
more...
|
Supported Version Ranges |
| allowaccess |
v6.0.0 -> 7.6.6 |
| [https] |
v6.0.0 -> 7.6.6 |
| [ssh] |
v6.0.0 -> 7.6.6 |
| [snmp] |
v6.2.0 -> 7.6.6 |
| [telnet] |
v6.0.0 -> v6.0.11 |
| [http] |
v6.0.0 -> v6.0.11 |
- apcfg_profile - AP local configuration profile name. Source wireless-controller.apcfg-profile.name. type: str
more...
|
Supported Version Ranges |
| apcfg_profile |
v6.4.0 -> 7.6.6 |
- ble_major_id - Override BLE Major ID. type: int
more...
|
Supported Version Ranges |
| ble_major_id |
v7.4.1 -> 7.6.6 |
- ble_minor_id - Override BLE Minor ID. type: int
more...
|
Supported Version Ranges |
| ble_minor_id |
v7.4.1 -> 7.6.6 |
- bonjour_profile - Bonjour profile name. Source wireless-controller.bonjour-profile.name. type: str
more...
|
Supported Version Ranges |
| bonjour_profile |
v6.0.0 -> 7.6.6 |
- comment - Comment. type: str
more...
|
Supported Version Ranges |
| comment |
v7.6.1 -> 7.6.6 |
- coordinate_enable - Enable/disable WTP coordinates (X,Y axis). type: str choices: enable, disable
more...
|
Supported Version Ranges |
| coordinate_enable |
v6.0.0 -> v6.0.11 |
| [enable] |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
- coordinate_latitude - WTP latitude coordinate. type: str
more...
|
Supported Version Ranges |
| coordinate_latitude |
v6.0.0 -> 7.6.6 |
- coordinate_longitude - WTP longitude coordinate. type: str
more...
|
Supported Version Ranges |
| coordinate_longitude |
v6.0.0 -> 7.6.6 |
- coordinate_x - X axis coordinate. type: str
more...
|
Supported Version Ranges |
| coordinate_x |
v6.0.0 -> v6.0.11 |
- coordinate_y - Y axis coordinate. type: str
more...
|
Supported Version Ranges |
| coordinate_y |
v6.0.0 -> v6.0.11 |
- default_mesh_root - Configure default mesh root SSID when it is not included by radio"s SSID configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| default_mesh_root |
v7.6.4 -> 7.6.6 |
| [enable] |
v7.6.4 -> 7.6.6 |
| [disable] |
v7.6.4 -> 7.6.6 |
- firmware_provision - Firmware version to provision to this FortiAP on bootup (major.minor.build, i.e. 6.2.1234). type: str
more...
|
Supported Version Ranges |
| firmware_provision |
v6.4.0 -> 7.6.6 |
- firmware_provision_latest - Enable/disable one-time automatic provisioning of the latest firmware version. type: str choices: disable, once
more...
|
Supported Version Ranges |
| firmware_provision_latest |
v7.0.2 -> 7.6.6 |
| [disable] |
v7.0.2 -> 7.6.6 |
| [once] |
v7.0.2 -> 7.6.6 |
- image_download - Enable/disable WTP image download. 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 |
- index - Index (0 - 4294967295). type: int
more...
|
Supported Version Ranges |
| index |
v6.0.0 -> v7.0.5 |
v7.2.0 -> v7.2.0 |
- ip_fragment_preventing - Method(s) by which IP fragmentation is prevented for control and data packets through CAPWAP tunnel . type: list choices: tcp-mss-adjust, icmp-unreachable
more...
|
Supported Version Ranges |
| ip_fragment_preventing |
v6.0.0 -> 7.6.6 |
| [tcp-mss-adjust] |
v6.0.0 -> 7.6.6 |
| [icmp-unreachable] |
v6.0.0 -> 7.6.6 |
- lan - WTP LAN port mapping. type: dict
more...
| Supported Version Ranges |
| lan |
v6.0.0 -> 7.6.6 |
- port_esl_mode - ESL port mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port_esl_mode |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [offline] |
v6.4.0 -> v6.4.0 |
| [nat-to-wan] |
v6.4.0 -> v6.4.0 |
| [bridge-to-wan] |
v6.4.0 -> v6.4.0 |
| [bridge-to-ssid] |
v6.4.0 -> v6.4.0 |
- port_esl_ssid - Bridge ESL port to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port_esl_ssid |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- port_mode - LAN port mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port_ssid - Bridge LAN port to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port_ssid |
v6.0.0 -> 7.6.6 |
- port1_mode - LAN port 1 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port1_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port1_ssid - Bridge LAN port 1 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port1_ssid |
v6.0.0 -> 7.6.6 |
- port2_mode - LAN port 2 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port2_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port2_ssid - Bridge LAN port 2 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port2_ssid |
v6.0.0 -> 7.6.6 |
- port3_mode - LAN port 3 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port3_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port3_ssid - Bridge LAN port 3 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port3_ssid |
v6.0.0 -> 7.6.6 |
- port4_mode - LAN port 4 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port4_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port4_ssid - Bridge LAN port 4 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port4_ssid |
v6.0.0 -> 7.6.6 |
- port5_mode - LAN port 5 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port5_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port5_ssid - Bridge LAN port 5 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port5_ssid |
v6.0.0 -> 7.6.6 |
- port6_mode - LAN port 6 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port6_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port6_ssid - Bridge LAN port 6 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port6_ssid |
v6.0.0 -> 7.6.6 |
- port7_mode - LAN port 7 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port7_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port7_ssid - Bridge LAN port 7 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port7_ssid |
v6.0.0 -> 7.6.6 |
- port8_mode - LAN port 8 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
|
Supported Version Ranges |
| port8_mode |
v6.0.0 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port8_ssid - Bridge LAN port 8 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port8_ssid |
v6.0.0 -> 7.6.6 |
- led_state - Enable to allow the FortiAPs LEDs to light. Disable to keep the LEDs off. You may want to keep the LEDs off so they are not distracting in low light areas etc. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| led_state |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- location - Field for describing the physical location of the WTP, AP or FortiAP. type: str
more...
|
Supported Version Ranges |
| location |
v6.0.0 -> 7.6.6 |
- login_passwd - Set the managed WTP, FortiAP, or AP"s administrator password. type: str
more...
|
Supported Version Ranges |
| login_passwd |
v6.0.0 -> 7.6.6 |
- login_passwd_change - Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no). type: str choices: yes, default, no
more...
|
Supported Version Ranges |
| login_passwd_change |
v6.0.0 -> 7.6.6 |
| [yes] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [no] |
v6.0.0 -> 7.6.6 |
- mesh_bridge_enable - Enable/disable mesh Ethernet bridge when WTP is configured as a mesh branch/leaf AP. type: str choices: default, enable, disable
more...
|
Supported Version Ranges |
| mesh_bridge_enable |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- name - WTP, AP or FortiAP configuration name. type: str
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- override_allowaccess - Enable to override the WTP profile management access configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_allowaccess |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_default_mesh_root - Enable to override the WTP profile default mesh root SSID setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_default_mesh_root |
v7.6.4 -> 7.6.6 |
| [enable] |
v7.6.4 -> 7.6.6 |
| [disable] |
v7.6.4 -> 7.6.6 |
- override_ip_fragment - Enable/disable overriding the WTP profile IP fragment prevention setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_ip_fragment |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_lan - Enable to override the WTP profile LAN port setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_lan |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_led_state - Enable to override the profile LED state setting for this FortiAP. You must enable this option to use the led-state command to turn off the FortiAP"s LEDs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_led_state |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_login_passwd_change - Enable to override the WTP profile login-password (administrator password) setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_login_passwd_change |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_split_tunnel - Enable/disable overriding the WTP profile split tunneling setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_split_tunnel |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_wan_port_mode - Enable/disable overriding the wan-port-mode in the WTP profile. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_wan_port_mode |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- purdue_level - Purdue Level of this WTP. type: str choices: 1, 1.5, 2, 2.5, 3, 3.5, 4, 5, 5.5
more...
|
Supported Version Ranges |
| purdue_level |
v7.4.2 -> 7.6.6 |
| [1] |
v7.4.2 -> 7.6.6 |
| [1.5] |
v7.4.2 -> 7.6.6 |
| [2] |
v7.4.2 -> 7.6.6 |
| [2.5] |
v7.4.2 -> 7.6.6 |
| [3] |
v7.4.2 -> 7.6.6 |
| [3.5] |
v7.4.2 -> 7.6.6 |
| [4] |
v7.4.2 -> 7.6.6 |
| [5] |
v7.4.2 -> 7.6.6 |
| [5.5] |
v7.4.2 -> 7.6.6 |
- radio_1 - Configuration options for radio 1. type: dict
more...
| Supported Version Ranges |
| radio_1 |
v6.0.0 -> 7.6.6 |
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_high |
v6.0.0 -> 7.6.6 |
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_power_level |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_low |
v6.0.0 -> 7.6.6 |
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
|
Supported Version Ranges |
| auto_power_target |
v6.4.4 -> 7.6.6 |
- band - WiFi band that Radio 1 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
|
Supported Version Ranges |
| band |
v6.0.0 -> 7.6.6 |
| [802.11a] |
v6.0.0 -> 7.6.6 |
| [802.11b] |
v6.0.0 -> 7.6.6 |
| [802.11g] |
v6.0.0 -> 7.6.6 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.0.0 -> 7.6.6 |
| [802.11ac-2G] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.0.0 -> v7.4.3 |
| [802.11ac] |
v6.0.0 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v7.4.3 |
| [802.11n,g-only] |
v6.0.0 -> v7.4.3 |
| [802.11g-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-5G-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac,n-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac-only] |
v6.0.0 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v7.4.3 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_1/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.0.0 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.0.0 -> 7.6.6 |
- drma_manual_mode - Radio mode to be used for DRMA manual mode . type: str choices: ap, monitor, ncf, ncf-peek
more...
|
Supported Version Ranges |
| drma_manual_mode |
v6.4.4 -> 7.6.6 |
| [ap] |
v6.4.4 -> 7.6.6 |
| [monitor] |
v6.4.4 -> 7.6.6 |
| [ncf] |
v6.4.4 -> 7.6.6 |
| [ncf-peek] |
v6.4.4 -> 7.6.6 |
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_analysis |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_band |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_channel |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_txpower |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_vaps |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
|
Supported Version Ranges |
| power_level |
v6.0.0 -> 7.6.6 |
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
|
Supported Version Ranges |
| power_mode |
v7.0.0 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- radio_id - radio-id type: int
more...
|
Supported Version Ranges |
| radio_id |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
|
Supported Version Ranges |
| spectrum_analysis |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.0.0 -> v6.2.7 |
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
|
Supported Version Ranges |
| vap_all |
v6.0.0 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_1/vaps:name
more...
| Supported Version Ranges |
| vaps |
v6.0.0 -> 7.6.6 |
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- radio_2 - Configuration options for radio 2. type: dict
more...
| Supported Version Ranges |
| radio_2 |
v6.0.0 -> 7.6.6 |
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_high |
v6.0.0 -> 7.6.6 |
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_power_level |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_low |
v6.0.0 -> 7.6.6 |
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
|
Supported Version Ranges |
| auto_power_target |
v6.4.4 -> 7.6.6 |
- band - WiFi band that Radio 2 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
|
Supported Version Ranges |
| band |
v6.0.0 -> 7.6.6 |
| [802.11a] |
v6.0.0 -> 7.6.6 |
| [802.11b] |
v6.0.0 -> 7.6.6 |
| [802.11g] |
v6.0.0 -> 7.6.6 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.0.0 -> 7.6.6 |
| [802.11ac-2G] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.0.0 -> v7.4.3 |
| [802.11ac] |
v6.0.0 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v7.4.3 |
| [802.11n,g-only] |
v6.0.0 -> v7.4.3 |
| [802.11g-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-5G-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac,n-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac-only] |
v6.0.0 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v7.4.3 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_2/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.0.0 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.0.0 -> 7.6.6 |
- drma_manual_mode - Radio mode to be used for DRMA manual mode . type: str choices: ap, monitor, ncf, ncf-peek
more...
|
Supported Version Ranges |
| drma_manual_mode |
v6.4.4 -> 7.6.6 |
| [ap] |
v6.4.4 -> 7.6.6 |
| [monitor] |
v6.4.4 -> 7.6.6 |
| [ncf] |
v6.4.4 -> 7.6.6 |
| [ncf-peek] |
v6.4.4 -> 7.6.6 |
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_analysis |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_band |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_channel |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_txpower |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_vaps |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
|
Supported Version Ranges |
| power_level |
v6.0.0 -> 7.6.6 |
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
|
Supported Version Ranges |
| power_mode |
v7.0.0 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- radio_id - radio-id type: int
more...
|
Supported Version Ranges |
| radio_id |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
|
Supported Version Ranges |
| spectrum_analysis |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.0.0 -> v6.2.7 |
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
|
Supported Version Ranges |
| vap_all |
v6.0.0 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_2/vaps:name
more...
| Supported Version Ranges |
| vaps |
v6.0.0 -> 7.6.6 |
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- radio_3 - Configuration options for radio 3. type: dict
more...
| Supported Version Ranges |
| radio_3 |
v6.2.0 -> 7.6.6 |
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_high |
v6.2.0 -> 7.6.6 |
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_power_level |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_low |
v6.2.0 -> 7.6.6 |
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
|
Supported Version Ranges |
| auto_power_target |
v6.4.4 -> 7.6.6 |
- band - WiFi band that Radio 3 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
|
Supported Version Ranges |
| band |
v6.2.0 -> 7.6.6 |
| [802.11a] |
v6.2.0 -> 7.6.6 |
| [802.11b] |
v6.2.0 -> 7.6.6 |
| [802.11g] |
v6.2.0 -> 7.6.6 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ac-2G] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.2.0 -> v7.4.3 |
| [802.11ac] |
v6.2.0 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v7.4.3 |
| [802.11n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11g-only] |
v6.2.0 -> v7.4.3 |
| [802.11n-only] |
v6.2.0 -> v7.4.3 |
| [802.11n-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v7.4.3 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_3/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.2.0 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.2.0 -> 7.6.6 |
- drma_manual_mode - Radio mode to be used for DRMA manual mode . type: str choices: ap, monitor, ncf, ncf-peek
more...
|
Supported Version Ranges |
| drma_manual_mode |
v6.4.4 -> 7.6.6 |
| [ap] |
v6.4.4 -> 7.6.6 |
| [monitor] |
v6.4.4 -> 7.6.6 |
| [ncf] |
v6.4.4 -> 7.6.6 |
| [ncf-peek] |
v6.4.4 -> 7.6.6 |
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_analysis |
v6.2.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_band |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_channel |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_txpower |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_vaps |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
|
Supported Version Ranges |
| power_level |
v6.2.0 -> 7.6.6 |
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
|
Supported Version Ranges |
| power_mode |
v7.0.0 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- radio_id - radio-id type: int
more...
|
Supported Version Ranges |
| radio_id |
v6.2.3 -> v6.2.3 |
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
|
Supported Version Ranges |
| spectrum_analysis |
v6.2.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.2.0 -> v6.2.7 |
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
|
Supported Version Ranges |
| vap_all |
v6.2.0 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_3/vaps:name
more...
| Supported Version Ranges |
| vaps |
v6.2.0 -> 7.6.6 |
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- radio_4 - Configuration options for radio 4. type: dict
more...
| Supported Version Ranges |
| radio_4 |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_high |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_power_level |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
|
Supported Version Ranges |
| auto_power_low |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
|
Supported Version Ranges |
| auto_power_target |
v6.4.4 -> 7.6.6 |
- band - WiFi band that Radio 4 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
|
Supported Version Ranges |
| band |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [802.11a] |
v6.2.0 -> v6.2.0 |
| [802.11b] |
v6.2.0 -> v6.2.0 |
| [802.11g] |
v6.2.0 -> v6.2.0 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.2.0 -> v6.2.0 |
| [802.11ac-2G] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> v6.2.0 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ac] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11n,g-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11g-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11n-5G-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ac,n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ac-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_4/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- drma_manual_mode - Radio mode to be used for DRMA manual mode . type: str choices: ap, monitor, ncf, ncf-peek
more...
|
Supported Version Ranges |
| drma_manual_mode |
v6.4.4 -> 7.6.6 |
| [ap] |
v6.4.4 -> 7.6.6 |
| [monitor] |
v6.4.4 -> 7.6.6 |
| [ncf] |
v6.4.4 -> 7.6.6 |
| [ncf-peek] |
v6.4.4 -> 7.6.6 |
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_analysis |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_band |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_channel |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_txpower |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| override_vaps |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
|
Supported Version Ranges |
| power_level |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
|
Supported Version Ranges |
| power_mode |
v7.0.0 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
|
Supported Version Ranges |
| spectrum_analysis |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.2.0 -> v6.2.0 |
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
|
Supported Version Ranges |
| vap_all |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.2.7 |
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_4/vaps:name
more...
| Supported Version Ranges |
| vaps |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- region - Region name WTP is associated with. Source wireless-controller.region.name. type: str
more...
|
Supported Version Ranges |
| region |
v6.2.0 -> 7.6.6 |
- region_x - Relative horizontal region coordinate (between 0 and 1). type: str
more...
|
Supported Version Ranges |
| region_x |
v6.2.0 -> 7.6.6 |
- region_y - Relative vertical region coordinate (between 0 and 1). type: str
more...
|
Supported Version Ranges |
| region_y |
v6.2.0 -> 7.6.6 |
- split_tunneling_acl - Split tunneling ACL filter list. type: list member_path: split_tunneling_acl:id
more...
| Supported Version Ranges |
| split_tunneling_acl |
v6.0.0 -> 7.6.6 |
- dest_ip - Destination IP and mask for the split-tunneling subnet. type: str
more...
|
Supported Version Ranges |
| dest_ip |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- split_tunneling_acl_local_ap_subnet - Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| split_tunneling_acl_local_ap_subnet |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- split_tunneling_acl_path - Split tunneling ACL path is local/tunnel. type: str choices: tunnel, local
more...
|
Supported Version Ranges |
| split_tunneling_acl_path |
v6.0.0 -> 7.6.6 |
| [tunnel] |
v6.0.0 -> 7.6.6 |
| [local] |
v6.0.0 -> 7.6.6 |
- tun_mtu_downlink - The MTU of downlink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). type: int
more...
|
Supported Version Ranges |
| tun_mtu_downlink |
v6.0.0 -> 7.6.6 |
- tun_mtu_uplink - The maximum transmission unit (MTU) of uplink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). type: int
more...
|
Supported Version Ranges |
| tun_mtu_uplink |
v6.0.0 -> 7.6.6 |
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
more...
|
Supported Version Ranges |
| uuid |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- wan_port_mode - Enable/disable using the FortiAP WAN port as a LAN port. type: str choices: wan-lan, wan-only
more...
|
Supported Version Ranges |
| wan_port_mode |
v6.0.0 -> 7.6.6 |
| [wan-lan] |
v6.0.0 -> 7.6.6 |
| [wan-only] |
v6.0.0 -> 7.6.6 |
- wtp_id - WTP ID. type: str required: true
more...
|
Supported Version Ranges |
| wtp_id |
v6.0.0 -> 7.6.6 |
- wtp_mode - WTP, AP, or FortiAP operating mode; normal (by default) or remote. A tunnel mode SSID can be assigned to an AP in normal mode but not remote mode, while a local-bridge mode SSID can be assigned to an AP in either normal mode or remote mode. type: str choices: normal, remote
more...
|
Supported Version Ranges |
| wtp_mode |
v6.0.0 -> v6.2.7 |
| [normal] |
v6.0.0 -> v6.2.7 |
| [remote] |
v6.0.0 -> v6.2.7 |
- wtp_profile - WTP profile name to apply to this WTP, AP or FortiAP. Source wireless-controller.wtp-profile.name. type: str
more...
|
Supported Version Ranges |
| wtp_profile |
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 Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
fortinet.fortios.fortios_wireless_controller_wtp:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
wireless_controller_wtp:
admin: "discovered"
allowaccess: "https"
apcfg_profile: " (source wireless-controller.apcfg-profile.name)"
ble_major_id: "0"
ble_minor_id: "0"
bonjour_profile: " (source wireless-controller.bonjour-profile.name)"
comment: "Comment."
coordinate_enable: "enable"
coordinate_latitude: ""
coordinate_longitude: ""
coordinate_x: ""
coordinate_y: ""
default_mesh_root: "enable"
firmware_provision: ""
firmware_provision_latest: "disable"
image_download: "enable"
index: "0"
ip_fragment_preventing: "tcp-mss-adjust"
lan:
port_esl_mode: "offline"
port_esl_ssid: " (source system.interface.name)"
port_mode: "offline"
port_ssid: " (source system.interface.name)"
port1_mode: "offline"
port1_ssid: " (source system.interface.name)"
port2_mode: "offline"
port2_ssid: " (source system.interface.name)"
port3_mode: "offline"
port3_ssid: " (source system.interface.name)"
port4_mode: "offline"
port4_ssid: " (source system.interface.name)"
port5_mode: "offline"
port5_ssid: " (source system.interface.name)"
port6_mode: "offline"
port6_ssid: " (source system.interface.name)"
port7_mode: "offline"
port7_ssid: " (source system.interface.name)"
port8_mode: "offline"
port8_ssid: " (source system.interface.name)"
led_state: "enable"
location: ""
login_passwd: ""
login_passwd_change: "yes"
mesh_bridge_enable: "default"
name: "default_name_47"
override_allowaccess: "enable"
override_default_mesh_root: "enable"
override_ip_fragment: "enable"
override_lan: "enable"
override_led_state: "enable"
override_login_passwd_change: "enable"
override_split_tunnel: "enable"
override_wan_port_mode: "enable"
purdue_level: "1"
radio_1:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
band: "802.11a"
channel:
-
chan: ""
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
radio_id: "2"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_78 (source wireless-controller.vap-group.name system.interface.name)"
radio_2:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
band: "802.11a"
channel:
-
chan: ""
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
radio_id: "2"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_100 (source wireless-controller.vap-group.name system.interface.name)"
radio_3:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
band: "802.11a"
channel:
-
chan: ""
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
radio_id: "2"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_122 (source wireless-controller.vap-group.name system.interface.name)"
radio_4:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
band: "802.11a"
channel:
-
chan: ""
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_143 (source wireless-controller.vap-group.name system.interface.name)"
region: " (source wireless-controller.region.name)"
region_x: ""
region_y: ""
split_tunneling_acl:
-
dest_ip: ""
id: "149"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
tun_mtu_downlink: "0"
tun_mtu_uplink: "0"
uuid: ""
wan_port_mode: "wan-lan"
wtp_id: ""
wtp_mode: "normal"
wtp_profile: " (source wireless-controller.wtp-profile.name)"
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.