fmgr_wtpprofile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.¶

New in version 2.0.0.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.x and v7.x.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiManager Version Compatibility ¶

`6.0.0`
True
`6.2.0`	`6.2.1`	`6.2.2`	`6.2.3`	`6.2.5`	`6.2.6`	`6.2.7`	`6.2.8`	`6.2.9`	`6.2.10`
True	True	True	True	True	True	True	True	True	True
`6.4.0`	`6.4.1`	`6.4.2`	`6.4.3`	`6.4.4`	`6.4.5`	`6.4.6`	`6.4.7`	`6.4.8`	`6.4.9`	`6.4.10`	`6.4.11`
True	True	True	True	True	True	True	True	True	True	True	True
`7.0.0`	`7.0.1`	`7.0.2`	`7.0.3`	`7.0.4`	`7.0.5`	`7.0.6`	`7.0.7`
True	True	True	True	True	True	True	True
`7.2.0`	`7.2.1`	`7.2.2`
True	True	True
`7.4.0`
True

Parameters ¶

access_token -The token to access FortiManager without using username and password. type: str required: false
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
enable_log - Enable/Disable logging for task. type: bool required: false default: False
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
state - The directive to create, update or delete an object type: str required: true choices: present, absent
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
adom - The parameter in requested url type: str required: true
wtpprofile - Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. type: dict

allowaccess - Control management access to the managed WTP, FortiAP, or AP. type: array choices: [https, ssh, snmp, http, telnet] more...

ap-country - Country in which this WTP, FortiAP or AP will operate (default = NA, automatically use the country configured for the current VDOM). type: str choices: [AL, DZ, AR, AM, AU, AT, AZ, BH, BD, BY, BE, BZ, BO, BA, BR, BN, BG, CA, CL, CN, CO, CR, HR, CY, CZ, DK, DO, EC, EG, SV, EE, FI, FR, GE, DE, GR, GT, HN, HK, HU, IS, IN, ID, IR, IE, IL, IT, JM, JP, JO, KZ, KE, KP, KR, KW, LV, LB, LI, LT, LU, MO, MK, MY, MT, MX, MC, MA, NP, NL, AN, NZ, NO, OM, PK, PA, PG, PE, PH, PL, PT, PR, QA, RO, RU, SA, SG, SK, SI, ZA, ES, LK, SE, CH, SY, TW, TH, TT, TN, TR, AE, UA, GB, US, PS, UY, UZ, VE, VN, YE, ZW, NA, KH, TZ, SD, AO, RW, MZ, RS, ME, BB, GD, GL, GU, PY, HT, AW, MM, ZB, CF, BS, VC, MV, SN, CI, GH, MW, UG, BF, KY, TC, TM, VU, FM, GY, KN, LC, CX, AF, CM, ML, BJ, MG, TD, BW, LY, LS, MU, SL, NE, TG, RE, MD, BM, VI, PM, MF, IM, FO, GI, LA, WF, MH, BT, PF, NI, GF, AS, MP, PW, GP, ET, SR, DM, MQ, YT, BL, ZM, CG, CD, MR, IQ, FJ, --, MN] more...

ble-profile - Bluetooth Low Energy profile name. type: str more...

comment - Comment. type: str more...

control-message-offload - Enable/disable CAPWAP control message data channel offload. type: array choices: [ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu, sta-health, spectral-analysis] more...

deny-mac-list - Deny-Mac-List. type: array more...

id - ID. type: int more...

mac - A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. type: str more...

dtls-in-kernel - Enable/disable data channel DTLS in kernel. type: str choices: [disable, enable] more...

dtls-policy - WTP data channel DTLS policy (default = clear-text). type: array choices: [clear-text, dtls-enabled, ipsec-vpn, ipsec-sn-vpn] more...

energy-efficient-ethernet - Enable/disable use of energy efficient Ethernet on WTP. type: str choices: [disable, enable] more...

ext-info-enable - Enable/disable station/VAP/radio extension information. type: str choices: [disable, enable] more...

handoff-roaming - Enable/disable client load balancing during roaming to avoid roaming delay (default = disable). type: str choices: [disable, enable] more...

handoff-rssi - Minimum received signal strength indicator (RSSI) value for handoff (20 - 30, default = 25). type: int more...

handoff-sta-thresh - Threshold value for AP handoff. type: int more...

ip-fragment-preventing - Method(s) by which IP fragmentation is prevented for control and data packets through CAPWAP tunnel (default = tcp-mss-adjust). type: array choices: [tcp-mss-adjust, icmp-unreachable] more...

led-schedules - Recurring firewall schedules for illuminating LEDs on the FortiAP. type: str more...

led-state - Enable/disable use of LEDs on WTP (default = disable). type: str choices: [disable, enable] more...

lldp - Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP (default = disable). type: str choices: [disable, enable] more...

login-passwd - Set the managed WTP, FortiAP, or APs administrator password. type: str more...

login-passwd-change - Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no, default = no). type: str choices: [no, yes, default] more...

max-clients - Maximum number of stations (STAs) supported by the WTP (default = 0, meaning no client limitation). type: int more...

name - WTP (or FortiAP or AP) profile name. type: str more...

poe-mode - Set the WTP, FortiAP, or APs PoE mode. type: str choices: [auto, 8023af, 8023at, power-adapter, full, high, low] more...

split-tunneling-acl - Split-Tunneling-Acl. type: array more...

dest-ip - Destination IP and mask for the split-tunneling subnet. type: str more...

id - ID. type: int more...

split-tunneling-acl-local-ap-subnet - Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL (default = disable). type: str choices: [disable, enable] more...

split-tunneling-acl-path - Split tunneling ACL path is local/tunnel. type: str choices: [tunnel, local] more...

tun-mtu-downlink - Downlink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). type: int more...

tun-mtu-uplink - Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0). type: int more...

wan-port-mode - Enable/disable using a WAN port as a LAN port. type: str choices: [wan-lan, wan-only] more...

snmp - Enable/disable SNMP for the WTP, FortiAP, or AP (default = disable). type: str choices: [disable, enable] more...

ap-handoff - Enable/disable AP handoff of clients to other APs (default = disable). type: str choices: [disable, enable] more...

apcfg-profile - AP local configuration profile name. type: str more...

frequency-handoff - Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...

lan type: dict

port-esl-mode - ESL port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port-esl-ssid - Bridge ESL port to SSID. type: str more...

port-mode - LAN port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port-ssid - Bridge LAN port to SSID. type: str more...

port1-mode - LAN port 1 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port1-ssid - Bridge LAN port 1 to SSID. type: str more...

port2-mode - LAN port 2 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port2-ssid - Bridge LAN port 2 to SSID. type: str more...

port3-mode - LAN port 3 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port3-ssid - Bridge LAN port 3 to SSID. type: str more...

port4-mode - LAN port 4 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port4-ssid - Bridge LAN port 4 to SSID. type: str more...

port5-mode - LAN port 5 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port5-ssid - Bridge LAN port 5 to SSID. type: str more...

port6-mode - LAN port 6 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port6-ssid - Bridge LAN port 6 to SSID. type: str more...

port7-mode - LAN port 7 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port7-ssid - Bridge LAN port 7 to SSID. type: str more...

port8-mode - LAN port 8 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...

port8-ssid - Bridge LAN port 8 to SSID. type: str more...

lbs type: dict

aeroscout - Enable/disable AeroScout Real Time Location Service (RTLS) support (default = disable). type: str choices: [disable, enable] more...

aeroscout-ap-mac - Use BSSID or board MAC address as AP MAC address in AeroScout AP messages (default = bssid). type: str choices: [bssid, board-mac] more...

aeroscout-mmu-report - Enable/disable compounded AeroScout tag and MU report (default = enable). type: str choices: [disable, enable] more...

aeroscout-mu - Enable/disable AeroScout Mobile Unit (MU) support (default = disable). type: str choices: [disable, enable] more...

aeroscout-mu-factor - AeroScout MU mode dilution factor (default = 20). type: int more...

aeroscout-mu-timeout - AeroScout MU mode timeout (0 - 65535 sec, default = 5). type: int more...

aeroscout-server-ip - IP address of AeroScout server. type: str more...

aeroscout-server-port - AeroScout server UDP listening port. type: int more...

ekahau-blink-mode - Enable/disable Ekahau blink mode (now known as AiRISTA Flow) to track and locate WiFi tags (default = disable). type: str choices: [disable, enable] more...

ekahau-tag - WiFi frame MAC address or WiFi Tag. type: str more...

erc-server-ip - IP address of Ekahau RTLS Controller (ERC). type: str more...

erc-server-port - Ekahau RTLS Controller (ERC) UDP listening port. type: int more...

fortipresence - Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this WiFi network (default = disable). type: str choices: [disable, enable, enable2, foreign, both] more...

fortipresence-ble - Enable/disable FortiPresence finding and reporting BLE devices. type: str choices: [disable, enable] more...

fortipresence-frequency - FortiPresence report transmit frequency (5 - 65535 sec, default = 30). type: int more...

fortipresence-port - FortiPresence server UDP listening port (default = 3000). type: int more...

fortipresence-project - FortiPresence project name (max. type: str more...

fortipresence-rogue - Enable/disable FortiPresence finding and reporting rogue APs. type: str choices: [disable, enable] more...

fortipresence-secret - FortiPresence secret password (max. type: str more...

fortipresence-server - FortiPresence server IP address. type: str more...

fortipresence-unassoc - Enable/disable FortiPresence finding and reporting unassociated stations. type: str choices: [disable, enable] more...

station-locate - Enable/disable client station locating services for all clients, whether associated or not (default = disable). type: str choices: [disable, enable] more...

fortipresence-server-addr-type - FortiPresence server address type (default = ipv4). type: str choices: [fqdn, ipv4] more...

fortipresence-server-fqdn - FQDN of FortiPresence server. type: str more...

platform type: dict

ddscan - Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat management. type: str choices: [disable, enable] more...

mode - Configure operation mode of 5G radios (default = single-5G). type: str choices: [dual-5G, single-5G] more...

type - WTP, FortiAP or AP platform type. type: str choices: [30B-50B, 60B, 80CM-81CM, 220A, 220B, 210B, 60C, 222B, 112B, 320B, 11C, 14C, 223B, 28C, 320C, 221C, 25D, 222C, 224D, 214B, 21D, 24D, 112D, 223C, 321C, C220C, C225C, S321C, S323C, FWF, S311C, S313C, AP-11N, S322C, S321CR, S322CR, S323CR, S421E, S422E, S423E, 421E, 423E, C221E, C226E, C23JD, C24JE, C21D, U421E, U423E, 221E, 222E, 223E, S221E, S223E, U221EV, U223EV, U321EV, U323EV, 224E, U422EV, U24JEV, 321E, U431F, U433F, 231E, 431F, 433F, 231F, 432F, 234F, 23JF, U231F, 831F, U234F, U432F, 431FL, 432FR, 433FL, 231FL, 231G, 233G, 431G, 433G, U231G, U441G, 234G] more...

_local_platform_str - _Local_Platform_Str. type: str more...

radio-1 type: dict

airtime-fairness - Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...

amsdu - Enable/disable 802. type: str choices: [disable, enable] more...

ap-sniffer-addr - MAC address to monitor. type: str more...

ap-sniffer-bufsize - Sniffer buffer size (1 - 32 MB, default = 16). type: int more...

ap-sniffer-chan - Channel on which to operate the sniffer (default = 6). type: int more...

ap-sniffer-ctl - Enable/disable sniffer on WiFi control frame (default = enable). type: str choices: [disable, enable] more...

ap-sniffer-data - Enable/disable sniffer on WiFi data frame (default = enable). type: str choices: [disable, enable] more...

ap-sniffer-mgmt-beacon - Enable/disable sniffer on WiFi management Beacon frames (default = enable). type: str choices: [disable, enable] more...

ap-sniffer-mgmt-other - Enable/disable sniffer on WiFi management other frames (default = enable). type: str choices: [disable, enable] more...

ap-sniffer-mgmt-probe - Enable/disable sniffer on WiFi management probe frames (default = enable). type: str choices: [disable, enable] more...

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...

auto-power-level - Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...

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...

auto-power-target - The target of automatic transmit power adjustment in dBm. type: str more...

band - WiFi band that Radio 1 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only, 802.11ax-5G-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-6G] more...

band-5g-type - WiFi 5G band type. type: str choices: [5g-full, 5g-high, 5g-low] more...

bandwidth-admission-control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. type: str choices: [disable, enable] more...

bandwidth-capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). type: int more...

beacon-interval - Beacon interval. type: int more...

bss-color - BSS color value for this 11ax radio (0 - 63, 0 means disable. type: int more...

call-admission-control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. type: str choices: [disable, enable] more...

call-capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). type: int more...

channel - Selected list of wireless radio channels. type: str more...

channel-bonding - Channel bandwidth: 160,80, 40, or 20MHz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz, 160MHz] more...

channel-utilization - Enable/disable measuring channel utilization. type: str choices: [disable, enable] more...

coexistence - Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). type: str choices: [disable, enable] more...

darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel (default = disable). type: str choices: [disable, enable] more...

drma - Enable/disable dynamic radio mode assignment (DRMA) (default = disable). type: str choices: [disable, enable] more...

drma-sensitivity - Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). type: str choices: [low, medium, high] more...

dtim - Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). type: int more...

frag-threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...

max-clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. type: int more...

max-distance - Maximum expected distance between the AP and clients (0 - 54000 m, default = 0). type: int more...

mode - Mode of radio 1. type: str choices: [disabled, ap, monitor, sniffer, sam] more...

power-level - Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int more...

powersave-optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: array choices: [tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow] more...

protection-mode - Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...

radio-id - Radio-Id. type: int more...

rts-threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes, default = 2346). type: int more...

short-guard-interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: [disable, enable] more...

spectrum-analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...

transmit-optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. type: array choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...

vap-all - Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs). type: str choices: [disable, enable, tunnel, bridge, manual] more...

vap1 - Virtual Access Point (VAP) for wlan ID 1 type: str more...

vap2 - Virtual Access Point (VAP) for wlan ID 2 type: str more...

vap3 - Virtual Access Point (VAP) for wlan ID 3 type: str more...

vap4 - Virtual Access Point (VAP) for wlan ID 4 type: str more...

vap5 - Virtual Access Point (VAP) for wlan ID 5 type: str more...

vap6 - Virtual Access Point (VAP) for wlan ID 6 type: str more...

vap7 - Virtual Access Point (VAP) for wlan ID 7 type: str more...

vap8 - Virtual Access Point (VAP) for wlan ID 8 type: str more...

vaps - Manually selected list of Virtual Access Points (VAPs). type: str more...

wids-profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. type: str more...

zero-wait-dfs - Enable/disable zero wait DFS on radio (default = enable). type: str choices: [disable, enable] more...

ap-handoff - Enable/disable AP handoff of clients to other APs (default = disable). type: str choices: [disable, enable] more...

frequency-handoff - Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...

iperf-protocol - Iperf test protocol (default = UDP). type: str choices: [udp, tcp] more...

iperf-server-port - Iperf service port number. type: int more...

power-mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentage). type: str choices: [dBm, percentage] more...

power-value - Radio EIRP power in dBm (1 - 33, default = 27). type: int more...

sam-bssid - BSSID for WiFi network. type: str more...

sam-captive-portal - Enable/disable Captive Portal Authentication (default = disable). type: str choices: [disable, enable] more...

sam-password - Passphrase for WiFi network connection. type: str more...

sam-report-intv - SAM report interval (sec), 0 for a one-time report. type: int more...

sam-security-type - Select WiFi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise] more...

sam-server - SAM test server IP address or domain name. type: str more...

sam-ssid - SSID for WiFi network. type: str more...

sam-test - Select SAM test type (default = PING). type: str choices: [ping, iperf] more...

sam-username - Username for WiFi network connection. type: str more...

arrp-profile - Distributed Automatic Radio Resource Provisioning (DARRP) profile name to assign to the radio. type: str more...

bss-color-mode - BSS color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...

sam-cwp-failure-string - Failure identification on the page after an incorrect login. type: str more...

sam-cwp-match-string - Identification string from the captive portal login form. type: str more...

sam-cwp-password - No description for the parameter type: str more...

sam-cwp-success-string - Success identification on the page after a successful login. type: str more...

sam-cwp-test-url - Website the client is trying to access. type: str more...

sam-cwp-username - Username for captive portal authentication. type: str more...

sam-server-fqdn - SAM test server domain name. type: str more...

sam-server-ip - SAM test server IP address. type: str more...

sam-server-type - Select SAM server type (default = IP). type: str choices: [ip, fqdn] more...

80211d - Enable/disable 802. type: str choices: [disable, enable] more...

optional-antenna - Optional antenna used on FAP (default = none). type: str choices: [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R] more...

radio-2 type: dict