Try SpotterConfigure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
| "added in version" 2.0.0 of fortinet.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 fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
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.
fortinet.fortimanager.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: present # <value in [present, absent]>
wtpprofile:
allowaccess:
- https
- ssh
- snmp
- http
- telnet
ap_country: <value in [AL, DZ, AR, ...]>
ble_profile: <string>
comment: <string>
control_message_offload:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
- spectral-analysis
deny_mac_list:
-
id: <integer>
mac: <string>
dtls_in_kernel: <value in [disable, enable]>
dtls_policy:
- clear-text
- dtls-enabled
- ipsec-vpn
- ipsec-sn-vpn
energy_efficient_ethernet: <value in [disable, enable]>
ext_info_enable: <value in [disable, enable]>
handoff_roaming: <value in [disable, enable]>
handoff_rssi: <integer>
handoff_sta_thresh: <integer>
ip_fragment_preventing:
- tcp-mss-adjust
- icmp-unreachable
led_schedules: <list or string>
led_state: <value in [disable, enable]>
lldp: <value in [disable, enable]>
login_passwd: <list or string>
login_passwd_change: <value in [no, yes, default]>
max_clients: <integer>
name: <string>
poe_mode: <value in [auto, 8023af, 8023at, ...]>
split_tunneling_acl:
-
dest_ip: <string>
id: <integer>
split_tunneling_acl_local_ap_subnet: <value in [disable, enable]>
split_tunneling_acl_path: <value in [tunnel, local]>
tun_mtu_downlink: <integer>
tun_mtu_uplink: <integer>
wan_port_mode: <value in [wan-lan, wan-only]>
snmp: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
apcfg_profile: <string>
frequency_handoff: <value in [disable, enable]>
lan:
port_esl_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port_esl_ssid: <string>
port_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port_ssid: <string>
port1_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port1_ssid: <string>
port2_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port2_ssid: <string>
port3_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port3_ssid: <string>
port4_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port4_ssid: <string>
port5_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port5_ssid: <string>
port6_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port6_ssid: <string>
port7_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port7_ssid: <string>
port8_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port8_ssid: <string>
lbs:
aeroscout: <value in [disable, enable]>
aeroscout_ap_mac: <value in [bssid, board-mac]>
aeroscout_mmu_report: <value in [disable, enable]>
aeroscout_mu: <value in [disable, enable]>
aeroscout_mu_factor: <integer>
aeroscout_mu_timeout: <integer>
aeroscout_server_ip: <string>
aeroscout_server_port: <integer>
ekahau_blink_mode: <value in [disable, enable]>
ekahau_tag: <string>
erc_server_ip: <string>
erc_server_port: <integer>
fortipresence: <value in [disable, enable, enable2, ...]>
fortipresence_ble: <value in [disable, enable]>
fortipresence_frequency: <integer>
fortipresence_port: <integer>
fortipresence_project: <string>
fortipresence_rogue: <value in [disable, enable]>
fortipresence_secret: <list or string>
fortipresence_server: <string>
fortipresence_unassoc: <value in [disable, enable]>
station_locate: <value in [disable, enable]>
fortipresence_server_addr_type: <value in [fqdn, ipv4]>
fortipresence_server_fqdn: <string>
polestar: <value in [disable, enable]>
polestar_accumulation_interval: <integer>
polestar_asset_addrgrp_list: <string>
polestar_asset_uuid_list1: <string>
polestar_asset_uuid_list2: <string>
polestar_asset_uuid_list3: <string>
polestar_asset_uuid_list4: <string>
polestar_protocol: <value in [WSS]>
polestar_reporting_interval: <integer>
polestar_server_fqdn: <string>
polestar_server_path: <string>
polestar_server_port: <integer>
polestar_server_token: <string>
platform:
ddscan: <value in [disable, enable]>
mode: <value in [dual-5G, single-5G]>
type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
_local_platform_str: <string>
radio_1:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [disable, enable, 80MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
radio_2:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [disable, enable, 80MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
radio_3:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
radio_4:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [ap, monitor, sniffer, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
console_login: <value in [disable, enable]>
esl_ses_dongle:
apc_addr_type: <value in [fqdn, ip]>
apc_fqdn: <string>
apc_ip: <string>
apc_port: <integer>
coex_level: <value in [none]>
compliance_level: <value in [compliance-level-2]>
esl_channel: <value in [0, 1, 2, ...]>
output_power: <value in [a, b, c, ...]>
scd_enable: <value in [disable, enable]>
tls_cert_verification: <value in [disable, enable]>
tls_fqdn_verification: <value in [disable, enable]>
indoor_outdoor_deployment: <value in [platform-determined, outdoor, indoor]>
syslog_profile: <string>
wan_port_auth: <value in [none, 802.1x]>
wan_port_auth_methods: <value in [all, EAP-FAST, EAP-TLS, ...]>
wan_port_auth_password: <list or string>
wan_port_auth_usrname: <string>
_is_factory_setting: <value in [disable, enable, ext]>
unii_4_5ghz_band: <value in [disable, enable]>
bonjour_profile: <string>
wan_port_auth_macsec: <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
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
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
- NG
- GA
- GM
- SO
- SZ
- LR
- DJ
description: Deprecated, please rename it to ap_country. Country in which this
WTP, FortiAP or AP will operate
type: str
ap-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_handoff. Enable/disable AP handoff
of clients to other APs
type: str
apcfg-profile:
description: Deprecated, please rename it to apcfg_profile. AP local configuration
profile name.
type: str
ble-profile:
description: Deprecated, please rename it to ble_profile. Bluetooth Low Energy
profile name.
type: str
bonjour-profile:
description: Deprecated, please rename it to bonjour_profile. Bonjour profile
name.
type: str
comment:
description: Comment.
type: str
console-login:
choices:
- disable
- enable
description: Deprecated, please rename it to console_login. 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: Deprecated, please rename it to control_message_offload. Enable/disable
CAPWAP control message data channel offload.
elements: str
type: list
deny-mac-list:
description: Deprecated, please rename it to deny_mac_list. 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: Deprecated, please rename it to dtls_in_kernel. Enable/disable data
channel DTLS in kernel.
type: str
dtls-policy:
choices:
- clear-text
- dtls-enabled
- ipsec-vpn
- ipsec-sn-vpn
description: Deprecated, please rename it to dtls_policy. WTP data channel DTLS
policy
elements: str
type: list
energy-efficient-ethernet:
choices:
- disable
- enable
description: Deprecated, please rename it to energy_efficient_ethernet. Enable/disable
use of energy efficient Ethernet on WTP.
type: str
esl-ses-dongle:
description: Deprecated, please rename it to esl_ses_dongle.
suboptions:
apc-addr-type:
choices:
- fqdn
- ip
description: Deprecated, please rename it to apc_addr_type. ESL SES-imagotag
APC address type
type: str
apc-fqdn:
description: Deprecated, please rename it to apc_fqdn. FQDN of ESL SES-imagotag
Access Point Controller
type: str
apc-ip:
description: Deprecated, please rename it to apc_ip. IP address of ESL SES-imagotag
Access Point Controller
type: str
apc-port:
description: Deprecated, please rename it to apc_port. Port of ESL SES-imagotag
Access Point Controller
type: int
coex-level:
choices:
- none
description: Deprecated, please rename it to coex_level. ESL SES-imagotag
dongle coexistence level
type: str
compliance-level:
choices:
- compliance-level-2
description: Deprecated, please rename it to compliance_level. 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: Deprecated, please rename it to esl_channel. ESL SES-imagotag
dongle channel
type: str
output-power:
choices:
- a
- b
- c
- d
- e
- f
- g
- h
description: Deprecated, please rename it to output_power. ESL SES-imagotag
dongle output power
type: str
scd-enable:
choices:
- disable
- enable
description: Deprecated, please rename it to scd_enable. Enable/disable ESL
SES-imagotag Serial Communication Daemon
type: str
tls-cert-verification:
choices:
- disable
- enable
description: Deprecated, please rename it to tls_cert_verification. Enable/disable
TLS certificate verification
type: str
tls-fqdn-verification:
choices:
- disable
- enable
description: Deprecated, please rename it to tls_fqdn_verification. Enable/disable
TLS certificate verification
type: str
type: dict
ext-info-enable:
choices:
- disable
- enable
description: Deprecated, please rename it to ext_info_enable. Enable/disable station/VAP/radio
extension information.
type: str
frequency-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to frequency_handoff. Enable/disable
frequency handoff of clients to other channels
type: str
handoff-roaming:
choices:
- disable
- enable
description: Deprecated, please rename it to handoff_roaming. Enable/disable client
load balancing during roaming to avoid roaming delay
type: str
handoff-rssi:
description: Deprecated, please rename it to handoff_rssi. Minimum received signal
strength indicator
type: int
handoff-sta-thresh:
description: Deprecated, please rename it to handoff_sta_thresh. Threshold value
for AP handoff.
type: int
indoor-outdoor-deployment:
choices:
- platform-determined
- outdoor
- indoor
description: Deprecated, please rename it to indoor_outdoor_deployment. Set to
allow indoor/outdoor-only channels under regulatory rules
type: str
ip-fragment-preventing:
choices:
- tcp-mss-adjust
- icmp-unreachable
description: Deprecated, please rename it to ip_fragment_preventing. Method
elements: str
type: list
lan:
description: No description.
suboptions:
port-esl-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port_esl_mode. ESL port mode.
type: str
port-esl-ssid:
description: Deprecated, please rename it to port_esl_ssid. Bridge ESL port
to SSID.
type: str
port-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port_mode. LAN port mode.
type: str
port-ssid:
description: Deprecated, please rename it to port_ssid. Bridge LAN port to
SSID.
type: str
port1-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port1_mode. LAN port 1 mode.
type: str
port1-ssid:
description: Deprecated, please rename it to port1_ssid. Bridge LAN port 1
to SSID.
type: str
port2-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port2_mode. LAN port 2 mode.
type: str
port2-ssid:
description: Deprecated, please rename it to port2_ssid. Bridge LAN port 2
to SSID.
type: str
port3-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port3_mode. LAN port 3 mode.
type: str
port3-ssid:
description: Deprecated, please rename it to port3_ssid. Bridge LAN port 3
to SSID.
type: str
port4-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port4_mode. LAN port 4 mode.
type: str
port4-ssid:
description: Deprecated, please rename it to port4_ssid. Bridge LAN port 4
to SSID.
type: str
port5-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port5_mode. LAN port 5 mode.
type: str
port5-ssid:
description: Deprecated, please rename it to port5_ssid. Bridge LAN port 5
to SSID.
type: str
port6-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port6_mode. LAN port 6 mode.
type: str
port6-ssid:
description: Deprecated, please rename it to port6_ssid. Bridge LAN port 6
to SSID.
type: str
port7-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port7_mode. LAN port 7 mode.
type: str
port7-ssid:
description: Deprecated, please rename it to port7_ssid. Bridge LAN port 7
to SSID.
type: str
port8-mode:
choices:
- offline
- bridge-to-wan
- bridge-to-ssid
- nat-to-wan
description: Deprecated, please rename it to port8_mode. LAN port 8 mode.
type: str
port8-ssid:
description: Deprecated, please rename it to port8_ssid. Bridge LAN port 8
to SSID.
type: str
type: dict
lbs:
description: No description.
suboptions:
aeroscout:
choices:
- disable
- enable
description: Enable/disable AeroScout Real Time Location Service
type: str
aeroscout-ap-mac:
choices:
- bssid
- board-mac
description: Deprecated, please rename it to aeroscout_ap_mac. Use BSSID or
board MAC address as AP MAC address in AeroScout AP...
type: str
aeroscout-mmu-report:
choices:
- disable
- enable
description: Deprecated, please rename it to aeroscout_mmu_report. Enable/disable
compounded AeroScout tag and MU report
type: str
aeroscout-mu:
choices:
- disable
- enable
description: Deprecated, please rename it to aeroscout_mu. Enable/disable
AeroScout Mobile Unit
type: str
aeroscout-mu-factor:
description: Deprecated, please rename it to aeroscout_mu_factor. AeroScout
MU mode dilution factor
type: int
aeroscout-mu-timeout:
description: Deprecated, please rename it to aeroscout_mu_timeout. AeroScout
MU mode timeout
type: int
aeroscout-server-ip:
description: Deprecated, please rename it to aeroscout_server_ip. IP address
of AeroScout server.
type: str
aeroscout-server-port:
description: Deprecated, please rename it to aeroscout_server_port. AeroScout
server UDP listening port.
type: int
ekahau-blink-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to ekahau_blink_mode. Enable/disable
Ekahau blink mode
type: str
ekahau-tag:
description: Deprecated, please rename it to ekahau_tag. WiFi frame MAC address
or WiFi Tag.
type: str
erc-server-ip:
description: Deprecated, please rename it to erc_server_ip. IP address of
Ekahau RTLS Controller
type: str
erc-server-port:
description: Deprecated, please rename it to erc_server_port. 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 thi...
type: str
fortipresence-ble:
choices:
- disable
- enable
description: Deprecated, please rename it to fortipresence_ble. Enable/disable
FortiPresence finding and reporting BLE devices.
type: str
fortipresence-frequency:
description: Deprecated, please rename it to fortipresence_frequency. FortiPresence
report transmit frequency
type: int
fortipresence-port:
description: Deprecated, please rename it to fortipresence_port. FortiPresence
server UDP listening port
type: int
fortipresence-project:
description: Deprecated, please rename it to fortipresence_project. FortiPresence
project name
type: str
fortipresence-rogue:
choices:
- disable
- enable
description: Deprecated, please rename it to fortipresence_rogue. Enable/disable
FortiPresence finding and reporting rogue APs.
type: str
fortipresence-secret:
description: (list) Deprecated, please rename it to fortipresence_secret.
FortiPresence secret password
type: raw
fortipresence-server:
description: Deprecated, please rename it to fortipresence_server. FortiPresence
server IP address.
type: str
fortipresence-server-addr-type:
choices:
- fqdn
- ipv4
description: Deprecated, please rename it to fortipresence_server_addr_type.
FortiPresence server address type
type: str
fortipresence-server-fqdn:
description: Deprecated, please rename it to fortipresence_server_fqdn. FQDN
of FortiPresence server.
type: str
fortipresence-unassoc:
choices:
- disable
- enable
description: Deprecated, please rename it to fortipresence_unassoc. Enable/disable
FortiPresence finding and reporting unassoci...
type: str
polestar:
choices:
- disable
- enable
description: Enable/disable PoleStar BLE NAO Track Real Time Location Service
type: str
polestar-accumulation-interval:
description: Deprecated, please rename it to polestar_accumulation_interval.
Time that measurements should be accumulated in se...
type: int
polestar-asset-addrgrp-list:
description: Deprecated, please rename it to polestar_asset_addrgrp_list.
Tags and asset addrgrp list to be reported.
type: str
polestar-asset-uuid-list1:
description: Deprecated, please rename it to polestar_asset_uuid_list1. Tags
and asset UUID list 1 to be reported
type: str
polestar-asset-uuid-list2:
description: Deprecated, please rename it to polestar_asset_uuid_list2. Tags
and asset UUID list 2 to be reported
type: str
polestar-asset-uuid-list3:
description: Deprecated, please rename it to polestar_asset_uuid_list3. Tags
and asset UUID list 3 to be reported
type: str
polestar-asset-uuid-list4:
description: Deprecated, please rename it to polestar_asset_uuid_list4. Tags
and asset UUID list 4 to be reported
type: str
polestar-protocol:
choices:
- WSS
description: Deprecated, please rename it to polestar_protocol. Select the
protocol to report Measurements, Advertising Data, o...
type: str
polestar-reporting-interval:
description: Deprecated, please rename it to polestar_reporting_interval.
Time between reporting accumulated measurements in se...
type: int
polestar-server-fqdn:
description: Deprecated, please rename it to polestar_server_fqdn. FQDN of
PoleStar Nao Track Server
type: str
polestar-server-path:
description: Deprecated, please rename it to polestar_server_path. Path of
PoleStar Nao Track Server
type: str
polestar-server-port:
description: Deprecated, please rename it to polestar_server_port. Port of
PoleStar Nao Track Server
type: int
polestar-server-token:
description: Deprecated, please rename it to polestar_server_token. Access
Token of PoleStar Nao Track Server.
type: str
station-locate:
choices:
- disable
- enable
description: Deprecated, please rename it to station_locate. Enable/disable
client station locating services for all clients, w...
type: str
type: dict
led-schedules:
description: (list or str) Deprecated, please rename it to led_schedules. Recurring
firewall schedules for illuminating LEDs on the For...
type: raw
led-state:
choices:
- disable
- enable
description: Deprecated, please rename it to led_state. 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: (list) Deprecated, please rename it to login_passwd. Set the managed
WTP, FortiAP, or APs administrator password.
type: raw
login-passwd-change:
choices:
- 'no'
- 'yes'
- default
description: Deprecated, please rename it to login_passwd_change. Change or reset
the administrator password of a managed WTP, FortiAP ...
type: str
max-clients:
description: Deprecated, please rename it to max_clients. Maximum number of stations
type: int
name:
description: WTP
required: true
type: str
platform:
description: No description.
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...
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
- 432G
- 441K
- 443K
- 241K
- 243K
description: WTP, FortiAP or AP platform type.
type: str
type: dict
poe-mode:
choices:
- auto
- 8023af
- 8023at
- power-adapter
- full
- high
- low
description: Deprecated, please rename it to poe_mode. Set the WTP, FortiAP, or
APs PoE mode.
type: str
radio-1:
description: Deprecated, please rename it to radio_1.
suboptions:
80211d:
choices:
- disable
- enable
description: Deprecated, please rename it to d80211d. Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Deprecated, please rename it to airtime_fairness. Enable/disable
airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_handoff. Enable/disable AP
handoff of clients to other APs
type: str
ap-sniffer-addr:
description: Deprecated, please rename it to ap_sniffer_addr. MAC address
to monitor.
type: str
ap-sniffer-bufsize:
description: Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer
size
type: int
ap-sniffer-chan:
description: Deprecated, please rename it to ap_sniffer_chan. Channel on which
to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_ctl. Enable/disable
sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_data. Enable/disable
sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable
sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable
sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable
sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Deprecated, please rename it to arrp_profile. Distributed Automatic
Radio Resource Provisioning
type: str
auto-power-high:
description: Deprecated, please rename it to auto_power_high. The upper bound
of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_power_level. Enable/disable
automatic power-level adjustment to prevent co-ch...
type: str
auto-power-low:
description: Deprecated, please rename it to auto_power_low. The lower bound
of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: Deprecated, please rename it to auto_power_target. 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: Deprecated, please rename it to band_5g_type. WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to bandwidth_admission_control.
Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth
capacity allowed
type: int
beacon-interval:
description: Deprecated, please rename it to beacon_interval. Beacon interval.
type: int
bss-color:
description: Deprecated, please rename it to bss_color. BSS color value for
this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: Deprecated, please rename it to bss_color_mode. BSS color mode
for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to call_admission_control. Enable/disable
WiFi multimedia
type: str
call-capacity:
description: Deprecated, please rename it to call_capacity. Maximum number
of Voice over WLAN
type: int
channel:
description: (list) Selected list of wireless radio channels.
type: raw
channel-bonding:
choices:
- disable
- enable
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Deprecated, please rename it to channel_bonding. Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Deprecated, please rename it to channel_utilization. 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: Deprecated, please rename it to drma_sensitivity. Network Coverage
Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Deprecated, please rename it to frag_threshold. Maximum packet
size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to frequency_handoff. Enable/disable
frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Deprecated, please rename it to iperf_protocol. Iperf test protocol
type: str
iperf-server-port:
description: Deprecated, please rename it to iperf_server_port. Iperf service
port number.
type: int
max-clients:
description: Deprecated, please rename it to max_clients. Maximum number of
stations
type: int
max-distance:
description: Deprecated, please rename it to max_distance. Maximum expected
distance between the AP and clients
type: int
mimo-mode:
choices:
- default
- 1x1
- 2x2
- 3x3
- 4x4
- 8x8
description: Deprecated, please rename it to mimo_mode. Configure radio MIMO
mode
type: str
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
- custom
description: Deprecated, please rename it to optional_antenna. Optional antenna
used on FAP
type: str
optional-antenna-gain:
description: Deprecated, please rename it to optional_antenna_gain. Optional
antenna gain in dBi
type: str
power-level:
description: Deprecated, please rename it to power_level. Radio power level
as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Deprecated, please rename it to power_mode. Set radio effective
isotropic radiated power
type: str
power-value:
description: Deprecated, please rename it to power_value. Radio EIRP power
in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Deprecated, please rename it to powersave_optimize. Enable client
power-saving features such as TIM, AC VO, and OB...
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Deprecated, please rename it to protection_mode. Enable/disable
802.
type: str
radio-id:
description: Deprecated, please rename it to radio_id. Radio-Id.
type: int
rts-threshold:
description: Deprecated, please rename it to rts_threshold. Maximum packet
size for RTS transmissions, specifying the maximum s...
type: int
sam-bssid:
description: Deprecated, please rename it to sam_bssid. BSSID for WiFi network.
type: str
sam-ca-certificate:
description: Deprecated, please rename it to sam_ca_certificate. CA certificate
for WPA2/WPA3-ENTERPRISE.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Deprecated, please rename it to sam_captive_portal. Enable/disable
Captive Portal Authentication
type: str
sam-client-certificate:
description: Deprecated, please rename it to sam_client_certificate. Client
certificate for WPA2/WPA3-ENTERPRISE.
type: str
sam-cwp-failure-string:
description: Deprecated, please rename it to sam_cwp_failure_string. Failure
identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Deprecated, please rename it to sam_cwp_match_string. Identification
string from the captive portal login form.
type: str
sam-cwp-password:
description: (list) Deprecated, please rename it to sam_cwp_password.
type: raw
sam-cwp-success-string:
description: Deprecated, please rename it to sam_cwp_success_string. Success
identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Deprecated, please rename it to sam_cwp_test_url. Website the
client is trying to access.
type: str
sam-cwp-username:
description: Deprecated, please rename it to sam_cwp_username. Username for
captive portal authentication.
type: str
sam-eap-method:
choices:
- tls
- peap
- both
description: Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE
EAP Method
type: str
sam-password:
description: (list) Deprecated, please rename it to sam_password. Passphrase
for WiFi network connection.
type: raw
sam-private-key:
description: Deprecated, please rename it to sam_private_key. Private key
for WPA2/WPA3-ENTERPRISE.
type: str
sam-private-key-password:
description: (list) Deprecated, please rename it to sam_private_key_password.
type: raw
sam-report-intv:
description: Deprecated, please rename it to sam_report_intv. SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
- owe
- wpa3-sae
description: Deprecated, please rename it to sam_security_type. Select WiFi
network security type
type: str
sam-server:
description: Deprecated, please rename it to sam_server. SAM test server IP
address or domain name.
type: str
sam-server-fqdn:
description: Deprecated, please rename it to sam_server_fqdn. SAM test server
domain name.
type: str
sam-server-ip:
description: Deprecated, please rename it to sam_server_ip. SAM test server
IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Deprecated, please rename it to sam_server_type. Select SAM server
type
type: str
sam-ssid:
description: Deprecated, please rename it to sam_ssid. SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Deprecated, please rename it to sam_test. Select SAM test type
type: str
sam-username:
description: Deprecated, please rename it to sam_username. Username for WiFi
network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Deprecated, please rename it to short_guard_interval. Use either
the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Deprecated, please rename it to spectrum_analysis. Enable/disable
spectrum analysis to find interference that woul...
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Deprecated, please rename it to transmit_optimize. Packet transmission
optimization options including power saving...
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Deprecated, please rename it to vap_all. 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: (list or str) Manually selected list of Virtual Access Points
type: raw
wids-profile:
description: Deprecated, please rename it to wids_profile. Wireless Intrusion
Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Deprecated, please rename it to zero_wait_dfs. Enable/disable
zero wait DFS on radio
type: str
type: dict
radio-2:
description: Deprecated, please rename it to radio_2.
suboptions:
80211d:
choices:
- disable
- enable
description: Deprecated, please rename it to d80211d. Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Deprecated, please rename it to airtime_fairness. Enable/disable
airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_handoff. Enable/disable AP
handoff of clients to other APs
type: str
ap-sniffer-addr:
description: Deprecated, please rename it to ap_sniffer_addr. MAC address
to monitor.
type: str
ap-sniffer-bufsize:
description: Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer
size
type: int
ap-sniffer-chan:
description: Deprecated, please rename it to ap_sniffer_chan. Channel on which
to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_ctl. Enable/disable
sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_data. Enable/disable
sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable
sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable
sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable
sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Deprecated, please rename it to arrp_profile. Distributed Automatic
Radio Resource Provisioning
type: str
auto-power-high:
description: Deprecated, please rename it to auto_power_high. The upper bound
of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_power_level. Enable/disable
automatic power-level adjustment to prevent co-ch...
type: str
auto-power-low:
description: Deprecated, please rename it to auto_power_low. The lower bound
of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: Deprecated, please rename it to auto_power_target. 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: Deprecated, please rename it to band_5g_type. WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to bandwidth_admission_control.
Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth
capacity allowed
type: int
beacon-interval:
description: Deprecated, please rename it to beacon_interval. Beacon interval.
type: int
bss-color:
description: Deprecated, please rename it to bss_color. BSS color value for
this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: Deprecated, please rename it to bss_color_mode. BSS color mode
for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to call_admission_control. Enable/disable
WiFi multimedia
type: str
call-capacity:
description: Deprecated, please rename it to call_capacity. Maximum number
of Voice over WLAN
type: int
channel:
description: (list) Selected list of wireless radio channels.
type: raw
channel-bonding:
choices:
- disable
- enable
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Deprecated, please rename it to channel_bonding. Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Deprecated, please rename it to channel_utilization. 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: Deprecated, please rename it to drma_sensitivity. Network Coverage
Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Deprecated, please rename it to frag_threshold. Maximum packet
size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to frequency_handoff. Enable/disable
frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Deprecated, please rename it to iperf_protocol. Iperf test protocol
type: str
iperf-server-port:
description: Deprecated, please rename it to iperf_server_port. Iperf service
port number.
type: int
max-clients:
description: Deprecated, please rename it to max_clients. Maximum number of
stations
type: int
max-distance:
description: Deprecated, please rename it to max_distance. Maximum expected
distance between the AP and clients
type: int
mimo-mode:
choices:
- default
- 1x1
- 2x2
- 3x3
- 4x4
- 8x8
description: Deprecated, please rename it to mimo_mode. Configure radio MIMO
mode
type: str
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
- custom
description: Deprecated, please rename it to optional_antenna. Optional antenna
used on FAP
type: str
optional-antenna-gain:
description: Deprecated, please rename it to optional_antenna_gain. Optional
antenna gain in dBi
type: str
power-level:
description: Deprecated, please rename it to power_level. Radio power level
as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Deprecated, please rename it to power_mode. Set radio effective
isotropic radiated power
type: str
power-value:
description: Deprecated, please rename it to power_value. Radio EIRP power
in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Deprecated, please rename it to powersave_optimize. Enable client
power-saving features such as TIM, AC VO, and OB...
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Deprecated, please rename it to protection_mode. Enable/disable
802.
type: str
radio-id:
description: Deprecated, please rename it to radio_id. Radio-Id.
type: int
rts-threshold:
description: Deprecated, please rename it to rts_threshold. Maximum packet
size for RTS transmissions, specifying the maximum s...
type: int
sam-bssid:
description: Deprecated, please rename it to sam_bssid. BSSID for WiFi network.
type: str
sam-ca-certificate:
description: Deprecated, please rename it to sam_ca_certificate. CA certificate
for WPA2/WPA3-ENTERPRISE.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Deprecated, please rename it to sam_captive_portal. Enable/disable
Captive Portal Authentication
type: str
sam-client-certificate:
description: Deprecated, please rename it to sam_client_certificate. Client
certificate for WPA2/WPA3-ENTERPRISE.
type: str
sam-cwp-failure-string:
description: Deprecated, please rename it to sam_cwp_failure_string. Failure
identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Deprecated, please rename it to sam_cwp_match_string. Identification
string from the captive portal login form.
type: str
sam-cwp-password:
description: (list) Deprecated, please rename it to sam_cwp_password.
type: raw
sam-cwp-success-string:
description: Deprecated, please rename it to sam_cwp_success_string. Success
identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Deprecated, please rename it to sam_cwp_test_url. Website the
client is trying to access.
type: str
sam-cwp-username:
description: Deprecated, please rename it to sam_cwp_username. Username for
captive portal authentication.
type: str
sam-eap-method:
choices:
- tls
- peap
- both
description: Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE
EAP Method
type: str
sam-password:
description: (list) Deprecated, please rename it to sam_password. Passphrase
for WiFi network connection.
type: raw
sam-private-key:
description: Deprecated, please rename it to sam_private_key. Private key
for WPA2/WPA3-ENTERPRISE.
type: str
sam-private-key-password:
description: (list) Deprecated, please rename it to sam_private_key_password.
type: raw
sam-report-intv:
description: Deprecated, please rename it to sam_report_intv. SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
- owe
- wpa3-sae
description: Deprecated, please rename it to sam_security_type. Select WiFi
network security type
type: str
sam-server:
description: Deprecated, please rename it to sam_server. SAM test server IP
address or domain name.
type: str
sam-server-fqdn:
description: Deprecated, please rename it to sam_server_fqdn. SAM test server
domain name.
type: str
sam-server-ip:
description: Deprecated, please rename it to sam_server_ip. SAM test server
IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Deprecated, please rename it to sam_server_type. Select SAM server
type
type: str
sam-ssid:
description: Deprecated, please rename it to sam_ssid. SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Deprecated, please rename it to sam_test. Select SAM test type
type: str
sam-username:
description: Deprecated, please rename it to sam_username. Username for WiFi
network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Deprecated, please rename it to short_guard_interval. Use either
the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Deprecated, please rename it to spectrum_analysis. Enable/disable
spectrum analysis to find interference that woul...
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Deprecated, please rename it to transmit_optimize. Packet transmission
optimization options including power saving...
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Deprecated, please rename it to vap_all. 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: (list or str) Manually selected list of Virtual Access Points
type: raw
wids-profile:
description: Deprecated, please rename it to wids_profile. Wireless Intrusion
Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Deprecated, please rename it to zero_wait_dfs. Enable/disable
zero wait DFS on radio
type: str
type: dict
radio-3:
description: Deprecated, please rename it to radio_3.
suboptions:
80211d:
choices:
- disable
- enable
description: Deprecated, please rename it to d80211d. Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Deprecated, please rename it to airtime_fairness. Enable/disable
airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_handoff. Enable/disable AP
handoff of clients to other APs
type: str
ap-sniffer-addr:
description: Deprecated, please rename it to ap_sniffer_addr. MAC address
to monitor.
type: str
ap-sniffer-bufsize:
description: Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer
size
type: int
ap-sniffer-chan:
description: Deprecated, please rename it to ap_sniffer_chan. Channel on which
to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_ctl. Enable/disable
sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_data. Enable/disable
sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable
sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable
sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable
sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Deprecated, please rename it to arrp_profile. Distributed Automatic
Radio Resource Provisioning
type: str
auto-power-high:
description: Deprecated, please rename it to auto_power_high. The upper bound
of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_power_level. Enable/disable
automatic power-level adjustment to prevent co-ch...
type: str
auto-power-low:
description: Deprecated, please rename it to auto_power_low. The lower bound
of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: Deprecated, please rename it to auto_power_target. 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: Deprecated, please rename it to band_5g_type. WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to bandwidth_admission_control.
Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth
capacity allowed
type: int
beacon-interval:
description: Deprecated, please rename it to beacon_interval. Beacon interval.
type: int
bss-color:
description: Deprecated, please rename it to bss_color. BSS color value for
this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: Deprecated, please rename it to bss_color_mode. BSS color mode
for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to call_admission_control. Enable/disable
WiFi multimedia
type: str
call-capacity:
description: Deprecated, please rename it to call_capacity. Maximum number
of Voice over WLAN
type: int
channel:
description: (list) Selected list of wireless radio channels.
type: raw
channel-bonding:
choices:
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Deprecated, please rename it to channel_bonding. Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Deprecated, please rename it to channel_utilization. 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: Deprecated, please rename it to drma_sensitivity. Network Coverage
Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Deprecated, please rename it to frag_threshold. Maximum packet
size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to frequency_handoff. Enable/disable
frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Deprecated, please rename it to iperf_protocol. Iperf test protocol
type: str
iperf-server-port:
description: Deprecated, please rename it to iperf_server_port. Iperf service
port number.
type: int
max-clients:
description: Deprecated, please rename it to max_clients. Maximum number of
stations
type: int
max-distance:
description: Deprecated, please rename it to max_distance. Maximum expected
distance between the AP and clients
type: int
mimo-mode:
choices:
- default
- 1x1
- 2x2
- 3x3
- 4x4
- 8x8
description: Deprecated, please rename it to mimo_mode. Configure radio MIMO
mode
type: str
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
- custom
description: Deprecated, please rename it to optional_antenna. Optional antenna
used on FAP
type: str
optional-antenna-gain:
description: Deprecated, please rename it to optional_antenna_gain. Optional
antenna gain in dBi
type: str
power-level:
description: Deprecated, please rename it to power_level. Radio power level
as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Deprecated, please rename it to power_mode. Set radio effective
isotropic radiated power
type: str
power-value:
description: Deprecated, please rename it to power_value. Radio EIRP power
in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Deprecated, please rename it to powersave_optimize. Enable client
power-saving features such as TIM, AC VO, and OB...
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Deprecated, please rename it to protection_mode. Enable/disable
802.
type: str
radio-id:
description: Deprecated, please rename it to radio_id. Radio-Id.
type: int
rts-threshold:
description: Deprecated, please rename it to rts_threshold. Maximum packet
size for RTS transmissions, specifying the maximum s...
type: int
sam-bssid:
description: Deprecated, please rename it to sam_bssid. BSSID for WiFi network.
type: str
sam-ca-certificate:
description: Deprecated, please rename it to sam_ca_certificate. CA certificate
for WPA2/WPA3-ENTERPRISE.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Deprecated, please rename it to sam_captive_portal. Enable/disable
Captive Portal Authentication
type: str
sam-client-certificate:
description: Deprecated, please rename it to sam_client_certificate. Client
certificate for WPA2/WPA3-ENTERPRISE.
type: str
sam-cwp-failure-string:
description: Deprecated, please rename it to sam_cwp_failure_string. Failure
identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Deprecated, please rename it to sam_cwp_match_string. Identification
string from the captive portal login form.
type: str
sam-cwp-password:
description: (list) Deprecated, please rename it to sam_cwp_password.
type: raw
sam-cwp-success-string:
description: Deprecated, please rename it to sam_cwp_success_string. Success
identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Deprecated, please rename it to sam_cwp_test_url. Website the
client is trying to access.
type: str
sam-cwp-username:
description: Deprecated, please rename it to sam_cwp_username. Username for
captive portal authentication.
type: str
sam-eap-method:
choices:
- tls
- peap
- both
description: Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE
EAP Method
type: str
sam-password:
description: (list) Deprecated, please rename it to sam_password. Passphrase
for WiFi network connection.
type: raw
sam-private-key:
description: Deprecated, please rename it to sam_private_key. Private key
for WPA2/WPA3-ENTERPRISE.
type: str
sam-private-key-password:
description: (list) Deprecated, please rename it to sam_private_key_password.
type: raw
sam-report-intv:
description: Deprecated, please rename it to sam_report_intv. SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
- owe
- wpa3-sae
description: Deprecated, please rename it to sam_security_type. Select WiFi
network security type
type: str
sam-server:
description: Deprecated, please rename it to sam_server. SAM test server IP
address or domain name.
type: str
sam-server-fqdn:
description: Deprecated, please rename it to sam_server_fqdn. SAM test server
domain name.
type: str
sam-server-ip:
description: Deprecated, please rename it to sam_server_ip. SAM test server
IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Deprecated, please rename it to sam_server_type. Select SAM server
type
type: str
sam-ssid:
description: Deprecated, please rename it to sam_ssid. SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Deprecated, please rename it to sam_test. Select SAM test type
type: str
sam-username:
description: Deprecated, please rename it to sam_username. Username for WiFi
network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Deprecated, please rename it to short_guard_interval. Use either
the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Deprecated, please rename it to spectrum_analysis. Enable/disable
spectrum analysis to find interference that woul...
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Deprecated, please rename it to transmit_optimize. Packet transmission
optimization options including power saving...
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Deprecated, please rename it to vap_all. 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: (list or str) Manually selected list of Virtual Access Points
type: raw
wids-profile:
description: Deprecated, please rename it to wids_profile. Wireless Intrusion
Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Deprecated, please rename it to zero_wait_dfs. Enable/disable
zero wait DFS on radio
type: str
type: dict
radio-4:
description: Deprecated, please rename it to radio_4.
suboptions:
80211d:
choices:
- disable
- enable
description: Deprecated, please rename it to d80211d. Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Deprecated, please rename it to airtime_fairness. Enable/disable
airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_handoff. Enable/disable AP
handoff of clients to other APs
type: str
ap-sniffer-addr:
description: Deprecated, please rename it to ap_sniffer_addr. MAC address
to monitor.
type: str
ap-sniffer-bufsize:
description: Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer
size
type: int
ap-sniffer-chan:
description: Deprecated, please rename it to ap_sniffer_chan. Channel on which
to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_ctl. Enable/disable
sniffer on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_data. Enable/disable
sniffer on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable
sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable
sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable
sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Deprecated, please rename it to arrp_profile. Distributed Automatic
Radio Resource Provisioning
type: str
auto-power-high:
description: Deprecated, please rename it to auto_power_high. The upper bound
of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_power_level. Enable/disable
automatic power-level adjustment to prevent co-ch...
type: str
auto-power-low:
description: Deprecated, please rename it to auto_power_low. The lower bound
of automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: Deprecated, please rename it to auto_power_target. 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: Deprecated, please rename it to band_5g_type. WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to bandwidth_admission_control.
Enable/disable WiFi multimedia
type: str
bandwidth-capacity:
description: Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth
capacity allowed
type: int
beacon-interval:
description: Deprecated, please rename it to beacon_interval. Beacon interval.
type: int
bss-color:
description: Deprecated, please rename it to bss_color. BSS color value for
this 11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: Deprecated, please rename it to bss_color_mode. BSS color mode
for this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to call_admission_control. Enable/disable
WiFi multimedia
type: str
call-capacity:
description: Deprecated, please rename it to call_capacity. Maximum number
of Voice over WLAN
type: int
channel:
description: (list) Selected list of wireless radio channels.
type: raw
channel-bonding:
choices:
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Deprecated, please rename it to channel_bonding. Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Deprecated, please rename it to channel_utilization. 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: Deprecated, please rename it to drma_sensitivity. Network Coverage
Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Deprecated, please rename it to frag_threshold. Maximum packet
size that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to frequency_handoff. Enable/disable
frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Deprecated, please rename it to iperf_protocol. Iperf test protocol
type: str
iperf-server-port:
description: Deprecated, please rename it to iperf_server_port. Iperf service
port number.
type: int
max-clients:
description: Deprecated, please rename it to max_clients. Maximum number of
stations
type: int
max-distance:
description: Deprecated, please rename it to max_distance. Maximum expected
distance between the AP and clients
type: int
mimo-mode:
choices:
- default
- 1x1
- 2x2
- 3x3
- 4x4
- 8x8
description: Deprecated, please rename it to mimo_mode. Configure radio MIMO
mode
type: str
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
- custom
description: Deprecated, please rename it to optional_antenna. Optional antenna
used on FAP
type: str
optional-antenna-gain:
description: Deprecated, please rename it to optional_antenna_gain. Optional
antenna gain in dBi
type: str
power-level:
description: Deprecated, please rename it to power_level. Radio power level
as a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Deprecated, please rename it to power_mode. Set radio effective
isotropic radiated power
type: str
power-value:
description: Deprecated, please rename it to power_value. Radio EIRP power
in dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Deprecated, please rename it to powersave_optimize. Enable client
power-saving features such as TIM, AC VO, and OB...
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Deprecated, please rename it to protection_mode. Enable/disable
802.
type: str
radio-id:
description: Deprecated, please rename it to radio_id. Radio-Id.
type: int
rts-threshold:
description: Deprecated, please rename it to rts_threshold. Maximum packet
size for RTS transmissions, specifying the maximum s...
type: int
sam-bssid:
description: Deprecated, please rename it to sam_bssid. BSSID for WiFi network.
type: str
sam-ca-certificate:
description: Deprecated, please rename it to sam_ca_certificate. CA certificate
for WPA2/WPA3-ENTERPRISE.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Deprecated, please rename it to sam_captive_portal. Enable/disable
Captive Portal Authentication
type: str
sam-client-certificate:
description: Deprecated, please rename it to sam_client_certificate. Client
certificate for WPA2/WPA3-ENTERPRISE.
type: str
sam-cwp-failure-string:
description: Deprecated, please rename it to sam_cwp_failure_string. Failure
identification on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Deprecated, please rename it to sam_cwp_match_string. Identification
string from the captive portal login form.
type: str
sam-cwp-password:
description: (list) Deprecated, please rename it to sam_cwp_password.
type: raw
sam-cwp-success-string:
description: Deprecated, please rename it to sam_cwp_success_string. Success
identification on the page after a successful login.
type: str
sam-cwp-test-url:
description: Deprecated, please rename it to sam_cwp_test_url. Website the
client is trying to access.
type: str
sam-cwp-username:
description: Deprecated, please rename it to sam_cwp_username. Username for
captive portal authentication.
type: str
sam-eap-method:
choices:
- tls
- peap
- both
description: Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE
EAP Method
type: str
sam-password:
description: (list) Deprecated, please rename it to sam_password. Passphrase
for WiFi network connection.
type: raw
sam-private-key:
description: Deprecated, please rename it to sam_private_key. Private key
for WPA2/WPA3-ENTERPRISE.
type: str
sam-private-key-password:
description: (list) Deprecated, please rename it to sam_private_key_password.
type: raw
sam-report-intv:
description: Deprecated, please rename it to sam_report_intv. SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
- owe
- wpa3-sae
description: Deprecated, please rename it to sam_security_type. Select WiFi
network security type
type: str
sam-server:
description: Deprecated, please rename it to sam_server. SAM test server IP
address or domain name.
type: str
sam-server-fqdn:
description: Deprecated, please rename it to sam_server_fqdn. SAM test server
domain name.
type: str
sam-server-ip:
description: Deprecated, please rename it to sam_server_ip. SAM test server
IP address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Deprecated, please rename it to sam_server_type. Select SAM server
type
type: str
sam-ssid:
description: Deprecated, please rename it to sam_ssid. SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Deprecated, please rename it to sam_test. Select SAM test type
type: str
sam-username:
description: Deprecated, please rename it to sam_username. Username for WiFi
network connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Deprecated, please rename it to short_guard_interval. Use either
the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Deprecated, please rename it to spectrum_analysis. Enable/disable
spectrum analysis to find interference that woul...
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Deprecated, please rename it to transmit_optimize. Packet transmission
optimization options including power saving...
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Deprecated, please rename it to vap_all. 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: (list or str) Manually selected list of Virtual Access Points
type: raw
wids-profile:
description: Deprecated, please rename it to wids_profile. Wireless Intrusion
Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Deprecated, please rename it to zero_wait_dfs. 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: Deprecated, please rename it to split_tunneling_acl. Split-Tunneling-Acl.
elements: dict
suboptions:
dest-ip:
description: Deprecated, please rename it to dest_ip. 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: Deprecated, please rename it to split_tunneling_acl_local_ap_subnet.
Enable/disable automatically adding local subnetwork ...
type: str
split-tunneling-acl-path:
choices:
- tunnel
- local
description: Deprecated, please rename it to split_tunneling_acl_path. Split tunneling
ACL path is local/tunnel.
type: str
syslog-profile:
description: Deprecated, please rename it to syslog_profile. System log server
configuration profile name.
type: str
tun-mtu-downlink:
description: Deprecated, please rename it to tun_mtu_downlink. Downlink CAPWAP
tunnel MTU
type: int
tun-mtu-uplink:
description: Deprecated, please rename it to tun_mtu_uplink. Uplink CAPWAP tunnel
MTU
type: int
unii-4-5ghz-band:
choices:
- disable
- enable
description: Deprecated, please rename it to unii_4_5ghz_band. Enable/disable
UNII-4 5Ghz band channels
type: str
wan-port-auth:
choices:
- none
- 802.1x
description: Deprecated, please rename it to wan_port_auth. Set WAN port authentication
mode
type: str
wan-port-auth-macsec:
choices:
- disable
- enable
description: Deprecated, please rename it to wan_port_auth_macsec. Enable/disable
WAN port 802.
type: str
wan-port-auth-methods:
choices:
- all
- EAP-FAST
- EAP-TLS
- EAP-PEAP
description: Deprecated, please rename it to wan_port_auth_methods. WAN port 802.
type: str
wan-port-auth-password:
description: (list) Deprecated, please rename it to wan_port_auth_password.
type: raw
wan-port-auth-usrname:
description: Deprecated, please rename it to wan_port_auth_usrname. Set WAN port
802.
type: str
wan-port-mode:
choices:
- wan-lan
- wan-only
description: Deprecated, please rename it to wan_port_mode. 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.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
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.
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.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
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