Try SpotterConfigure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
| "added in version" 2.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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
- ipsec-sn-vpn
energy-efficient-ethernet: <value in [disable, enable]>
ext-info-enable: <value in [disable, enable]>
handoff-roaming: <value in [disable, enable]>
handoff-rssi: <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]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <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]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
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]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <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]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
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]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <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]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
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]>
frequency-handoff: <value in [disable, enable]>
ap-handoff: <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]>
80211d: <value in [disable, enable]>
optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
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>
_is_factory_setting: <value in [disable, enable, ext]>
unii-4-5ghz-band: <value in [disable, enable]>
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
wtpprofile:
description: the top level parameters set
required: false
suboptions:
_is_factory_setting:
choices:
- disable
- enable
- ext
description: no description
type: str
allowaccess:
choices:
- https
- ssh
- snmp
- http
- telnet
description: Control management access to the managed WTP, FortiAP, or AP.
elements: str
type: list
ap-country:
choices:
- AL
- DZ
- AR
- AM
- AU
- AT
- AZ
- BH
- BD
- BY
- BE
- BZ
- BO
- BA
- BR
- BN
- BG
- CA
- CL
- CN
- CO
- CR
- HR
- CY
- CZ
- DK
- DO
- EC
- EG
- SV
- EE
- FI
- FR
- GE
- DE
- GR
- GT
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IE
- IL
- IT
- JM
- JP
- JO
- KZ
- KE
- KP
- KR
- KW
- LV
- LB
- LI
- LT
- LU
- MO
- MK
- MY
- MT
- MX
- MC
- MA
- NP
- NL
- AN
- NZ
- 'NO'
- OM
- PK
- PA
- PG
- PE
- PH
- PL
- PT
- PR
- QA
- RO
- RU
- SA
- SG
- SK
- SI
- ZA
- ES
- LK
- SE
- CH
- SY
- TW
- TH
- TT
- TN
- TR
- AE
- UA
- GB
- US
- PS
- UY
- UZ
- VE
- VN
- YE
- ZW
- NA
- KH
- TZ
- SD
- AO
- RW
- MZ
- RS
- ME
- BB
- GD
- GL
- GU
- PY
- HT
- AW
- MM
- ZB
- CF
- BS
- VC
- MV
- SN
- CI
- GH
- MW
- UG
- BF
- KY
- TC
- TM
- VU
- FM
- GY
- KN
- LC
- CX
- AF
- CM
- ML
- BJ
- MG
- TD
- BW
- LY
- LS
- MU
- SL
- NE
- TG
- RE
- MD
- BM
- VI
- PM
- MF
- IM
- FO
- GI
- LA
- WF
- MH
- BT
- PF
- NI
- GF
- AS
- MP
- PW
- GP
- ET
- SR
- DM
- MQ
- YT
- BL
- ZM
- CG
- CD
- MR
- IQ
- FJ
- --
- MN
description: Country in which this WTP, FortiAP or AP will operate
type: str
ap-handoff:
choices:
- disable
- enable
description: Enable/disable AP handoff of clients to other APs
type: str
apcfg-profile:
description: AP local configuration profile name.
type: str
ble-profile:
description: Bluetooth Low Energy profile name.
type: str
comment:
description: Comment.
type: str
console-login:
choices:
- disable
- enable
description: Enable/disable FortiAP console login access
type: str
control-message-offload:
choices:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
- spectral-analysis
description: Enable/disable CAPWAP control message data channel offload.
elements: str
type: list
deny-mac-list:
description: Deny-Mac-List.
elements: dict
suboptions:
id:
description: ID.
type: int
mac:
description: A WiFi device with this MAC address is denied access to this
WTP, FortiAP or AP.
type: str
type: list
dtls-in-kernel:
choices:
- disable
- enable
description: Enable/disable data channel DTLS in kernel.
type: str
dtls-policy:
choices:
- clear-text
- dtls-enabled
- ipsec-vpn
- ipsec-sn-vpn
description: WTP data channel DTLS policy
elements: str
type: list
energy-efficient-ethernet:
choices:
- disable
- enable
description: Enable/disable use of energy efficient Ethernet on WTP.
type: str
esl-ses-dongle:
description: no description
required: false
suboptions:
apc-addr-type:
choices:
- fqdn
- ip
description: ESL SES-imagotag APC address type
type: str
apc-fqdn:
description: FQDN of ESL SES-imagotag Access Point Controller
type: str
apc-ip:
description: IP address of ESL SES-imagotag Access Point Controller
type: str
apc-port:
description: Port of ESL SES-imagotag Access Point Controller
type: int
coex-level:
choices:
- none
description: ESL SES-imagotag dongle coexistence level
type: str
compliance-level:
choices:
- compliance-level-2
description: Compliance levels for the ESL solution integration
type: str
esl-channel:
choices:
- '0'
- '1'
- '2'
- '3'
- '4'
- '5'
- '6'
- '7'
- '8'
- '9'
- '10'
- '127'
- '-1'
description: ESL SES-imagotag dongle channel
type: str
output-power:
choices:
- a
- b
- c
- d
- e
- f
- g
- h
description: ESL SES-imagotag dongle output power
type: str
scd-enable:
choices:
- disable
- enable
description: Enable/disable ESL SES-imagotag Serial Communication Daemon
type: str
tls-cert-verification:
choices:
- disable
- enable
description: Enable/disable TLS certificate verification
type: str
tls-fqdn-verification:
choices:
- disable
- enable
description: Enable/disable TLS certificate verification
type: str
type: dict
ext-info-enable:
choices:
- disable
- enable
description: Enable/disable station/VAP/radio extension information.
type: str
frequency-handoff:
choices:
- disable
- enable
description: Enable/disable frequency handoff of clients to other channels
type: str
handoff-roaming:
choices:
- disable
- enable
description: Enable/disable client load balancing during roaming to avoid roaming
delay
type: str
handoff-rssi:
description: Minimum received signal strength indicator
type: int
handoff-sta-thresh:
description: Threshold value for AP handoff.
type: int
indoor-outdoor-deployment:
choices:
- platform-determined
- outdoor
- indoor
description: Set to allow indoor/outdoor-only channels under regulatory rules
type: str
ip-fragment-preventing:
choices:
- tcp-mss-adjust
- icmp-unreachable
description: Method
elements: str
type: list
lan:
description: no description
required: false
suboptions:
port-esl-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: ESL port mode.
type: str
port-esl-ssid:
description: Bridge ESL port to SSID.
type: str
port-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port mode.
type: str
port-ssid:
description: Bridge LAN port to SSID.
type: str
port1-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 1 mode.
type: str
port1-ssid:
description: Bridge LAN port 1 to SSID.
type: str
port2-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 2 mode.
type: str
port2-ssid:
description: Bridge LAN port 2 to SSID.
type: str
port3-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 3 mode.
type: str
port3-ssid:
description: Bridge LAN port 3 to SSID.
type: str
port4-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 4 mode.
type: str
port4-ssid:
description: Bridge LAN port 4 to SSID.
type: str
port5-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 5 mode.
type: str
port5-ssid:
description: Bridge LAN port 5 to SSID.
type: str
port6-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 6 mode.
type: str
port6-ssid:
description: Bridge LAN port 6 to SSID.
type: str
port7-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 7 mode.
type: str
port7-ssid:
description: Bridge LAN port 7 to SSID.
type: str
port8-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: LAN port 8 mode.
type: str
port8-ssid:
description: Bridge LAN port 8 to SSID.
type: str
type: dict
lbs:
description: no description
required: false
suboptions:
aeroscout:
choices:
- disable
- enable
description: Enable/disable AeroScout Real Time Location Service
type: str
aeroscout-ap-mac:
choices:
- bssid
- board-mac
description: Use BSSID or board MAC address as AP MAC address in AeroScout
AP messages
type: str
aeroscout-mmu-report:
choices:
- disable
- enable
description: Enable/disable compounded AeroScout tag and MU report
type: str
aeroscout-mu:
choices:
- disable
- enable
description: Enable/disable AeroScout Mobile Unit
type: str
aeroscout-mu-factor:
description: AeroScout MU mode dilution factor
type: int
aeroscout-mu-timeout:
description: AeroScout MU mode timeout
type: int
aeroscout-server-ip:
description: IP address of AeroScout server.
type: str
aeroscout-server-port:
description: AeroScout server UDP listening port.
type: int
ekahau-blink-mode:
choices:
- disable
- enable
description: Enable/disable Ekahau blink mode
type: str
ekahau-tag:
description: WiFi frame MAC address or WiFi Tag.
type: str
erc-server-ip:
description: IP address of Ekahau RTLS Controller
type: str
erc-server-port:
description: Ekahau RTLS Controller
type: int
fortipresence:
choices:
- disable
- enable
- enable2
- foreign
- both
description: Enable/disable FortiPresence to monitor the location and activity
of WiFi clients even if they dont connect to this WiF...
type: str
fortipresence-ble:
choices:
- disable
- enable
description: Enable/disable FortiPresence finding and reporting BLE devices.
type: str
fortipresence-frequency:
description: FortiPresence report transmit frequency
type: int
fortipresence-port:
description: FortiPresence server UDP listening port
type: int
fortipresence-project:
description: FortiPresence project name
type: str
fortipresence-rogue:
choices:
- disable
- enable
description: Enable/disable FortiPresence finding and reporting rogue APs.
type: str
fortipresence-secret:
description: FortiPresence secret password
type: str
fortipresence-server:
description: FortiPresence server IP address.
type: str
fortipresence-server-addr-type:
choices:
- fqdn
- ipv4
description: FortiPresence server address type
type: str
fortipresence-server-fqdn:
description: FQDN of FortiPresence server.
type: str
fortipresence-unassoc:
choices:
- disable
- enable
description: Enable/disable FortiPresence finding and reporting unassociated
stations.
type: str
station-locate:
choices:
- disable
- enable
description: Enable/disable client station locating services for all clients,
whether associated or not
type: str
type: dict
led-schedules:
description: Recurring firewall schedules for illuminating LEDs on the FortiAP.
type: str
led-state:
choices:
- disable
- enable
description: Enable/disable use of LEDs on WTP
type: str
lldp:
choices:
- disable
- enable
description: Enable/disable Link Layer Discovery Protocol
type: str
login-passwd:
description: Set the managed WTP, FortiAP, or APs administrator password.
type: str
login-passwd-change:
choices:
- 'no'
- 'yes'
- default
description: Change or reset the administrator password of a managed WTP, FortiAP
or AP
type: str
max-clients:
description: Maximum number of stations
type: int
name:
description: WTP
type: str
platform:
description: no description
required: false
suboptions:
_local_platform_str:
description: _Local_Platform_Str.
type: str
ddscan:
choices:
- disable
- enable
description: Enable/disable use of one radio for dedicated dual-band scanning
to detect RF characterization and wireless threat mana...
type: str
mode:
choices:
- dual-5G
- single-5G
description: Configure operation mode of 5G radios
type: str
type:
choices:
- 30B-50B
- 60B
- 80CM-81CM
- 220A
- 220B
- 210B
- 60C
- 222B
- 112B
- 320B
- 11C
- 14C
- 223B
- 28C
- 320C
- 221C
- 25D
- 222C
- 224D
- 214B
- 21D
- 24D
- 112D
- 223C
- 321C
- C220C
- C225C
- S321C
- S323C
- FWF
- S311C
- S313C
- AP-11N
- S322C
- S321CR
- S322CR
- S323CR
- S421E
- S422E
- S423E
- 421E
- 423E
- C221E
- C226E
- C23JD
- C24JE
- C21D
- U421E
- U423E
- 221E
- 222E
- 223E
- S221E
- S223E
- U221EV
- U223EV
- U321EV
- U323EV
- 224E
- U422EV
- U24JEV
- 321E
- U431F
- U433F
- 231E
- 431F
- 433F
- 231F
- 432F
- 234F
- 23JF
- U231F
- 831F
- U234F
- U432F
- 431FL
- 432FR
- 433FL
- 231FL
- 231G
- 233G
- 431G
- 433G
- U231G
- U441G
- 234G
description: WTP, FortiAP or AP platform type.
type: str
type: dict
poe-mode:
choices:
- auto
- 8023af
- 8023at
- power-adapter
- full
- high
- low
description: Set the WTP, FortiAP, or APs PoE mode.
type: str
radio-1:
description: no description
required: false
suboptions:
80211d:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Enable/disable airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Enable/disable AP handoff of clients to other APs
type: str
ap-sniffer-addr:
description: MAC address to monitor.
type: str
ap-sniffer-bufsize:
description: Sniffer buffer size
type: int
ap-sniffer-chan:
description: Channel on which to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Distributed Automatic Radio Resource Provisioning
type: str
auto-power-high:
description: The upper bound of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Enable/disable automatic power-level adjustment to prevent co-channel
interference
type: str
auto-power-low:
description: The lower bound of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: The target of automatic transmit power adjustment in dBm.
type: str
band:
choices:
- 802.11b
- 802.11a
- 802.11g
- 802.11n
- 802.11ac
- 802.11n-5G
- 802.11ax-5G
- 802.11ax
- 802.11ac-2G
- 802.11g-only
- 802.11n-only
- 802.11n,g-only
- 802.11ac-only
- 802.11ac,n-only
- 802.11n-5G-only
- 802.11ax-5G-only
- 802.11ax,ac-only
- 802.11ax,ac,n-only
- 802.11ax-only
- 802.11ax,n-only
- 802.11ax,n,g-only
- 802.11ax-6G
description: WiFi band that Radio 1 operates on.
type: str
band-5g-type:
choices:
- 5g-full
- 5g-high
- 5g-low
description: WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Maximum bandwidth capacity allowed
type: int
beacon-interval:
description: Beacon interval.
type: int
bss-color:
description: BSS color value for this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: BSS color mode for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
call-capacity:
description: Maximum number of Voice over WLAN
type: int
channel:
description: Selected list of wireless radio channels.
type: str
channel-bonding:
choices:
- disable
- enable
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Enable/disable measuring channel utilization.
type: str
coexistence:
choices:
- disable
- enable
description: Enable/disable allowing both HT20 and HT40 on the same radio
type: str
darrp:
choices:
- disable
- enable
description: Enable/disable Distributed Automatic Radio Resource Provisioning
type: str
drma:
choices:
- disable
- enable
description: Enable/disable dynamic radio mode assignment
type: str
drma-sensitivity:
choices:
- low
- medium
- high
description: Network Coverage Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Maximum packet size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Enable/disable frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Iperf test protocol
type: str
iperf-server-port:
description: Iperf service port number.
type: int
max-clients:
description: Maximum number of stations
type: int
max-distance:
description: Maximum expected distance between the AP and clients
type: int
mode:
choices:
- disabled
- ap
- monitor
- sniffer
- sam
description: Mode of radio 1.
type: str
optional-antenna:
choices:
- none
- FANT-04ABGN-0606-O-N
- FANT-04ABGN-1414-P-N
- FANT-04ABGN-8065-P-N
- FANT-04ABGN-0606-O-R
- FANT-04ABGN-0606-P-R
- FANT-10ACAX-1213-D-N
- FANT-08ABGN-1213-D-R
description: Optional antenna used on FAP
type: str
power-level:
description: Radio power level as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Set radio effective isotropic radiated power
type: str
power-value:
description: Radio EIRP power in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Enable client power-saving features such as TIM, AC VO, and OBSS
etc.
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Enable/disable 802.
type: str
radio-id:
description: Radio-Id.
type: int
rts-threshold:
description: Maximum packet size for RTS transmissions, specifying the maximum
size of a data packet before RTS/CTS
type: int
sam-bssid:
description: BSSID for WiFi network.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Enable/disable Captive Portal Authentication
type: str
sam-cwp-failure-string:
description: Failure identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Identification string from the captive portal login form.
type: str
sam-cwp-password:
description: description
type: str
sam-cwp-success-string:
description: Success identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Website the client is trying to access.
type: str
sam-cwp-username:
description: Username for captive portal authentication.
type: str
sam-password:
description: Passphrase for WiFi network connection.
type: str
sam-report-intv:
description: SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
description: Select WiFi network security type
type: str
sam-server:
description: SAM test server IP address or domain name.
type: str
sam-server-fqdn:
description: SAM test server domain name.
type: str
sam-server-ip:
description: SAM test server IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Select SAM server type
type: str
sam-ssid:
description: SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Select SAM test type
type: str
sam-username:
description: Username for WiFi network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Use either the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Enable/disable spectrum analysis to find interference that would
negatively impact wireless performance.
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Packet transmission optimization options including power saving,
aggregation limiting, retry limiting, etc.
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Configure method for assigning SSIDs to this FortiAP
type: str
vap1:
description: Virtual Access Point
type: str
vap2:
description: Virtual Access Point
type: str
vap3:
description: Virtual Access Point
type: str
vap4:
description: Virtual Access Point
type: str
vap5:
description: Virtual Access Point
type: str
vap6:
description: Virtual Access Point
type: str
vap7:
description: Virtual Access Point
type: str
vap8:
description: Virtual Access Point
type: str
vaps:
description: Manually selected list of Virtual Access Points
type: str
wids-profile:
description: Wireless Intrusion Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Enable/disable zero wait DFS on radio
type: str
type: dict
radio-2:
description: no description
required: false
suboptions:
80211d:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Enable/disable airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Enable/disable AP handoff of clients to other APs
type: str
ap-sniffer-addr:
description: MAC address to monitor.
type: str
ap-sniffer-bufsize:
description: Sniffer buffer size
type: int
ap-sniffer-chan:
description: Channel on which to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Distributed Automatic Radio Resource Provisioning
type: str
auto-power-high:
description: The upper bound of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Enable/disable automatic power-level adjustment to prevent co-channel
interference
type: str
auto-power-low:
description: The lower bound of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: The target of automatic transmit power adjustment in dBm.
type: str
band:
choices:
- 802.11b
- 802.11a
- 802.11g
- 802.11n
- 802.11ac
- 802.11n-5G
- 802.11ax-5G
- 802.11ax
- 802.11ac-2G
- 802.11g-only
- 802.11n-only
- 802.11n,g-only
- 802.11ac-only
- 802.11ac,n-only
- 802.11n-5G-only
- 802.11ax-5G-only
- 802.11ax,ac-only
- 802.11ax,ac,n-only
- 802.11ax-only
- 802.11ax,n-only
- 802.11ax,n,g-only
- 802.11ax-6G
description: WiFi band that Radio 2 operates on.
type: str
band-5g-type:
choices:
- 5g-full
- 5g-high
- 5g-low
description: WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Maximum bandwidth capacity allowed
type: int
beacon-interval:
description: Beacon interval.
type: int
bss-color:
description: BSS color value for this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: BSS color mode for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
call-capacity:
description: Maximum number of Voice over WLAN
type: int
channel:
description: Selected list of wireless radio channels.
type: str
channel-bonding:
choices:
- disable
- enable
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Enable/disable measuring channel utilization.
type: str
coexistence:
choices:
- disable
- enable
description: Enable/disable allowing both HT20 and HT40 on the same radio
type: str
darrp:
choices:
- disable
- enable
description: Enable/disable Distributed Automatic Radio Resource Provisioning
type: str
drma:
choices:
- disable
- enable
description: Enable/disable dynamic radio mode assignment
type: str
drma-sensitivity:
choices:
- low
- medium
- high
description: Network Coverage Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Maximum packet size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Enable/disable frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Iperf test protocol
type: str
iperf-server-port:
description: Iperf service port number.
type: int
max-clients:
description: Maximum number of stations
type: int
max-distance:
description: Maximum expected distance between the AP and clients
type: int
mode:
choices:
- disabled
- ap
- monitor
- sniffer
- sam
description: Mode of radio 2.
type: str
optional-antenna:
choices:
- none
- FANT-04ABGN-0606-O-N
- FANT-04ABGN-1414-P-N
- FANT-04ABGN-8065-P-N
- FANT-04ABGN-0606-O-R
- FANT-04ABGN-0606-P-R
- FANT-10ACAX-1213-D-N
- FANT-08ABGN-1213-D-R
description: Optional antenna used on FAP
type: str
power-level:
description: Radio power level as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Set radio effective isotropic radiated power
type: str
power-value:
description: Radio EIRP power in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Enable client power-saving features such as TIM, AC VO, and OBSS
etc.
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Enable/disable 802.
type: str
radio-id:
description: Radio-Id.
type: int
rts-threshold:
description: Maximum packet size for RTS transmissions, specifying the maximum
size of a data packet before RTS/CTS
type: int
sam-bssid:
description: BSSID for WiFi network.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Enable/disable Captive Portal Authentication
type: str
sam-cwp-failure-string:
description: Failure identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Identification string from the captive portal login form.
type: str
sam-cwp-password:
description: description
type: str
sam-cwp-success-string:
description: Success identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Website the client is trying to access.
type: str
sam-cwp-username:
description: Username for captive portal authentication.
type: str
sam-password:
description: Passphrase for WiFi network connection.
type: str
sam-report-intv:
description: SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
description: Select WiFi network security type
type: str
sam-server:
description: SAM test server IP address or domain name.
type: str
sam-server-fqdn:
description: SAM test server domain name.
type: str
sam-server-ip:
description: SAM test server IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Select SAM server type
type: str
sam-ssid:
description: SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Select SAM test type
type: str
sam-username:
description: Username for WiFi network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Use either the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Enable/disable spectrum analysis to find interference that would
negatively impact wireless performance.
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Packet transmission optimization options including power saving,
aggregation limiting, retry limiting, etc.
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Configure method for assigning SSIDs to this FortiAP
type: str
vap1:
description: Virtual Access Point
type: str
vap2:
description: Virtual Access Point
type: str
vap3:
description: Virtual Access Point
type: str
vap4:
description: Virtual Access Point
type: str
vap5:
description: Virtual Access Point
type: str
vap6:
description: Virtual Access Point
type: str
vap7:
description: Virtual Access Point
type: str
vap8:
description: Virtual Access Point
type: str
vaps:
description: Manually selected list of Virtual Access Points
type: str
wids-profile:
description: Wireless Intrusion Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Enable/disable zero wait DFS on radio
type: str
type: dict
radio-3:
description: no description
required: false
suboptions:
80211d:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Enable/disable airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Enable/disable AP handoff of clients to other APs
type: str
ap-sniffer-addr:
description: MAC address to monitor.
type: str
ap-sniffer-bufsize:
description: Sniffer buffer size
type: int
ap-sniffer-chan:
description: Channel on which to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Distributed Automatic Radio Resource Provisioning
type: str
auto-power-high:
description: The upper bound of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Enable/disable automatic power-level adjustment to prevent co-channel
interference
type: str
auto-power-low:
description: The lower bound of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: The target of automatic transmit power adjustment in dBm.
type: str
band:
choices:
- 802.11b
- 802.11a
- 802.11g
- 802.11n
- 802.11ac
- 802.11n-5G
- 802.11ax-5G
- 802.11ax
- 802.11ac-2G
- 802.11g-only
- 802.11n-only
- 802.11n,g-only
- 802.11ac-only
- 802.11ac,n-only
- 802.11n-5G-only
- 802.11ax-5G-only
- 802.11ax,ac-only
- 802.11ax,ac,n-only
- 802.11ax-only
- 802.11ax,n-only
- 802.11ax,n,g-only
- 802.11ax-6G
description: WiFi band that Radio 3 operates on.
type: str
band-5g-type:
choices:
- 5g-full
- 5g-high
- 5g-low
description: WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Maximum bandwidth capacity allowed
type: int
beacon-interval:
description: Beacon interval.
type: int
bss-color:
description: BSS color value for this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: BSS color mode for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
call-capacity:
description: Maximum number of Voice over WLAN
type: int
channel:
description: Selected list of wireless radio channels.
type: str
channel-bonding:
choices:
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Enable/disable measuring channel utilization.
type: str
coexistence:
choices:
- disable
- enable
description: Enable/disable allowing both HT20 and HT40 on the same radio
type: str
darrp:
choices:
- disable
- enable
description: Enable/disable Distributed Automatic Radio Resource Provisioning
type: str
drma:
choices:
- disable
- enable
description: Enable/disable dynamic radio mode assignment
type: str
drma-sensitivity:
choices:
- low
- medium
- high
description: Network Coverage Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Maximum packet size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Enable/disable frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Iperf test protocol
type: str
iperf-server-port:
description: Iperf service port number.
type: int
max-clients:
description: Maximum number of stations
type: int
max-distance:
description: Maximum expected distance between the AP and clients
type: int
mode:
choices:
- disabled
- ap
- monitor
- sniffer
- sam
description: Mode of radio 3.
type: str
optional-antenna:
choices:
- none
- FANT-04ABGN-0606-O-N
- FANT-04ABGN-1414-P-N
- FANT-04ABGN-8065-P-N
- FANT-04ABGN-0606-O-R
- FANT-04ABGN-0606-P-R
- FANT-10ACAX-1213-D-N
- FANT-08ABGN-1213-D-R
description: Optional antenna used on FAP
type: str
power-level:
description: Radio power level as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Set radio effective isotropic radiated power
type: str
power-value:
description: Radio EIRP power in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Enable client power-saving features such as TIM, AC VO, and OBSS
etc.
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Enable/disable 802.
type: str
radio-id:
description: Radio-Id.
type: int
rts-threshold:
description: Maximum packet size for RTS transmissions, specifying the maximum
size of a data packet before RTS/CTS
type: int
sam-bssid:
description: BSSID for WiFi network.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Enable/disable Captive Portal Authentication
type: str
sam-cwp-failure-string:
description: Failure identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Identification string from the captive portal login form.
type: str
sam-cwp-password:
description: description
type: str
sam-cwp-success-string:
description: Success identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Website the client is trying to access.
type: str
sam-cwp-username:
description: Username for captive portal authentication.
type: str
sam-password:
description: Passphrase for WiFi network connection.
type: str
sam-report-intv:
description: SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
description: Select WiFi network security type
type: str
sam-server:
description: SAM test server IP address or domain name.
type: str
sam-server-fqdn:
description: SAM test server domain name.
type: str
sam-server-ip:
description: SAM test server IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Select SAM server type
type: str
sam-ssid:
description: SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Select SAM test type
type: str
sam-username:
description: Username for WiFi network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Use either the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Enable/disable spectrum analysis to find interference that would
negatively impact wireless performance.
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Packet transmission optimization options including power saving,
aggregation limiting, retry limiting, etc.
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Configure method for assigning SSIDs to this FortiAP
type: str
vap1:
description: Virtual Access Point
type: str
vap2:
description: Virtual Access Point
type: str
vap3:
description: Virtual Access Point
type: str
vap4:
description: Virtual Access Point
type: str
vap5:
description: Virtual Access Point
type: str
vap6:
description: Virtual Access Point
type: str
vap7:
description: Virtual Access Point
type: str
vap8:
description: Virtual Access Point
type: str
vaps:
description: Manually selected list of Virtual Access Points
type: str
wids-profile:
description: Wireless Intrusion Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Enable/disable zero wait DFS on radio
type: str
type: dict
radio-4:
description: no description
required: false
suboptions:
80211d:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Enable/disable airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Enable/disable AP handoff of clients to other APs
type: str
ap-sniffer-addr:
description: MAC address to monitor.
type: str
ap-sniffer-bufsize:
description: Sniffer buffer size
type: int
ap-sniffer-chan:
description: Channel on which to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Enable/disable sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Distributed Automatic Radio Resource Provisioning
type: str
auto-power-high:
description: The upper bound of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Enable/disable automatic power-level adjustment to prevent co-channel
interference
type: str
auto-power-low:
description: The lower bound of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: The target of automatic transmit power adjustment in dBm.
type: str
band:
choices:
- 802.11b
- 802.11a
- 802.11g
- 802.11n
- 802.11ac
- 802.11n-5G
- 802.11ax-5G
- 802.11ax
- 802.11ac-2G
- 802.11g-only
- 802.11n-only
- 802.11n,g-only
- 802.11ac-only
- 802.11ac,n-only
- 802.11n-5G-only
- 802.11ax-5G-only
- 802.11ax,ac-only
- 802.11ax,ac,n-only
- 802.11ax-only
- 802.11ax,n-only
- 802.11ax,n,g-only
- 802.11ax-6G
description: WiFi band that Radio 3 operates on.
type: str
band-5g-type:
choices:
- 5g-full
- 5g-high
- 5g-low
description: WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Maximum bandwidth capacity allowed
type: int
beacon-interval:
description: Beacon interval.
type: int
bss-color:
description: BSS color value for this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: BSS color mode for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Enable/disable WiFi multimedia
type: str
call-capacity:
description: Maximum number of Voice over WLAN
type: int
channel:
description: Selected list of wireless radio channels.
type: str
channel-bonding:
choices:
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Enable/disable measuring channel utilization.
type: str
coexistence:
choices:
- disable
- enable
description: Enable/disable allowing both HT20 and HT40 on the same radio
type: str
darrp:
choices:
- disable
- enable
description: Enable/disable Distributed Automatic Radio Resource Provisioning
type: str
drma:
choices:
- disable
- enable
description: Enable/disable dynamic radio mode assignment
type: str
drma-sensitivity:
choices:
- low
- medium
- high
description: Network Coverage Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Maximum packet size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Enable/disable frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Iperf test protocol
type: str
iperf-server-port:
description: Iperf service port number.
type: int
max-clients:
description: Maximum number of stations
type: int
max-distance:
description: Maximum expected distance between the AP and clients
type: int
mode:
choices:
- ap
- monitor
- sniffer
- disabled
- sam
description: Mode of radio 3.
type: str
optional-antenna:
choices:
- none
- FANT-04ABGN-0606-O-N
- FANT-04ABGN-1414-P-N
- FANT-04ABGN-8065-P-N
- FANT-04ABGN-0606-O-R
- FANT-04ABGN-0606-P-R
- FANT-10ACAX-1213-D-N
- FANT-08ABGN-1213-D-R
description: Optional antenna used on FAP
type: str
power-level:
description: Radio power level as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Set radio effective isotropic radiated power
type: str
power-value:
description: Radio EIRP power in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Enable client power-saving features such as TIM, AC VO, and OBSS
etc.
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Enable/disable 802.
type: str
radio-id:
description: Radio-Id.
type: int
rts-threshold:
description: Maximum packet size for RTS transmissions, specifying the maximum
size of a data packet before RTS/CTS
type: int
sam-bssid:
description: BSSID for WiFi network.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Enable/disable Captive Portal Authentication
type: str
sam-cwp-failure-string:
description: Failure identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Identification string from the captive portal login form.
type: str
sam-cwp-password:
description: description
type: str
sam-cwp-success-string:
description: Success identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Website the client is trying to access.
type: str
sam-cwp-username:
description: Username for captive portal authentication.
type: str
sam-password:
description: Passphrase for WiFi network connection.
type: str
sam-report-intv:
description: SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
description: Select WiFi network security type
type: str
sam-server:
description: SAM test server IP address or domain name.
type: str
sam-server-fqdn:
description: SAM test server domain name.
type: str
sam-server-ip:
description: SAM test server IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Select SAM server type
type: str
sam-ssid:
description: SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Select SAM test type
type: str
sam-username:
description: Username for WiFi network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Use either the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Enable/disable spectrum analysis to find interference that would
negatively impact wireless performance.
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Packet transmission optimization options including power saving,
aggregation limiting, retry limiting, etc.
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Configure method for assigning SSIDs to this FortiAP
type: str
vap1:
description: Virtual Access Point
type: str
vap2:
description: Virtual Access Point
type: str
vap3:
description: Virtual Access Point
type: str
vap4:
description: Virtual Access Point
type: str
vap5:
description: Virtual Access Point
type: str
vap6:
description: Virtual Access Point
type: str
vap7:
description: Virtual Access Point
type: str
vap8:
description: Virtual Access Point
type: str
vaps:
description: Manually selected list of Virtual Access Points
type: str
wids-profile:
description: Wireless Intrusion Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Enable/disable zero wait DFS on radio
type: str
type: dict
snmp:
choices:
- disable
- enable
description: Enable/disable SNMP for the WTP, FortiAP, or AP
type: str
split-tunneling-acl:
description: Split-Tunneling-Acl.
elements: dict
suboptions:
dest-ip:
description: Destination IP and mask for the split-tunneling subnet.
type: str
id:
description: ID.
type: int
type: list
split-tunneling-acl-local-ap-subnet:
choices:
- disable
- enable
description: Enable/disable automatically adding local subnetwork of FortiAP to
split-tunneling ACL
type: str
split-tunneling-acl-path:
choices:
- tunnel
- local
description: Split tunneling ACL path is local/tunnel.
type: str
syslog-profile:
description: System log server configuration profile name.
type: str
tun-mtu-downlink:
description: Downlink CAPWAP tunnel MTU
type: int
tun-mtu-uplink:
description: Uplink CAPWAP tunnel MTU
type: int
unii-4-5ghz-band:
choices:
- disable
- enable
description: Enable/disable UNII-4 5Ghz band channels
type: str
wan-port-auth:
choices:
- none
- 802.1x
description: Set WAN port authentication mode
type: str
wan-port-auth-methods:
choices:
- all
- EAP-FAST
- EAP-TLS
- EAP-PEAP
description: WAN port 802.
type: str
wan-port-auth-password:
description: description
type: str
wan-port-auth-usrname:
description: Set WAN port 802.
type: str
wan-port-mode:
choices:
- wan-lan
- wan-only
description: Enable/disable using a WAN port as a LAN port.
type: str
type: dict
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list