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

New in version 2.10.

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.

Requirements ¶

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

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`6.0.0`	`6.2.1`	`6.2.3`	`6.2.5`	`6.4.0`	`6.4.2`	`6.4.5`	`7.0.0`	`7.2.0`
wtpprofile	yes	yes	yes	yes	yes	yes	yes	yes	yes

Parameters ¶

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
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
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
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
adom - The parameter in requested url type: str required: true
wtpprofile - no description type: dict

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

allowaccess True True True True True True True True True
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, --] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ble-profile True True True True True True True True True
comment - Comment. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

control-message-offload True True True True True True True True True
deny-mac-list - Deny-Mac-List. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

deny-mac-list True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- mac - A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  mac True True True True True True True True True
dtls-in-kernel - Enable/disable data channel DTLS in kernel. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

handoff-sta-thresh True True True True True True True True True
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...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

login-passwd True True True True True True True True True
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...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

split-tunneling-acl True True True True True True True True True
- dest-ip - Destination IP and mask for the split-tunneling subnet. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  dest-ip True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
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...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

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

6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

frequency-handoff True True True True True
lan type: dict

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

port8-ssid True True True

lbs type: dict

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

aeroscout-server-port True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

erc-server-port True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

7.2.0

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

7.2.0

fortipresence-server-fqdn True

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

mode True True True
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] more...

6.4.5 7.0.0 7.2.0

type True True True
_local_platform_str - _Local_Platform_Str. type: str more...

7.0.0 7.2.0

_local_platform_str True True

radio-1 type: dict

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

ap-sniffer-mgmt-probe True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-target True True True
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] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bandwidth-capacity True True True
beacon-interval - Beacon interval. type: int more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bss-color True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

protection-mode True True True
radio-id - Radio-Id. type: int more...

6.4.5 7.0.0 7.2.0

radio-id True True True
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...

6.4.5 7.0.0 7.2.0

rts-threshold True True True
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...

6.4.5 7.0.0 7.2.0

short-guard-interval True True True
spectrum-analysis - Spectrum-Analysis. type: str choices: [disable, enable, scan-only] more...

6.4.5 7.0.0 7.2.0

spectrum-analysis True False False
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

iperf-server-port True True
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...

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

sam-server-type True

radio-2 type: dict

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

ap-sniffer-mgmt-probe True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-target True True True
band - WiFi band that Radio 2 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] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bandwidth-capacity True True True
beacon-interval - Beacon interval. type: int more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bss-color True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

max-distance True True True
mode - Mode of radio 2. type: str choices: [disabled, ap, monitor, sniffer, sam] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

protection-mode True True True
radio-id - Radio-Id. type: int more...

6.4.5 7.0.0 7.2.0

radio-id True True True
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...

6.4.5 7.0.0 7.2.0

rts-threshold True True True
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...

6.4.5 7.0.0 7.2.0

short-guard-interval True True True
spectrum-analysis - Spectrum-Analysis. type: str choices: [disable, enable, scan-only] more...

6.4.5 7.0.0 7.2.0

spectrum-analysis True False False
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

iperf-server-port True True
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...

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

sam-server-type True

radio-3 type: dict

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

ap-sniffer-mgmt-probe True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-target True True True
band - WiFi band that Radio 3 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] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bandwidth-capacity True True True
beacon-interval - Beacon interval. type: int more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bss-color True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

max-distance True True True
mode - Mode of radio 3. type: str choices: [disabled, ap, monitor, sniffer, sam] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

protection-mode True True True
radio-id - Radio-Id. type: int more...

6.4.5 7.0.0 7.2.0

radio-id True True True
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...

6.4.5 7.0.0 7.2.0

rts-threshold True True True
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...

6.4.5 7.0.0 7.2.0

short-guard-interval True True True
spectrum-analysis - Spectrum-Analysis. type: str choices: [disable, enable, scan-only] more...

6.4.5 7.0.0 7.2.0

spectrum-analysis True False False
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

iperf-server-port True True
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...

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

sam-server-type True

radio-4 type: dict

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

ap-sniffer-mgmt-probe True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

auto-power-target True True True
band - WiFi band that Radio 3 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] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bandwidth-capacity True True True
beacon-interval - Beacon interval. type: int more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

bss-color True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

max-distance True True True
mode - Mode of radio 3. type: str choices: [ap, monitor, sniffer, disabled, sam] more...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

power-level True True True
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

protection-mode True True True
radio-id - Radio-Id. type: int more...

6.4.5 7.0.0 7.2.0

radio-id True True True
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...

6.4.5 7.0.0 7.2.0

rts-threshold True True True
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...

6.4.5 7.0.0 7.2.0

short-guard-interval True True True
spectrum-analysis - Spectrum-Analysis. type: str choices: [disable, enable, scan-only] more...

6.4.5 7.0.0 7.2.0

spectrum-analysis True False False
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...

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

6.4.5 7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

iperf-server-port True True
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...

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.0.0 7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

sam-server-type True

console-login - Enable/disable FortiAP console login access (default = enable). type: str choices: [disable, enable] more...

7.2.0

console-login True
esl-ses-dongle type: dict

apc-addr-type - ESL SES-imagotag APC address type (default = fqdn). type: str choices: [fqdn, ip] more...

7.2.0

apc-addr-type True
apc-fqdn - FQDN of ESL SES-imagotag Access Point Controller (APC). type: str more...

7.2.0

apc-fqdn True
apc-ip - IP address of ESL SES-imagotag Access Point Controller (APC). type: str more...

7.2.0

apc-ip True
apc-port - Port of ESL SES-imagotag Access Point Controller (APC). type: int more...

7.2.0

apc-port True
coex-level - ESL SES-imagotag dongle coexistence level (default = none). type: str choices: [none] more...

7.2.0

coex-level True
compliance-level - Compliance levels for the ESL solution integration (default = compliance-level-2). type: str choices: [compliance-level-2] more...

7.2.0

compliance-level True
esl-channel - ESL SES-imagotag dongle channel (default = 127). type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 127, -1] more...

7.2.0

esl-channel True
output-power - ESL SES-imagotag dongle output power (default = A). type: str choices: [a, b, c, d, e, f, g, h] more...

7.2.0

output-power True
scd-enable - Enable/disable ESL SES-imagotag Serial Communication Daemon (SCD) (default = disable). type: str choices: [disable, enable] more...

7.2.0

scd-enable True
tls-cert-verification - Enable/disable TLS certificate verification (default = enable). type: str choices: [disable, enable] more...

7.2.0

tls-cert-verification True
tls-fqdn-verification - Enable/disable TLS certificate verification (default = disable). type: str choices: [disable, enable] more...

7.2.0

tls-fqdn-verification True

indoor-outdoor-deployment - Set to allow indoor/outdoor-only channels under regulatory rules (default = platform-determined). type: str choices: [platform-determined, outdoor, indoor] more...

7.2.0

indoor-outdoor-deployment True
syslog-profile - System log server configuration profile name. type: str more...

7.2.0

syslog-profile True
wan-port-auth - Set WAN port authentication mode (default = none). type: str choices: [none, 802.1x] more...

7.2.0

wan-port-auth True
wan-port-auth-methods - WAN port 802. type: str choices: [all, EAP-FAST, EAP-TLS, EAP-PEAP] more...

7.2.0

wan-port-auth-methods True
wan-port-auth-password - No description for the parameter type: str more...

7.2.0

wan-port-auth-password True
wan-port-auth-usrname - Set WAN port 802. type: str more...

7.2.0

wan-port-auth-usrname True

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: no description
     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: <value of string>
           comment: <value of 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: <value of integer>
                 mac: <value of string>
           dtls-in-kernel: <value in [disable, enable]>
           dtls-policy:
             - clear-text
             - dtls-enabled
             - ipsec-vpn
           energy-efficient-ethernet: <value in [disable, enable]>
           ext-info-enable: <value in [disable, enable]>
           handoff-roaming: <value in [disable, enable]>
           handoff-rssi: <value of integer>
           handoff-sta-thresh: <value of integer>
           ip-fragment-preventing:
             - tcp-mss-adjust
             - icmp-unreachable
           led-schedules: <value of string>
           led-state: <value in [disable, enable]>
           lldp: <value in [disable, enable]>
           login-passwd: <value of string>
           login-passwd-change: <value in [no, yes, default]>
           max-clients: <value of integer>
           name: <value of string>
           poe-mode: <value in [auto, 8023af, 8023at, ...]>
           split-tunneling-acl:
             -
                 dest-ip: <value of string>
                 id: <value of integer>
           split-tunneling-acl-local-ap-subnet: <value in [disable, enable]>
           split-tunneling-acl-path: <value in [tunnel, local]>
           tun-mtu-downlink: <value of integer>
           tun-mtu-uplink: <value of integer>
           wan-port-mode: <value in [wan-lan, wan-only]>
           snmp: <value in [disable, enable]>
           ap-handoff: <value in [disable, enable]>
           apcfg-profile: <value of string>
           frequency-handoff: <value in [disable, enable]>
           lan:
              port-esl-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port-esl-ssid: <value of string>
              port-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port-ssid: <value of string>
              port1-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port1-ssid: <value of string>
              port2-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port2-ssid: <value of string>
              port3-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port3-ssid: <value of string>
              port4-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port4-ssid: <value of string>
              port5-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port5-ssid: <value of string>
              port6-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port6-ssid: <value of string>
              port7-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port7-ssid: <value of string>
              port8-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
              port8-ssid: <value of 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: <value of integer>
              aeroscout-mu-timeout: <value of integer>
              aeroscout-server-ip: <value of string>
              aeroscout-server-port: <value of integer>
              ekahau-blink-mode: <value in [disable, enable]>
              ekahau-tag: <value of string>
              erc-server-ip: <value of string>
              erc-server-port: <value of integer>
              fortipresence: <value in [disable, enable, enable2, ...]>
              fortipresence-ble: <value in [disable, enable]>
              fortipresence-frequency: <value of integer>
              fortipresence-port: <value of integer>
              fortipresence-project: <value of string>
              fortipresence-rogue: <value in [disable, enable]>
              fortipresence-secret: <value of string>
              fortipresence-server: <value of string>
              fortipresence-unassoc: <value in [disable, enable]>
              station-locate: <value in [disable, enable]>
              fortipresence-server-addr-type: <value in [fqdn, ipv4]>
              fortipresence-server-fqdn: <value of 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: <value of string>
           radio-1:
              airtime-fairness: <value in [disable, enable]>
              amsdu: <value in [disable, enable]>
              ap-sniffer-addr: <value of string>
              ap-sniffer-bufsize: <value of integer>
              ap-sniffer-chan: <value of 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: <value of integer>
              auto-power-level: <value in [disable, enable]>
              auto-power-low: <value of integer>
              auto-power-target: <value of 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: <value of integer>
              beacon-interval: <value of integer>
              bss-color: <value of integer>
              call-admission-control: <value in [disable, enable]>
              call-capacity: <value of integer>
              channel: <value of 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: <value of integer>
              frag-threshold: <value of integer>
              max-clients: <value of integer>
              max-distance: <value of integer>
              mode: <value in [disabled, ap, monitor, ...]>
              power-level: <value of integer>
              powersave-optimize:
                - tim
                - ac-vo
                - no-obss-scan
                - no-11b-rate
                - client-rate-follow
              protection-mode: <value in [rtscts, ctsonly, disable]>
              radio-id: <value of integer>
              rts-threshold: <value of 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: <value of string>
              vap2: <value of string>
              vap3: <value of string>
              vap4: <value of string>
              vap5: <value of string>
              vap6: <value of string>
              vap7: <value of string>
              vap8: <value of string>
              vaps: <value of string>
              wids-profile: <value of string>
              zero-wait-dfs: <value in [disable, enable]>
              iperf-protocol: <value in [udp, tcp]>
              iperf-server-port: <value of integer>
              power-mode: <value in [dBm, percentage]>
              power-value: <value of integer>
              sam-bssid: <value of string>
              sam-captive-portal: <value in [disable, enable]>
              sam-password: <value of string>
              sam-report-intv: <value of integer>
              sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
              sam-server: <value of string>
              sam-ssid: <value of string>
              sam-test: <value in [ping, iperf]>
              sam-username: <value of string>
              arrp-profile: <value of string>
              bss-color-mode: <value in [auto, static]>
              sam-cwp-failure-string: <value of string>
              sam-cwp-match-string: <value of string>
              sam-cwp-password: <value of string>
              sam-cwp-success-string: <value of string>
              sam-cwp-test-url: <value of string>
              sam-cwp-username: <value of string>
              sam-server-fqdn: <value of string>
              sam-server-ip: <value of string>
              sam-server-type: <value in [ip, fqdn]>
           radio-2:
              airtime-fairness: <value in [disable, enable]>
              amsdu: <value in [disable, enable]>
              ap-sniffer-addr: <value of string>
              ap-sniffer-bufsize: <value of integer>
              ap-sniffer-chan: <value of 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: <value of integer>
              auto-power-level: <value in [disable, enable]>
              auto-power-low: <value of integer>
              auto-power-target: <value of 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: <value of integer>
              beacon-interval: <value of integer>
              bss-color: <value of integer>
              call-admission-control: <value in [disable, enable]>
              call-capacity: <value of integer>
              channel: <value of 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: <value of integer>
              frag-threshold: <value of integer>
              max-clients: <value of integer>
              max-distance: <value of integer>
              mode: <value in [disabled, ap, monitor, ...]>
              power-level: <value of integer>
              powersave-optimize:
                - tim
                - ac-vo
                - no-obss-scan
                - no-11b-rate
                - client-rate-follow
              protection-mode: <value in [rtscts, ctsonly, disable]>
              radio-id: <value of integer>
              rts-threshold: <value of 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: <value of string>
              vap2: <value of string>
              vap3: <value of string>
              vap4: <value of string>
              vap5: <value of string>
              vap6: <value of string>
              vap7: <value of string>
              vap8: <value of string>
              vaps: <value of string>
              wids-profile: <value of string>
              zero-wait-dfs: <value in [disable, enable]>
              iperf-protocol: <value in [udp, tcp]>
              iperf-server-port: <value of integer>
              power-mode: <value in [dBm, percentage]>
              power-value: <value of integer>
              sam-bssid: <value of string>
              sam-captive-portal: <value in [disable, enable]>
              sam-password: <value of string>
              sam-report-intv: <value of integer>
              sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
              sam-server: <value of string>
              sam-ssid: <value of string>
              sam-test: <value in [ping, iperf]>
              sam-username: <value of string>
              arrp-profile: <value of string>
              bss-color-mode: <value in [auto, static]>
              sam-cwp-failure-string: <value of string>
              sam-cwp-match-string: <value of string>
              sam-cwp-password: <value of string>
              sam-cwp-success-string: <value of string>
              sam-cwp-test-url: <value of string>
              sam-cwp-username: <value of string>
              sam-server-fqdn: <value of string>
              sam-server-ip: <value of string>
              sam-server-type: <value in [ip, fqdn]>
           radio-3:
              airtime-fairness: <value in [disable, enable]>
              amsdu: <value in [disable, enable]>
              ap-sniffer-addr: <value of string>
              ap-sniffer-bufsize: <value of integer>
              ap-sniffer-chan: <value of 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: <value of integer>
              auto-power-level: <value in [disable, enable]>
              auto-power-low: <value of integer>
              auto-power-target: <value of 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: <value of integer>
              beacon-interval: <value of integer>
              bss-color: <value of integer>
              call-admission-control: <value in [disable, enable]>
              call-capacity: <value of integer>
              channel: <value of 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: <value of integer>
              frag-threshold: <value of integer>
              max-clients: <value of integer>
              max-distance: <value of integer>
              mode: <value in [disabled, ap, monitor, ...]>
              power-level: <value of integer>
              powersave-optimize:
                - tim
                - ac-vo
                - no-obss-scan
                - no-11b-rate
                - client-rate-follow
              protection-mode: <value in [rtscts, ctsonly, disable]>
              radio-id: <value of integer>
              rts-threshold: <value of 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: <value of string>
              vap2: <value of string>
              vap3: <value of string>
              vap4: <value of string>
              vap5: <value of string>
              vap6: <value of string>
              vap7: <value of string>
              vap8: <value of string>
              vaps: <value of string>
              wids-profile: <value of string>
              zero-wait-dfs: <value in [disable, enable]>
              iperf-protocol: <value in [udp, tcp]>
              iperf-server-port: <value of integer>
              power-mode: <value in [dBm, percentage]>
              power-value: <value of integer>
              sam-bssid: <value of string>
              sam-captive-portal: <value in [disable, enable]>
              sam-password: <value of string>
              sam-report-intv: <value of integer>
              sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
              sam-server: <value of string>
              sam-ssid: <value of string>
              sam-test: <value in [ping, iperf]>
              sam-username: <value of string>
              arrp-profile: <value of string>
              bss-color-mode: <value in [auto, static]>
              sam-cwp-failure-string: <value of string>
              sam-cwp-match-string: <value of string>
              sam-cwp-password: <value of string>
              sam-cwp-success-string: <value of string>
              sam-cwp-test-url: <value of string>
              sam-cwp-username: <value of string>
              sam-server-fqdn: <value of string>
              sam-server-ip: <value of string>
              sam-server-type: <value in [ip, fqdn]>
           radio-4:
              airtime-fairness: <value in [disable, enable]>
              amsdu: <value in [disable, enable]>
              ap-sniffer-addr: <value of string>
              ap-sniffer-bufsize: <value of integer>
              ap-sniffer-chan: <value of 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: <value of integer>
              auto-power-level: <value in [disable, enable]>
              auto-power-low: <value of integer>
              auto-power-target: <value of 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: <value of integer>
              beacon-interval: <value of integer>
              bss-color: <value of integer>
              call-admission-control: <value in [disable, enable]>
              call-capacity: <value of integer>
              channel: <value of 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: <value of integer>
              frag-threshold: <value of integer>
              max-clients: <value of integer>
              max-distance: <value of integer>
              mode: <value in [ap, monitor, sniffer, ...]>
              power-level: <value of integer>
              powersave-optimize:
                - tim
                - ac-vo
                - no-obss-scan
                - no-11b-rate
                - client-rate-follow
              protection-mode: <value in [rtscts, ctsonly, disable]>
              radio-id: <value of integer>
              rts-threshold: <value of 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: <value of string>
              vap2: <value of string>
              vap3: <value of string>
              vap4: <value of string>
              vap5: <value of string>
              vap6: <value of string>
              vap7: <value of string>
              vap8: <value of string>
              vaps: <value of string>
              wids-profile: <value of string>
              zero-wait-dfs: <value in [disable, enable]>
              iperf-protocol: <value in [udp, tcp]>
              iperf-server-port: <value of integer>
              power-mode: <value in [dBm, percentage]>
              power-value: <value of integer>
              sam-bssid: <value of string>
              sam-captive-portal: <value in [disable, enable]>
              sam-password: <value of string>
              sam-report-intv: <value of integer>
              sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
              sam-server: <value of string>
              sam-ssid: <value of string>
              sam-test: <value in [ping, iperf]>
              sam-username: <value of string>
              arrp-profile: <value of string>
              bss-color-mode: <value in [auto, static]>
              sam-cwp-failure-string: <value of string>
              sam-cwp-match-string: <value of string>
              sam-cwp-password: <value of string>
              sam-cwp-success-string: <value of string>
              sam-cwp-test-url: <value of string>
              sam-cwp-username: <value of string>
              sam-server-fqdn: <value of string>
              sam-server-ip: <value of string>
              sam-server-type: <value in [ip, fqdn]>
           console-login: <value in [disable, enable]>
           esl-ses-dongle:
              apc-addr-type: <value in [fqdn, ip]>
              apc-fqdn: <value of string>
              apc-ip: <value of string>
              apc-port: <value of 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: <value of string>
           wan-port-auth: <value in [none, 802.1x]>
           wan-port-auth-methods: <value in [all, EAP-FAST, EAP-TLS, ...]>
           wan-port-auth-password: <value of string>
           wan-port-auth-usrname: <value of string>

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:

request_url - The full url requested returned: always type: str sample: /sys/login/user
response_code - The status of api request returned: always type: int sample: 0
response_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.