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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock
wtpprofile
dictionary
the top level parameters set
allowaccess
list / elements=string
    Choices:
  • https
  • ssh
  • snmp
  • http
  • telnet
no description
ap-country
string
    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
Country in which this WTP, FortiAP or AP will operate (default = NA, automatically use the country configured for the current ...
ap-handoff
string
    Choices:
  • disable
  • enable
Enable/disable AP handoff of clients to other APs (default = disable).
apcfg-profile
string
AP local configuration profile name.
ble-profile
string
Bluetooth Low Energy profile name.
comment
string
Comment.
control-message-offload
list / elements=string
    Choices:
  • ebp-frame
  • aeroscout-tag
  • ap-list
  • sta-list
  • sta-cap-list
  • stats
  • aeroscout-mu
  • sta-health
  • spectral-analysis
no description
deny-mac-list
list / elements=string
no description
id
integer
ID.
mac
string
A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP.
dtls-in-kernel
string
    Choices:
  • disable
  • enable
Enable/disable data channel DTLS in kernel.
dtls-policy
list / elements=string
    Choices:
  • clear-text
  • dtls-enabled
  • ipsec-vpn
no description
energy-efficient-ethernet
string
    Choices:
  • disable
  • enable
Enable/disable use of energy efficient Ethernet on WTP.
ext-info-enable
string
    Choices:
  • disable
  • enable
Enable/disable station/VAP/radio extension information.
frequency-handoff
string
    Choices:
  • disable
  • enable
Enable/disable frequency handoff of clients to other channels (default = disable).
handoff-roaming
string
    Choices:
  • disable
  • enable
Enable/disable client load balancing during roaming to avoid roaming delay (default = disable).
handoff-rssi
integer
Minimum received signal strength indicator (RSSI) value for handoff (20 - 30, default = 25).
handoff-sta-thresh
integer
Threshold value for AP handoff.
ip-fragment-preventing
list / elements=string
    Choices:
  • tcp-mss-adjust
  • icmp-unreachable
no description
lan
dictionary
no description
port-esl-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
ESL port mode.
port-esl-ssid
string
Bridge ESL port to SSID.
port-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port mode.
port-ssid
string
Bridge LAN port to SSID.
port1-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 1 mode.
port1-ssid
string
Bridge LAN port 1 to SSID.
port2-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 2 mode.
port2-ssid
string
Bridge LAN port 2 to SSID.
port3-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 3 mode.
port3-ssid
string
Bridge LAN port 3 to SSID.
port4-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 4 mode.
port4-ssid
string
Bridge LAN port 4 to SSID.
port5-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 5 mode.
port5-ssid
string
Bridge LAN port 5 to SSID.
port6-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 6 mode.
port6-ssid
string
Bridge LAN port 6 to SSID.
port7-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 7 mode.
port7-ssid
string
Bridge LAN port 7 to SSID.
port8-mode
string
    Choices:
  • offline
  • bridge-to-wan
  • bridge-to-ssid
  • nat-to-wan
LAN port 8 mode.
port8-ssid
string
Bridge LAN port 8 to SSID.
lbs
dictionary
no description
aeroscout
string
    Choices:
  • disable
  • enable
Enable/disable AeroScout Real Time Location Service (RTLS) support (default = disable).
aeroscout-ap-mac
string
    Choices:
  • bssid
  • board-mac
Use BSSID or board MAC address as AP MAC address in AeroScout AP messages (default = bssid).
aeroscout-mmu-report
string
    Choices:
  • disable
  • enable
Enable/disable compounded AeroScout tag and MU report (default = enable).
aeroscout-mu
string
    Choices:
  • disable
  • enable
Enable/disable AeroScout Mobile Unit (MU) support (default = disable).
aeroscout-mu-factor
integer
AeroScout MU mode dilution factor (default = 20).
aeroscout-mu-timeout
integer
AeroScout MU mode timeout (0 - 65535 sec, default = 5).
aeroscout-server-ip
string
IP address of AeroScout server.
aeroscout-server-port
integer
AeroScout server UDP listening port.
ekahau-blink-mode
string
    Choices:
  • disable
  • enable
Enable/disable Ekahau blink mode (now known as AiRISTA Flow) to track and locate WiFi tags (default = disable).
ekahau-tag
string
WiFi frame MAC address or WiFi Tag.
erc-server-ip
string
IP address of Ekahau RTLS Controller (ERC).
erc-server-port
integer
Ekahau RTLS Controller (ERC) UDP listening port.
fortipresence
string
    Choices:
  • disable
  • enable
  • enable2
  • foreign
  • both
Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this Wi...
fortipresence-ble
string
    Choices:
  • disable
  • enable
Enable/disable FortiPresence finding and reporting BLE devices.
fortipresence-frequency
integer
FortiPresence report transmit frequency (5 - 65535 sec, default = 30).
fortipresence-port
integer
FortiPresence server UDP listening port (default = 3000).
fortipresence-project
string
FortiPresence project name (max. 16 characters, default = fortipresence).
fortipresence-rogue
string
    Choices:
  • disable
  • enable
Enable/disable FortiPresence finding and reporting rogue APs.
fortipresence-secret
string
no description
fortipresence-server
string
FortiPresence server IP address.
fortipresence-unassoc
string
    Choices:
  • disable
  • enable
Enable/disable FortiPresence finding and reporting unassociated stations.
station-locate
string
    Choices:
  • disable
  • enable
Enable/disable client station locating services for all clients, whether associated or not (default = disable).
led-schedules
string
Recurring firewall schedules for illuminating LEDs on the FortiAP. If led-state is enabled, LEDs will be visible when at least...
led-state
string
    Choices:
  • disable
  • enable
Enable/disable use of LEDs on WTP (default = disable).
lldp
string
    Choices:
  • disable
  • enable
Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP (default = disable).
login-passwd
string
no description
login-passwd-change
string
    Choices:
  • no
  • yes
  • default
Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no, default = no).
max-clients
integer
Maximum number of stations (STAs) supported by the WTP (default = 0, meaning no client limitation).
name
string
WTP (or FortiAP or AP) profile name.
platform
dictionary
no description
_local_platform_str
string
no description
ddscan
string
    Choices:
  • disable
  • enable
Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat man...
mode
string
    Choices:
  • dual-5G
  • single-5G
Configure operation mode of 5G radios (default = single-5G).
type
string
    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
WTP, FortiAP or AP platform type. There are built-in WTP profiles for all supported FortiAP models. You can select a b...
poe-mode
string
    Choices:
  • auto
  • 8023af
  • 8023at
  • power-adapter
  • full
  • high
  • low
Set the WTP, FortiAP, or APs PoE mode.
radio-1
dictionary
no description
airtime-fairness
string
    Choices:
  • disable
  • enable
Enable/disable airtime fairness (default = disable).
amsdu
string
    Choices:
  • disable
  • enable
Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable).
ap-sniffer-addr
string
MAC address to monitor.
ap-sniffer-bufsize
integer
Sniffer buffer size (1 - 32 MB, default = 16).
ap-sniffer-chan
integer
Channel on which to operate the sniffer (default = 6).
ap-sniffer-ctl
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi control frame (default = enable).
ap-sniffer-data
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi data frame (default = enable).
ap-sniffer-mgmt-beacon
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management Beacon frames (default = enable).
ap-sniffer-mgmt-other
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management other frames (default = enable).
ap-sniffer-mgmt-probe
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management probe frames (default = enable).
auto-power-high
integer
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-level
string
    Choices:
  • disable
  • enable
Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable).
auto-power-low
integer
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-target
string
The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70).
band
string
    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
WiFi band that Radio 1 operates on.
band-5g-type
string
    Choices:
  • 5g-full
  • 5g-high
  • 5g-low
WiFi 5G band type.
bandwidth-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the...
bandwidth-capacity
integer
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
beacon-interval
integer
Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor...
bss-color
integer
BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0).
call-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca...
call-capacity
integer
Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10).
channel
string
no description
channel-bonding
string
    Choices:
  • disable
  • enable
  • 80MHz
  • 40MHz
  • 20MHz
  • 160MHz
Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.
channel-utilization
string
    Choices:
  • disable
  • enable
Enable/disable measuring channel utilization.
coexistence
string
    Choices:
  • disable
  • enable
Enable/disable allowing both HT20 and HT40 on the same radio (default = enable).
darrp
string
    Choices:
  • disable
  • enable
Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo...
drma
string
    Choices:
  • disable
  • enable
Enable/disable dynamic radio mode assignment (DRMA) (default = disable).
drma-sensitivity
string
    Choices:
  • low
  • medium
  • high
Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low).
dtim
integer
Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i...
frag-threshold
integer
Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346).
iperf-protocol
string
    Choices:
  • udp
  • tcp
Iperf test protocol (default = "UDP").
iperf-server-port
integer
Iperf service port number.
max-clients
integer
Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.
max-distance
integer
Maximum expected distance between the AP and clients (0 - 54000 m, default = 0).
mode
string
    Choices:
  • disabled
  • ap
  • monitor
  • sniffer
  • sam
Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.
power-level
integer
Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100).
power-mode
string
    Choices:
  • dBm
  • percentage
Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag...
power-value
integer
Radio EIRP power in dBm (1 - 33, default = 27).
powersave-optimize
list / elements=string
    Choices:
  • tim
  • ac-vo
  • no-obss-scan
  • no-11b-rate
  • client-rate-follow
no description
protection-mode
string
    Choices:
  • rtscts
  • ctsonly
  • disable
Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).
radio-id
integer
no description
rts-threshold
integer
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt...
sam-bssid
string
BSSID for WiFi network.
sam-captive-portal
string
    Choices:
  • disable
  • enable
Enable/disable Captive Portal Authentication (default = disable).
sam-password
string
no description
sam-report-intv
integer
SAM report interval (sec), 0 for a one-time report.
sam-security-type
string
    Choices:
  • open
  • wpa-personal
  • wpa-enterprise
Select WiFi network security type (default = "wpa-personal").
sam-server
string
SAM test server IP address or domain name.
sam-ssid
string
SSID for WiFi network.
sam-test
string
    Choices:
  • ping
  • iperf
Select SAM test type (default = "PING").
sam-username
string
Username for WiFi network connection.
short-guard-interval
string
    Choices:
  • disable
  • enable
Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.
spectrum-analysis
string
    Choices:
  • disable
  • enable
  • scan-only
no description
transmit-optimize
list / elements=string
    Choices:
  • disable
  • power-save
  • aggr-limit
  • retry-limit
  • send-bar
no description
vap-all
string
    Choices:
  • disable
  • enable
  • tunnel
  • bridge
  • manual
Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs).
vap1
string
Virtual Access Point (VAP) for wlan ID 1
vap2
string
Virtual Access Point (VAP) for wlan ID 2
vap3
string
Virtual Access Point (VAP) for wlan ID 3
vap4
string
Virtual Access Point (VAP) for wlan ID 4
vap5
string
Virtual Access Point (VAP) for wlan ID 5
vap6
string
Virtual Access Point (VAP) for wlan ID 6
vap7
string
Virtual Access Point (VAP) for wlan ID 7
vap8
string
Virtual Access Point (VAP) for wlan ID 8
vaps
string
Manually selected list of Virtual Access Points (VAPs).
wids-profile
string
Wireless Intrusion Detection System (WIDS) profile name to assign to the radio.
zero-wait-dfs
string
    Choices:
  • disable
  • enable
Enable/disable zero wait DFS on radio (default = enable).
radio-2
dictionary
no description
airtime-fairness
string
    Choices:
  • disable
  • enable
Enable/disable airtime fairness (default = disable).
amsdu
string
    Choices:
  • disable
  • enable
Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable).
ap-sniffer-addr
string
MAC address to monitor.
ap-sniffer-bufsize
integer
Sniffer buffer size (1 - 32 MB, default = 16).
ap-sniffer-chan
integer
Channel on which to operate the sniffer (default = 6).
ap-sniffer-ctl
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi control frame (default = enable).
ap-sniffer-data
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi data frame (default = enable).
ap-sniffer-mgmt-beacon
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management Beacon frames (default = enable).
ap-sniffer-mgmt-other
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management other frames (default = enable).
ap-sniffer-mgmt-probe
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management probe frames (default = enable).
auto-power-high
integer
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-level
string
    Choices:
  • disable
  • enable
Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable).
auto-power-low
integer
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-target
string
The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70).
band
string
    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
WiFi band that Radio 2 operates on.
band-5g-type
string
    Choices:
  • 5g-full
  • 5g-high
  • 5g-low
WiFi 5G band type.
bandwidth-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the...
bandwidth-capacity
integer
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
beacon-interval
integer
Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor...
bss-color
integer
BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0).
call-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca...
call-capacity
integer
Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10).
channel
string
no description
channel-bonding
string
    Choices:
  • disable
  • enable
  • 80MHz
  • 40MHz
  • 20MHz
  • 160MHz
Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.
channel-utilization
string
    Choices:
  • disable
  • enable
Enable/disable measuring channel utilization.
coexistence
string
    Choices:
  • disable
  • enable
Enable/disable allowing both HT20 and HT40 on the same radio (default = enable).
darrp
string
    Choices:
  • disable
  • enable
Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo...
drma
string
    Choices:
  • disable
  • enable
Enable/disable dynamic radio mode assignment (DRMA) (default = disable).
drma-sensitivity
string
    Choices:
  • low
  • medium
  • high
Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low).
dtim
integer
Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i...
frag-threshold
integer
Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346).
iperf-protocol
string
    Choices:
  • udp
  • tcp
Iperf test protocol (default = "UDP").
iperf-server-port
integer
Iperf service port number.
max-clients
integer
Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.
max-distance
integer
Maximum expected distance between the AP and clients (0 - 54000 m, default = 0).
mode
string
    Choices:
  • disabled
  • ap
  • monitor
  • sniffer
  • sam
Mode of radio 2. Radio 2 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.
power-level
integer
Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100).
power-mode
string
    Choices:
  • dBm
  • percentage
Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag...
power-value
integer
Radio EIRP power in dBm (1 - 33, default = 27).
powersave-optimize
list / elements=string
    Choices:
  • tim
  • ac-vo
  • no-obss-scan
  • no-11b-rate
  • client-rate-follow
no description
protection-mode
string
    Choices:
  • rtscts
  • ctsonly
  • disable
Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).
radio-id
integer
no description
rts-threshold
integer
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt...
sam-bssid
string
BSSID for WiFi network.
sam-captive-portal
string
    Choices:
  • disable
  • enable
Enable/disable Captive Portal Authentication (default = disable).
sam-password
string
no description
sam-report-intv
integer
SAM report interval (sec), 0 for a one-time report.
sam-security-type
string
    Choices:
  • open
  • wpa-personal
  • wpa-enterprise
Select WiFi network security type (default = "wpa-personal").
sam-server
string
SAM test server IP address or domain name.
sam-ssid
string
SSID for WiFi network.
sam-test
string
    Choices:
  • ping
  • iperf
Select SAM test type (default = "PING").
sam-username
string
Username for WiFi network connection.
short-guard-interval
string
    Choices:
  • disable
  • enable
Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.
spectrum-analysis
string
    Choices:
  • disable
  • enable
  • scan-only
no description
transmit-optimize
list / elements=string
    Choices:
  • disable
  • power-save
  • aggr-limit
  • retry-limit
  • send-bar
no description
vap-all
string
    Choices:
  • disable
  • enable
  • tunnel
  • bridge
  • manual
Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs).
vap1
string
Virtual Access Point (VAP) for wlan ID 1
vap2
string
Virtual Access Point (VAP) for wlan ID 2
vap3
string
Virtual Access Point (VAP) for wlan ID 3
vap4
string
Virtual Access Point (VAP) for wlan ID 4
vap5
string
Virtual Access Point (VAP) for wlan ID 5
vap6
string
Virtual Access Point (VAP) for wlan ID 6
vap7
string
Virtual Access Point (VAP) for wlan ID 7
vap8
string
Virtual Access Point (VAP) for wlan ID 8
vaps
string
Manually selected list of Virtual Access Points (VAPs).
wids-profile
string
Wireless Intrusion Detection System (WIDS) profile name to assign to the radio.
zero-wait-dfs
string
    Choices:
  • disable
  • enable
Enable/disable zero wait DFS on radio (default = enable).
radio-3
dictionary
no description
airtime-fairness
string
    Choices:
  • disable
  • enable
Enable/disable airtime fairness (default = disable).
amsdu
string
    Choices:
  • disable
  • enable
Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable).
ap-sniffer-addr
string
MAC address to monitor.
ap-sniffer-bufsize
integer
Sniffer buffer size (1 - 32 MB, default = 16).
ap-sniffer-chan
integer
Channel on which to operate the sniffer (default = 6).
ap-sniffer-ctl
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi control frame (default = enable).
ap-sniffer-data
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi data frame (default = enable).
ap-sniffer-mgmt-beacon
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management Beacon frames (default = enable).
ap-sniffer-mgmt-other
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management other frames (default = enable).
ap-sniffer-mgmt-probe
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management probe frames (default = enable).
auto-power-high
integer
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-level
string
    Choices:
  • disable
  • enable
Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable).
auto-power-low
integer
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-target
string
The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70).
band
string
    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
WiFi band that Radio 3 operates on.
band-5g-type
string
    Choices:
  • 5g-full
  • 5g-high
  • 5g-low
WiFi 5G band type.
bandwidth-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the...
bandwidth-capacity
integer
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
beacon-interval
integer
Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor...
bss-color
integer
BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0).
call-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca...
call-capacity
integer
Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10).
channel
string
no description
channel-bonding
string
    Choices:
  • 80MHz
  • 40MHz
  • 20MHz
  • 160MHz
Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.
channel-utilization
string
    Choices:
  • disable
  • enable
Enable/disable measuring channel utilization.
coexistence
string
    Choices:
  • disable
  • enable
Enable/disable allowing both HT20 and HT40 on the same radio (default = enable).
darrp
string
    Choices:
  • disable
  • enable
Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo...
drma
string
    Choices:
  • disable
  • enable
Enable/disable dynamic radio mode assignment (DRMA) (default = disable).
drma-sensitivity
string
    Choices:
  • low
  • medium
  • high
Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low).
dtim
integer
Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i...
frag-threshold
integer
Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346).
iperf-protocol
string
    Choices:
  • udp
  • tcp
Iperf test protocol (default = "UDP").
iperf-server-port
integer
Iperf service port number.
max-clients
integer
Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.
max-distance
integer
Maximum expected distance between the AP and clients (0 - 54000 m, default = 0).
mode
string
    Choices:
  • disabled
  • ap
  • monitor
  • sniffer
  • sam
Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.
power-level
integer
Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100).
power-mode
string
    Choices:
  • dBm
  • percentage
Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag...
power-value
integer
Radio EIRP power in dBm (1 - 33, default = 27).
powersave-optimize
list / elements=string
    Choices:
  • tim
  • ac-vo
  • no-obss-scan
  • no-11b-rate
  • client-rate-follow
no description
protection-mode
string
    Choices:
  • rtscts
  • ctsonly
  • disable
Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).
radio-id
integer
no description
rts-threshold
integer
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt...
sam-bssid
string
BSSID for WiFi network.
sam-captive-portal
string
    Choices:
  • disable
  • enable
Enable/disable Captive Portal Authentication (default = disable).
sam-password
string
no description
sam-report-intv
integer
SAM report interval (sec), 0 for a one-time report.
sam-security-type
string
    Choices:
  • open
  • wpa-personal
  • wpa-enterprise
Select WiFi network security type (default = "wpa-personal").
sam-server
string
SAM test server IP address or domain name.
sam-ssid
string
SSID for WiFi network.
sam-test
string
    Choices:
  • ping
  • iperf
Select SAM test type (default = "PING").
sam-username
string
Username for WiFi network connection.
short-guard-interval
string
    Choices:
  • disable
  • enable
Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.
spectrum-analysis
string
    Choices:
  • disable
  • enable
  • scan-only
no description
transmit-optimize
list / elements=string
    Choices:
  • disable
  • power-save
  • aggr-limit
  • retry-limit
  • send-bar
no description
vap-all
string
    Choices:
  • disable
  • enable
  • tunnel
  • bridge
  • manual
Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs).
vap1
string
Virtual Access Point (VAP) for wlan ID 1
vap2
string
Virtual Access Point (VAP) for wlan ID 2
vap3
string
Virtual Access Point (VAP) for wlan ID 3
vap4
string
Virtual Access Point (VAP) for wlan ID 4
vap5
string
Virtual Access Point (VAP) for wlan ID 5
vap6
string
Virtual Access Point (VAP) for wlan ID 6
vap7
string
Virtual Access Point (VAP) for wlan ID 7
vap8
string
Virtual Access Point (VAP) for wlan ID 8
vaps
string
Manually selected list of Virtual Access Points (VAPs).
wids-profile
string
Wireless Intrusion Detection System (WIDS) profile name to assign to the radio.
zero-wait-dfs
string
    Choices:
  • disable
  • enable
Enable/disable zero wait DFS on radio (default = enable).
radio-4
dictionary
no description
airtime-fairness
string
    Choices:
  • disable
  • enable
Enable/disable airtime fairness (default = disable).
amsdu
string
    Choices:
  • disable
  • enable
Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable).
ap-sniffer-addr
string
MAC address to monitor.
ap-sniffer-bufsize
integer
Sniffer buffer size (1 - 32 MB, default = 16).
ap-sniffer-chan
integer
Channel on which to operate the sniffer (default = 6).
ap-sniffer-ctl
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi control frame (default = enable).
ap-sniffer-data
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi data frame (default = enable).
ap-sniffer-mgmt-beacon
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management Beacon frames (default = enable).
ap-sniffer-mgmt-other
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management other frames (default = enable).
ap-sniffer-mgmt-probe
string
    Choices:
  • disable
  • enable
Enable/disable sniffer on WiFi management probe frames (default = enable).
auto-power-high
integer
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-level
string
    Choices:
  • disable
  • enable
Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable).
auto-power-low
integer
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP pl...
auto-power-target
string
The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70).
band
string
    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
WiFi band that Radio 3 operates on.
band-5g-type
string
    Choices:
  • 5g-full
  • 5g-high
  • 5g-low
WiFi 5G band type.
bandwidth-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the...
bandwidth-capacity
integer
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000).
beacon-interval
integer
Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platfor...
bss-color
integer
BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0).
call-admission-control
string
    Choices:
  • disable
  • enable
Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP ca...
call-capacity
integer
Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10).
channel
string
no description
channel-bonding
string
    Choices:
  • 80MHz
  • 40MHz
  • 20MHz
  • 160MHz
Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.
channel-utilization
string
    Choices:
  • disable
  • enable
Enable/disable measuring channel utilization.
coexistence
string
    Choices:
  • disable
  • enable
Enable/disable allowing both HT20 and HT40 on the same radio (default = enable).
darrp
string
    Choices:
  • disable
  • enable
Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the mo...
drma
string
    Choices:
  • disable
  • enable
Enable/disable dynamic radio mode assignment (DRMA) (default = disable).
drma-sensitivity
string
    Choices:
  • low
  • medium
  • high
Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low).
dtim
integer
Delivery Traffic Indication Map (DTIM) period (1 - 255, default = 1). Set higher to save battery life of WiFi client i...
frag-threshold
integer
Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346).
iperf-protocol
string
    Choices:
  • udp
  • tcp
Iperf test protocol (default = "UDP").
iperf-server-port
integer
Iperf service port number.
max-clients
integer
Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.
max-distance
integer
Maximum expected distance between the AP and clients (0 - 54000 m, default = 0).
mode
string
    Choices:
  • ap
  • monitor
  • sniffer
  • disabled
  • sam
Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.
power-level
integer
Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100).
power-mode
string
    Choices:
  • dBm
  • percentage
Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentag...
power-value
integer
Radio EIRP power in dBm (1 - 33, default = 27).
powersave-optimize
list / elements=string
    Choices:
  • tim
  • ac-vo
  • no-obss-scan
  • no-11b-rate
  • client-rate-follow
no description
protection-mode
string
    Choices:
  • rtscts
  • ctsonly
  • disable
Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).
radio-id
integer
no description
rts-threshold
integer
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 byt...
sam-bssid
string
BSSID for WiFi network.
sam-captive-portal
string
    Choices:
  • disable
  • enable
Enable/disable Captive Portal Authentication (default = disable).
sam-password
string
no description
sam-report-intv
integer
SAM report interval (sec), 0 for a one-time report.
sam-security-type
string
    Choices:
  • open
  • wpa-personal
  • wpa-enterprise
Select WiFi network security type (default = "wpa-personal").
sam-server
string
SAM test server IP address or domain name.
sam-ssid
string
SSID for WiFi network.
sam-test
string
    Choices:
  • ping
  • iperf
Select SAM test type (default = "PING").
sam-username
string
Username for WiFi network connection.
short-guard-interval
string
    Choices:
  • disable
  • enable
Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.
spectrum-analysis
string
    Choices:
  • disable
  • enable
  • scan-only
no description
transmit-optimize
list / elements=string
    Choices:
  • disable
  • power-save
  • aggr-limit
  • retry-limit
  • send-bar
no description
vap-all
string
    Choices:
  • disable
  • enable
  • tunnel
  • bridge
  • manual
Configure method for assigning SSIDs to this FortiAP (default = automatically assign tunnel SSIDs).
vap1
string
Virtual Access Point (VAP) for wlan ID 1
vap2
string
Virtual Access Point (VAP) for wlan ID 2
vap3
string
Virtual Access Point (VAP) for wlan ID 3
vap4
string
Virtual Access Point (VAP) for wlan ID 4
vap5
string
Virtual Access Point (VAP) for wlan ID 5
vap6
string
Virtual Access Point (VAP) for wlan ID 6
vap7
string
Virtual Access Point (VAP) for wlan ID 7
vap8
string
Virtual Access Point (VAP) for wlan ID 8
vaps
string
Manually selected list of Virtual Access Points (VAPs).
wids-profile
string
Wireless Intrusion Detection System (WIDS) profile name to assign to the radio.
zero-wait-dfs
string
    Choices:
  • disable
  • enable
Enable/disable zero wait DFS on radio (default = enable).
snmp
string
    Choices:
  • disable
  • enable
Enable/disable SNMP for the WTP, FortiAP, or AP (default = disable).
split-tunneling-acl
list / elements=string
no description
dest-ip
string
Destination IP and mask for the split-tunneling subnet.
id
integer
ID.
split-tunneling-acl-local-ap-subnet
string
    Choices:
  • disable
  • enable
Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL (default = disable).
split-tunneling-acl-path
string
    Choices:
  • tunnel
  • local
Split tunneling ACL path is local/tunnel.
tun-mtu-downlink
integer
Downlink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0).
tun-mtu-uplink
integer
Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes, default = 0).
wan-port-mode
string
    Choices:
  • wan-lan
  • wan-only
Enable/disable using a WAN port as a LAN port.

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
     fmgr_wtpprofile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        wtpprofile:
           allowaccess:
             - https
             - ssh
             - snmp
             - http
             - telnet
           ap-country: <value in [AL, DZ, AR, ...]>
           ble-profile: <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]>
           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>
           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>
           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>
           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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)