fortinet.fortimanager.fmgr_wtpprofile module – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
Note
This module is part of the fortinet.fortimanager collection (version 2.3.0).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
the parameter (adom) in requested url |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
|
the top level parameters set |
|
no description Choices:
|
|
Control management access to the managed WTP, FortiAP, or AP. Choices:
|
|
Country in which this WTP, FortiAP or AP will operate Choices:
|
|
Enable/disable AP handoff of clients to other APs Choices:
|
|
AP local configuration profile name. |
|
Bluetooth Low Energy profile name. |
|
Comment. |
|
Enable/disable FortiAP console login access Choices:
|
|
Enable/disable CAPWAP control message data channel offload. Choices:
|
|
Deny-Mac-List. |
|
ID. |
|
A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. |
|
Enable/disable data channel DTLS in kernel. Choices:
|
|
WTP data channel DTLS policy Choices:
|
|
Enable/disable use of energy efficient Ethernet on WTP. Choices:
|
|
no description |
|
ESL SES-imagotag APC address type Choices:
|
|
FQDN of ESL SES-imagotag Access Point Controller |
|
IP address of ESL SES-imagotag Access Point Controller |
|
Port of ESL SES-imagotag Access Point Controller |
|
ESL SES-imagotag dongle coexistence level Choices:
|
|
Compliance levels for the ESL solution integration Choices:
|
|
ESL SES-imagotag dongle channel Choices:
|
|
ESL SES-imagotag dongle output power Choices:
|
|
Enable/disable ESL SES-imagotag Serial Communication Daemon Choices:
|
|
Enable/disable TLS certificate verification Choices:
|
|
Enable/disable TLS certificate verification Choices:
|
|
Enable/disable station/VAP/radio extension information. Choices:
|
|
Enable/disable frequency handoff of clients to other channels Choices:
|
|
Enable/disable client load balancing during roaming to avoid roaming delay Choices:
|
|
Minimum received signal strength indicator |
|
Threshold value for AP handoff. |
|
Set to allow indoor/outdoor-only channels under regulatory rules Choices:
|
|
Method Choices:
|
|
no description |
|
ESL port mode. Choices:
|
|
Bridge ESL port to SSID. |
|
LAN port mode. Choices:
|
|
Bridge LAN port to SSID. |
|
LAN port 1 mode. Choices:
|
|
Bridge LAN port 1 to SSID. |
|
LAN port 2 mode. Choices:
|
|
Bridge LAN port 2 to SSID. |
|
LAN port 3 mode. Choices:
|
|
Bridge LAN port 3 to SSID. |
|
LAN port 4 mode. Choices:
|
|
Bridge LAN port 4 to SSID. |
|
LAN port 5 mode. Choices:
|
|
Bridge LAN port 5 to SSID. |
|
LAN port 6 mode. Choices:
|
|
Bridge LAN port 6 to SSID. |
|
LAN port 7 mode. Choices:
|
|
Bridge LAN port 7 to SSID. |
|
LAN port 8 mode. Choices:
|
|
Bridge LAN port 8 to SSID. |
|
no description |
|
Enable/disable AeroScout Real Time Location Service Choices:
|
|
Use BSSID or board MAC address as AP MAC address in AeroScout AP messages Choices:
|
|
Enable/disable compounded AeroScout tag and MU report Choices:
|
|
Enable/disable AeroScout Mobile Unit Choices:
|
|
AeroScout MU mode dilution factor |
|
AeroScout MU mode timeout |
|
IP address of AeroScout server. |
|
AeroScout server UDP listening port. |
|
Enable/disable Ekahau blink mode Choices:
|
|
WiFi frame MAC address or WiFi Tag. |
|
IP address of Ekahau RTLS Controller |
|
Ekahau RTLS Controller |
|
Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this WiF… Choices:
|
|
Enable/disable FortiPresence finding and reporting BLE devices. Choices:
|
|
FortiPresence report transmit frequency |
|
FortiPresence server UDP listening port |
|
FortiPresence project name |
|
Enable/disable FortiPresence finding and reporting rogue APs. Choices:
|
|
(list) FortiPresence secret password |
|
FortiPresence server IP address. |
|
FortiPresence server address type Choices:
|
|
FQDN of FortiPresence server. |
|
Enable/disable FortiPresence finding and reporting unassociated stations. Choices:
|
|
Enable/disable PoleStar BLE NAO Track Real Time Location Service Choices:
|
|
Time that measurements should be accumulated in seconds |
|
Tags and asset addrgrp list to be reported. |
|
Tags and asset UUID list 1 to be reported |
|
Tags and asset UUID list 2 to be reported |
|
Tags and asset UUID list 3 to be reported |
|
Tags and asset UUID list 4 to be reported |
|
Select the protocol to report Measurements, Advertising Data, or Location Data to NAO Cloud. Choices:
|
|
Time between reporting accumulated measurements in seconds |
|
FQDN of PoleStar Nao Track Server |
|
Path of PoleStar Nao Track Server |
|
Port of PoleStar Nao Track Server |
|
Access Token of PoleStar Nao Track Server. |
|
Enable/disable client station locating services for all clients, whether associated or not Choices:
|
|
(list or str) Recurring firewall schedules for illuminating LEDs on the FortiAP. |
|
Enable/disable use of LEDs on WTP Choices:
|
|
Enable/disable Link Layer Discovery Protocol Choices:
|
|
(list) Set the managed WTP, FortiAP, or APs administrator password. |
|
Change or reset the administrator password of a managed WTP, FortiAP or AP Choices:
|
|
Maximum number of stations |
|
WTP |
|
no description |
|
_Local_Platform_Str. |
|
Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat mana… Choices:
|
|
Configure operation mode of 5G radios Choices:
|
|
WTP, FortiAP or AP platform type. Choices:
|
|
Set the WTP, FortiAP, or APs PoE mode. Choices:
|
|
no description |
|
Enable/disable 802. Choices:
|
|
Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable AP handoff of clients to other APs Choices:
|
|
MAC address to monitor. |
|
Sniffer buffer size |
|
Channel on which to operate the sniffer |
|
Enable/disable sniffer on WiFi control frame Choices:
|
|
Enable/disable sniffer on WiFi data frame Choices:
|
|
Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Enable/disable sniffer on WiFi management other frames Choices:
|
|
Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Distributed Automatic Radio Resource Provisioning |
|
The upper bound of automatic transmit power adjustment in dBm |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm |
|
The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 1 operates on. Choices:
|
|
WiFi 5G band type. Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum bandwidth capacity allowed |
|
Beacon interval. |
|
BSS color value for this 11ax radio |
|
BSS color mode for this 11ax radio Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Channel bandwidth Choices:
|
|
Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Maximum packet size that can be sent without fragmentation |
|
Enable/disable frequency handoff of clients to other channels Choices:
|
|
Iperf test protocol Choices:
|
|
Iperf service port number. |
|
Maximum number of stations |
|
Maximum expected distance between the AP and clients |
|
Configure radio MIMO mode Choices:
|
|
Mode of radio 1. Choices:
|
|
Optional antenna used on FAP Choices:
|
|
Radio power level as a percentage of the maximum transmit power |
|
Set radio effective isotropic radiated power Choices:
|
|
Radio EIRP power in dBm |
|
Enable client power-saving features such as TIM, AC VO, and OBSS etc. Choices:
|
|
Enable/disable 802. Choices:
|
|
Radio-Id. |
|
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS |
|
BSSID for WiFi network. |
|
Enable/disable Captive Portal Authentication Choices:
|
|
Failure identification on the page after an incorrect login. |
|
Identification string from the captive portal login form. |
|
(list) no description |
|
Success identification on the page after a successful login. |
|
Website the client is trying to access. |
|
Username for captive portal authentication. |
|
(list) Passphrase for WiFi network connection. |
|
SAM report interval |
|
Select WiFi network security type Choices:
|
|
SAM test server IP address or domain name. |
|
SAM test server domain name. |
|
SAM test server IP address. |
|
Select SAM server type Choices:
|
|
SSID for WiFi network. |
|
Select SAM test type Choices:
|
|
Username for WiFi network connection. |
|
Use either the short guard interval Choices:
|
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Wireless Intrusion Detection System |
|
Enable/disable zero wait DFS on radio Choices:
|
|
no description |
|
Enable/disable 802. Choices:
|
|
Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable AP handoff of clients to other APs Choices:
|
|
MAC address to monitor. |
|
Sniffer buffer size |
|
Channel on which to operate the sniffer |
|
Enable/disable sniffer on WiFi control frame Choices:
|
|
Enable/disable sniffer on WiFi data frame Choices:
|
|
Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Enable/disable sniffer on WiFi management other frames Choices:
|
|
Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Distributed Automatic Radio Resource Provisioning |
|
The upper bound of automatic transmit power adjustment in dBm |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm |
|
The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 2 operates on. Choices:
|
|
WiFi 5G band type. Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum bandwidth capacity allowed |
|
Beacon interval. |
|
BSS color value for this 11ax radio |
|
BSS color mode for this 11ax radio Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Channel bandwidth Choices:
|
|
Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Maximum packet size that can be sent without fragmentation |
|
Enable/disable frequency handoff of clients to other channels Choices:
|
|
Iperf test protocol Choices:
|
|
Iperf service port number. |
|
Maximum number of stations |
|
Maximum expected distance between the AP and clients |
|
Configure radio MIMO mode Choices:
|
|
Mode of radio 2. Choices:
|
|
Optional antenna used on FAP Choices:
|
|
Radio power level as a percentage of the maximum transmit power |
|
Set radio effective isotropic radiated power Choices:
|
|
Radio EIRP power in dBm |
|
Enable client power-saving features such as TIM, AC VO, and OBSS etc. Choices:
|
|
Enable/disable 802. Choices:
|
|
Radio-Id. |
|
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS |
|
BSSID for WiFi network. |
|
Enable/disable Captive Portal Authentication Choices:
|
|
Failure identification on the page after an incorrect login. |
|
Identification string from the captive portal login form. |
|
(list) no description |
|
Success identification on the page after a successful login. |
|
Website the client is trying to access. |
|
Username for captive portal authentication. |
|
(list) Passphrase for WiFi network connection. |
|
SAM report interval |
|
Select WiFi network security type Choices:
|
|
SAM test server IP address or domain name. |
|
SAM test server domain name. |
|
SAM test server IP address. |
|
Select SAM server type Choices:
|
|
SSID for WiFi network. |
|
Select SAM test type Choices:
|
|
Username for WiFi network connection. |
|
Use either the short guard interval Choices:
|
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Wireless Intrusion Detection System |
|
Enable/disable zero wait DFS on radio Choices:
|
|
no description |
|
Enable/disable 802. Choices:
|
|
Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable AP handoff of clients to other APs Choices:
|
|
MAC address to monitor. |
|
Sniffer buffer size |
|
Channel on which to operate the sniffer |
|
Enable/disable sniffer on WiFi control frame Choices:
|
|
Enable/disable sniffer on WiFi data frame Choices:
|
|
Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Enable/disable sniffer on WiFi management other frames Choices:
|
|
Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Distributed Automatic Radio Resource Provisioning |
|
The upper bound of automatic transmit power adjustment in dBm |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm |
|
The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 3 operates on. Choices:
|
|
WiFi 5G band type. Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum bandwidth capacity allowed |
|
Beacon interval. |
|
BSS color value for this 11ax radio |
|
BSS color mode for this 11ax radio Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Channel bandwidth Choices:
|
|
Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Maximum packet size that can be sent without fragmentation |
|
Enable/disable frequency handoff of clients to other channels Choices:
|
|
Iperf test protocol Choices:
|
|
Iperf service port number. |
|
Maximum number of stations |
|
Maximum expected distance between the AP and clients |
|
Configure radio MIMO mode Choices:
|
|
Mode of radio 3. Choices:
|
|
Optional antenna used on FAP Choices:
|
|
Radio power level as a percentage of the maximum transmit power |
|
Set radio effective isotropic radiated power Choices:
|
|
Radio EIRP power in dBm |
|
Enable client power-saving features such as TIM, AC VO, and OBSS etc. Choices:
|
|
Enable/disable 802. Choices:
|
|
Radio-Id. |
|
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS |
|
BSSID for WiFi network. |
|
Enable/disable Captive Portal Authentication Choices:
|
|
Failure identification on the page after an incorrect login. |
|
Identification string from the captive portal login form. |
|
(list) no description |
|
Success identification on the page after a successful login. |
|
Website the client is trying to access. |
|
Username for captive portal authentication. |
|
(list) Passphrase for WiFi network connection. |
|
SAM report interval |
|
Select WiFi network security type Choices:
|
|
SAM test server IP address or domain name. |
|
SAM test server domain name. |
|
SAM test server IP address. |
|
Select SAM server type Choices:
|
|
SSID for WiFi network. |
|
Select SAM test type Choices:
|
|
Username for WiFi network connection. |
|
Use either the short guard interval Choices:
|
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Wireless Intrusion Detection System |
|
Enable/disable zero wait DFS on radio Choices:
|
|
no description |
|
Enable/disable 802. Choices:
|
|
Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable AP handoff of clients to other APs Choices:
|
|
MAC address to monitor. |
|
Sniffer buffer size |
|
Channel on which to operate the sniffer |
|
Enable/disable sniffer on WiFi control frame Choices:
|
|
Enable/disable sniffer on WiFi data frame Choices:
|
|
Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Enable/disable sniffer on WiFi management other frames Choices:
|
|
Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Distributed Automatic Radio Resource Provisioning |
|
The upper bound of automatic transmit power adjustment in dBm |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm |
|
The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 3 operates on. Choices:
|
|
WiFi 5G band type. Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum bandwidth capacity allowed |
|
Beacon interval. |
|
BSS color value for this 11ax radio |
|
BSS color mode for this 11ax radio Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Channel bandwidth Choices:
|
|
Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Maximum packet size that can be sent without fragmentation |
|
Enable/disable frequency handoff of clients to other channels Choices:
|
|
Iperf test protocol Choices:
|
|
Iperf service port number. |
|
Maximum number of stations |
|
Maximum expected distance between the AP and clients |
|
Configure radio MIMO mode Choices:
|
|
Mode of radio 3. Choices:
|
|
Optional antenna used on FAP Choices:
|
|
Radio power level as a percentage of the maximum transmit power |
|
Set radio effective isotropic radiated power Choices:
|
|
Radio EIRP power in dBm |
|
Enable client power-saving features such as TIM, AC VO, and OBSS etc. Choices:
|
|
Enable/disable 802. Choices:
|
|
Radio-Id. |
|
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS |
|
BSSID for WiFi network. |
|
Enable/disable Captive Portal Authentication Choices:
|
|
Failure identification on the page after an incorrect login. |
|
Identification string from the captive portal login form. |
|
(list) no description |
|
Success identification on the page after a successful login. |
|
Website the client is trying to access. |
|
Username for captive portal authentication. |
|
(list) Passphrase for WiFi network connection. |
|
SAM report interval |
|
Select WiFi network security type Choices:
|
|
SAM test server IP address or domain name. |
|
SAM test server domain name. |
|
SAM test server IP address. |
|
Select SAM server type Choices:
|
|
SSID for WiFi network. |
|
Select SAM test type Choices:
|
|
Username for WiFi network connection. |
|
Use either the short guard interval Choices:
|
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Wireless Intrusion Detection System |
|
Enable/disable zero wait DFS on radio Choices:
|
|
Enable/disable SNMP for the WTP, FortiAP, or AP Choices:
|
|
Split-Tunneling-Acl. |
|
Destination IP and mask for the split-tunneling subnet. |
|
ID. |
|
Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL Choices:
|
|
Split tunneling ACL path is local/tunnel. Choices:
|
|
System log server configuration profile name. |
|
Downlink CAPWAP tunnel MTU |
|
Uplink CAPWAP tunnel MTU |
|
Enable/disable UNII-4 5Ghz band channels Choices:
|
|
Set WAN port authentication mode Choices:
|
|
WAN port 802. Choices:
|
|
(list) no description |
|
Set WAN port 802. |
|
Enable/disable using a WAN port as a LAN port. Choices:
|
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fmgr_wtpprofile:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
wtpprofile:
allowaccess:
- https
- ssh
- snmp
- http
- telnet
ap-country: <value in [AL, DZ, AR, ...]>
ble-profile: <string>
comment: <string>
control-message-offload:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
- spectral-analysis
deny-mac-list:
-
id: <integer>
mac: <string>
dtls-in-kernel: <value in [disable, enable]>
dtls-policy:
- clear-text
- dtls-enabled
- ipsec-vpn
- ipsec-sn-vpn
energy-efficient-ethernet: <value in [disable, enable]>
ext-info-enable: <value in [disable, enable]>
handoff-roaming: <value in [disable, enable]>
handoff-rssi: <integer>
handoff-sta-thresh: <integer>
ip-fragment-preventing:
- tcp-mss-adjust
- icmp-unreachable
led-schedules: <list or string>
led-state: <value in [disable, enable]>
lldp: <value in [disable, enable]>
login-passwd: <list or string>
login-passwd-change: <value in [no, yes, default]>
max-clients: <integer>
name: <string>
poe-mode: <value in [auto, 8023af, 8023at, ...]>
split-tunneling-acl:
-
dest-ip: <string>
id: <integer>
split-tunneling-acl-local-ap-subnet: <value in [disable, enable]>
split-tunneling-acl-path: <value in [tunnel, local]>
tun-mtu-downlink: <integer>
tun-mtu-uplink: <integer>
wan-port-mode: <value in [wan-lan, wan-only]>
snmp: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
apcfg-profile: <string>
frequency-handoff: <value in [disable, enable]>
lan:
port-esl-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port-esl-ssid: <string>
port-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port-ssid: <string>
port1-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port1-ssid: <string>
port2-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port2-ssid: <string>
port3-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port3-ssid: <string>
port4-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port4-ssid: <string>
port5-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port5-ssid: <string>
port6-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port6-ssid: <string>
port7-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port7-ssid: <string>
port8-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port8-ssid: <string>
lbs:
aeroscout: <value in [disable, enable]>
aeroscout-ap-mac: <value in [bssid, board-mac]>
aeroscout-mmu-report: <value in [disable, enable]>
aeroscout-mu: <value in [disable, enable]>
aeroscout-mu-factor: <integer>
aeroscout-mu-timeout: <integer>
aeroscout-server-ip: <string>
aeroscout-server-port: <integer>
ekahau-blink-mode: <value in [disable, enable]>
ekahau-tag: <string>
erc-server-ip: <string>
erc-server-port: <integer>
fortipresence: <value in [disable, enable, enable2, ...]>
fortipresence-ble: <value in [disable, enable]>
fortipresence-frequency: <integer>
fortipresence-port: <integer>
fortipresence-project: <string>
fortipresence-rogue: <value in [disable, enable]>
fortipresence-secret: <list or string>
fortipresence-server: <string>
fortipresence-unassoc: <value in [disable, enable]>
station-locate: <value in [disable, enable]>
fortipresence-server-addr-type: <value in [fqdn, ipv4]>
fortipresence-server-fqdn: <string>
polestar: <value in [disable, enable]>
polestar-accumulation-interval: <integer>
polestar-asset-addrgrp-list: <string>
polestar-asset-uuid-list1: <string>
polestar-asset-uuid-list2: <string>
polestar-asset-uuid-list3: <string>
polestar-asset-uuid-list4: <string>
polestar-protocol: <value in [WSS]>
polestar-reporting-interval: <integer>
polestar-server-fqdn: <string>
polestar-server-path: <string>
polestar-server-port: <integer>
polestar-server-token: <string>
platform:
ddscan: <value in [disable, enable]>
mode: <value in [dual-5G, single-5G]>
type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
_local_platform_str: <string>
radio-1:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <string>
ap-sniffer-bufsize: <integer>
ap-sniffer-chan: <integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <integer>
auto-power-target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <integer>
beacon-interval: <integer>
bss-color: <integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <integer>
channel: <list or string>
channel-bonding: <value in [disable, enable, 80MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag-threshold: <integer>
max-clients: <integer>
max-distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <integer>
rts-threshold: <integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids-profile: <string>
zero-wait-dfs: <value in [disable, enable]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <integer>
power-mode: <value in [dBm, percentage]>
power-value: <integer>
sam-bssid: <string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <list or string>
sam-report-intv: <integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <string>
sam-ssid: <string>
sam-test: <value in [ping, iperf]>
sam-username: <string>
arrp-profile: <string>
bss-color-mode: <value in [auto, static]>
sam-cwp-failure-string: <string>
sam-cwp-match-string: <string>
sam-cwp-password: <list or string>
sam-cwp-success-string: <string>
sam-cwp-test-url: <string>
sam-cwp-username: <string>
sam-server-fqdn: <string>
sam-server-ip: <string>
sam-server-type: <value in [ip, fqdn]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo-mode: <value in [default, 1x1, 2x2, ...]>
radio-2:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <string>
ap-sniffer-bufsize: <integer>
ap-sniffer-chan: <integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <integer>
auto-power-target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <integer>
beacon-interval: <integer>
bss-color: <integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <integer>
channel: <list or string>
channel-bonding: <value in [disable, enable, 80MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag-threshold: <integer>
max-clients: <integer>
max-distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <integer>
rts-threshold: <integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids-profile: <string>
zero-wait-dfs: <value in [disable, enable]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <integer>
power-mode: <value in [dBm, percentage]>
power-value: <integer>
sam-bssid: <string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <list or string>
sam-report-intv: <integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <string>
sam-ssid: <string>
sam-test: <value in [ping, iperf]>
sam-username: <string>
arrp-profile: <string>
bss-color-mode: <value in [auto, static]>
sam-cwp-failure-string: <string>
sam-cwp-match-string: <string>
sam-cwp-password: <list or string>
sam-cwp-success-string: <string>
sam-cwp-test-url: <string>
sam-cwp-username: <string>
sam-server-fqdn: <string>
sam-server-ip: <string>
sam-server-type: <value in [ip, fqdn]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo-mode: <value in [default, 1x1, 2x2, ...]>
radio-3:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <string>
ap-sniffer-bufsize: <integer>
ap-sniffer-chan: <integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <integer>
auto-power-target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <integer>
beacon-interval: <integer>
bss-color: <integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <integer>
channel: <list or string>
channel-bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag-threshold: <integer>
max-clients: <integer>
max-distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <integer>
rts-threshold: <integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids-profile: <string>
zero-wait-dfs: <value in [disable, enable]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <integer>
power-mode: <value in [dBm, percentage]>
power-value: <integer>
sam-bssid: <string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <list or string>
sam-report-intv: <integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <string>
sam-ssid: <string>
sam-test: <value in [ping, iperf]>
sam-username: <string>
arrp-profile: <string>
bss-color-mode: <value in [auto, static]>
sam-cwp-failure-string: <string>
sam-cwp-match-string: <string>
sam-cwp-password: <list or string>
sam-cwp-success-string: <string>
sam-cwp-test-url: <string>
sam-cwp-username: <string>
sam-server-fqdn: <string>
sam-server-ip: <string>
sam-server-type: <value in [ip, fqdn]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo-mode: <value in [default, 1x1, 2x2, ...]>
radio-4:
airtime-fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap-sniffer-addr: <string>
ap-sniffer-bufsize: <integer>
ap-sniffer-chan: <integer>
ap-sniffer-ctl: <value in [disable, enable]>
ap-sniffer-data: <value in [disable, enable]>
ap-sniffer-mgmt-beacon: <value in [disable, enable]>
ap-sniffer-mgmt-other: <value in [disable, enable]>
ap-sniffer-mgmt-probe: <value in [disable, enable]>
auto-power-high: <integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <integer>
auto-power-target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <integer>
beacon-interval: <integer>
bss-color: <integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <integer>
channel: <list or string>
channel-bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag-threshold: <integer>
max-clients: <integer>
max-distance: <integer>
mode: <value in [ap, monitor, sniffer, ...]>
power-level: <integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <integer>
rts-threshold: <integer>
short-guard-interval: <value in [disable, enable]>
spectrum-analysis: <value in [disable, enable, scan-only]>
transmit-optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap-all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids-profile: <string>
zero-wait-dfs: <value in [disable, enable]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <integer>
power-mode: <value in [dBm, percentage]>
power-value: <integer>
sam-bssid: <string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <list or string>
sam-report-intv: <integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <string>
sam-ssid: <string>
sam-test: <value in [ping, iperf]>
sam-username: <string>
arrp-profile: <string>
bss-color-mode: <value in [auto, static]>
sam-cwp-failure-string: <string>
sam-cwp-match-string: <string>
sam-cwp-password: <list or string>
sam-cwp-success-string: <string>
sam-cwp-test-url: <string>
sam-cwp-username: <string>
sam-server-fqdn: <string>
sam-server-ip: <string>
sam-server-type: <value in [ip, fqdn]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo-mode: <value in [default, 1x1, 2x2, ...]>
console-login: <value in [disable, enable]>
esl-ses-dongle:
apc-addr-type: <value in [fqdn, ip]>
apc-fqdn: <string>
apc-ip: <string>
apc-port: <integer>
coex-level: <value in [none]>
compliance-level: <value in [compliance-level-2]>
esl-channel: <value in [0, 1, 2, ...]>
output-power: <value in [a, b, c, ...]>
scd-enable: <value in [disable, enable]>
tls-cert-verification: <value in [disable, enable]>
tls-fqdn-verification: <value in [disable, enable]>
indoor-outdoor-deployment: <value in [platform-determined, outdoor, indoor]>
syslog-profile: <string>
wan-port-auth: <value in [none, 802.1x]>
wan-port-auth-methods: <value in [all, EAP-FAST, EAP-TLS, ...]>
wan-port-auth-password: <list or string>
wan-port-auth-usrname: <string>
_is_factory_setting: <value in [disable, enable, ext]>
unii-4-5ghz-band: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |