source: | fortios_wireless_controller_wtp_profile.py |
---|---|
orphan: |
fortios_wireless_controller_wtp_profile -- Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wtp_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_wireless_controller_wtp_profile | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_wtp_profile - Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. type: dict
more...
Supported Version Ranges wireless_controller_wtp_profile v6.0.0 -> latest
- allowaccess - Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space. type: list choices: https, ssh, snmp, telnet, http
more...
Supported Version Ranges allowaccess v6.0.0 -> latest
[https] v6.0.0 -> latest
[ssh] v6.0.0 -> latest
[snmp] v6.2.0 -> latest
[telnet] v6.0.0 -> v6.0.11
[http] v6.0.0 -> v6.0.11
- ap_country - Country in which this WTP, FortiAP, or AP will operate . type: str choices: --, AF, AL, DZ, AS, AO, AR, AM, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, BN, BG, BF, KH, CM, KY, CF, TD, CL, CN, CX, CO, CG, CD, CR, HR, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, ET, EE, GF, PF, FO, FJ, FI, FR, GA, GE, GM, DE, GH, GI, GR, GL, GD, GP, GU, GT, GY, HT, HN, HK, HU, IS, IN, ID, IQ, IE, IM, IL, IT, CI, JM, JO, KZ, KE, KR, KW, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MA, MZ, MM, NA, NP, NL, AN, AW, NZ, NI, NE, NG, NO, MP, OM, PK, PW, PA, PG, PY, PE, PH, PL, PT, PR, QA, RE, RO, RU, RW, BL, KN, LC, MF, PM, VC, SA, SN, RS, ME, SL, SG, SK, SI, SO, ZA, ES, LK, SR, SZ, SE, CH, TW, TZ, TH, TG, TT, TN, TR, TM, AE, TC, UG, UA, GB, US, PS, UY, UZ, VU, VE, VN, VI, WF, YE, ZM, ZW, JP, CA, IR, KP, SD, SY, ZB
more...
Supported Version Ranges ap_country v6.0.0 -> latest
[--] v7.0.1 -> latest
[AF] v7.0.0 -> latest
[AL] v6.0.0 -> latest
[DZ] v6.0.0 -> latest
[AS] v7.0.0 -> latest
[AO] v6.0.0 -> latest
[AR] v6.0.0 -> latest
[AM] v6.0.0 -> latest
[AU] v6.0.0 -> latest
[AT] v6.0.0 -> latest
[AZ] v6.0.0 -> latest
[BS] v6.4.0 -> latest
[BH] v6.0.0 -> latest
[BD] v6.0.0 -> latest
[BB] v6.0.0 -> latest
[BY] v6.0.0 -> latest
[BE] v6.0.0 -> latest
[BZ] v6.0.0 -> latest
[BJ] v7.0.0 -> latest
[BM] v7.0.0 -> latest
[BT] v7.0.0 -> latest
[BO] v6.0.0 -> latest
[BA] v6.0.0 -> latest
[BW] v7.0.0 -> latest
[BR] v6.0.0 -> latest
[BN] v6.0.0 -> latest
[BG] v6.0.0 -> latest
[BF] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[KH] v6.0.0 -> latest
[CM] v7.0.0 -> latest
[KY] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[CF] v6.2.0 -> latest
[TD] v7.0.0 -> latest
[CL] v6.0.0 -> latest
[CN] v6.0.0 -> latest
[CX] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[CO] v6.0.0 -> latest
[CG] v7.0.0 -> latest
[CD] v7.0.0 -> latest
[CR] v6.0.0 -> latest
[HR] v6.0.0 -> latest
[CY] v6.0.0 -> latest
[CZ] v6.0.0 -> latest
[DK] v6.0.0 -> latest
[DJ] v7.4.1 -> latest
[DM] v7.0.0 -> latest
[DO] v6.0.0 -> latest
[EC] v6.0.0 -> latest
[EG] v6.0.0 -> latest
[SV] v6.0.0 -> latest
[ET] v7.0.0 -> latest
[EE] v6.0.0 -> latest
[GF] v7.0.0 -> latest
[PF] v7.0.0 -> latest
[FO] v7.0.0 -> latest
[FJ] v7.0.0 -> latest
[FI] v6.0.0 -> latest
[FR] v6.0.0 -> latest
[GA] v7.4.1 -> latest
[GE] v6.0.0 -> latest
[GM] v7.4.1 -> latest
[DE] v6.0.0 -> latest
[GH] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[GI] v7.0.0 -> latest
[GR] v6.0.0 -> latest
[GL] v6.0.0 -> latest
[GD] v6.0.0 -> latest
[GP] v7.0.0 -> latest
[GU] v6.0.0 -> latest
[GT] v6.0.0 -> latest
[GY] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[HT] v6.0.0 -> latest
[HN] v6.0.0 -> latest
[HK] v6.0.0 -> latest
[HU] v6.0.0 -> latest
[IS] v6.0.0 -> latest
[IN] v6.0.0 -> latest
[ID] v6.0.0 -> latest
[IQ] v7.0.0 -> latest
[IE] v6.0.0 -> latest
[IM] v7.0.0 -> latest
[IL] v6.0.0 -> latest
[IT] v6.0.0 -> latest
[CI] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[JM] v6.0.0 -> latest
[JO] v6.0.0 -> latest
[KZ] v6.0.0 -> latest
[KE] v6.0.0 -> latest
[KR] v6.0.0 -> latest
[KW] v6.0.0 -> latest
[LA] v7.0.0 -> latest
[LV] v6.0.0 -> latest
[LB] v6.0.0 -> latest
[LS] v7.0.0 -> latest
[LR] v7.4.1 -> latest
[LY] v7.0.0 -> latest
[LI] v6.0.0 -> latest
[LT] v6.0.0 -> latest
[LU] v6.0.0 -> latest
[MO] v6.0.0 -> latest
[MK] v6.0.0 -> latest
[MG] v7.0.0 -> latest
[MW] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[MY] v6.0.0 -> latest
[MV] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[ML] v7.0.0 -> latest
[MT] v6.0.0 -> latest
[MH] v7.0.0 -> latest
[MQ] v7.0.0 -> latest
[MR] v7.0.0 -> latest
[MU] v7.0.0 -> latest
[YT] v7.0.0 -> latest
[MX] v6.0.0 -> latest
[FM] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[MD] v7.0.0 -> latest
[MC] v6.0.0 -> latest
[MN] v7.0.8 -> v7.0.12
v7.2.4 -> latest
[MA] v6.0.0 -> latest
[MZ] v6.0.0 -> latest
[MM] v6.0.0 -> latest
[NA] v6.0.0 -> latest
[NP] v6.0.0 -> latest
[NL] v6.0.0 -> latest
[AN] v6.0.0 -> latest
[AW] v6.0.0 -> latest
[NZ] v6.0.0 -> latest
[NI] v7.0.0 -> latest
[NE] v7.0.0 -> latest
[NG] v7.4.1 -> latest
[NO] v6.0.0 -> latest
[MP] v7.0.0 -> latest
[OM] v6.0.0 -> latest
[PK] v6.0.0 -> latest
[PW] v7.0.0 -> latest
[PA] v6.0.0 -> latest
[PG] v6.0.0 -> latest
[PY] v6.0.0 -> latest
[PE] v6.0.0 -> latest
[PH] v6.0.0 -> latest
[PL] v6.0.0 -> latest
[PT] v6.0.0 -> latest
[PR] v6.0.0 -> latest
[QA] v6.0.0 -> latest
[RE] v7.0.0 -> latest
[RO] v6.0.0 -> latest
[RU] v6.0.0 -> latest
[RW] v6.0.0 -> latest
[BL] v7.0.0 -> latest
[KN] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[LC] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[MF] v7.0.0 -> latest
[PM] v7.0.0 -> latest
[VC] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[SA] v6.0.0 -> latest
[SN] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[RS] v6.0.0 -> latest
[ME] v6.0.0 -> latest
[SL] v7.0.0 -> latest
[SG] v6.0.0 -> latest
[SK] v6.0.0 -> latest
[SI] v6.0.0 -> latest
[SO] v7.4.1 -> latest
[ZA] v6.0.0 -> latest
[ES] v6.0.0 -> latest
[LK] v6.0.0 -> latest
[SR] v7.0.0 -> latest
[SZ] v7.4.1 -> latest
[SE] v6.0.0 -> latest
[CH] v6.0.0 -> latest
[TW] v6.0.0 -> latest
[TZ] v6.0.0 -> latest
[TH] v6.0.0 -> latest
[TG] v7.0.0 -> latest
[TT] v6.0.0 -> latest
[TN] v6.0.0 -> latest
[TR] v6.0.0 -> latest
[TM] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[AE] v6.0.0 -> latest
[TC] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[UG] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[UA] v6.0.0 -> latest
[GB] v6.0.0 -> latest
[US] v6.0.0 -> latest
[PS] v6.0.0 -> latest
[UY] v6.0.0 -> latest
[UZ] v6.0.0 -> latest
[VU] v6.4.0 -> v6.4.0
v6.4.4 -> latest
[VE] v6.0.0 -> latest
[VN] v6.0.0 -> latest
[VI] v7.0.0 -> latest
[WF] v7.0.0 -> latest
[YE] v6.0.0 -> latest
[ZM] v7.0.0 -> latest
[ZW] v6.0.0 -> latest
[JP] v6.0.0 -> latest
[CA] v6.0.0 -> latest
[IR] v6.0.0 -> v6.4.4
[KP] v6.0.0 -> v6.4.4
[SD] v6.0.0 -> v6.4.4
[SY] v6.0.0 -> v6.4.4
[ZB] v6.0.0 -> v6.4.4
- ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
more...
Supported Version Ranges ap_handoff v6.4.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- apcfg_profile - AP local configuration profile name. Source wireless-controller.apcfg-profile.name. type: str
more...
Supported Version Ranges apcfg_profile v6.4.0 -> latest
- ble_profile - Bluetooth Low Energy profile name. Source wireless-controller.ble-profile.name. type: str
more...
Supported Version Ranges ble_profile v6.0.0 -> latest
- comment - Comment. type: str
more...
Supported Version Ranges comment v6.0.0 -> latest
- console_login - Enable/disable FortiAP console login access . type: str choices: enable, disable
more...
Supported Version Ranges console_login v7.0.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- control_message_offload - Enable/disable CAPWAP control message data channel offload. type: list choices: ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu, sta-health, spectral-analysis
more...
Supported Version Ranges control_message_offload v6.0.0 -> latest
[ebp-frame] v6.0.0 -> latest
[aeroscout-tag] v6.0.0 -> latest
[ap-list] v6.0.0 -> latest
[sta-list] v6.0.0 -> latest
[sta-cap-list] v6.0.0 -> latest
[stats] v6.0.0 -> latest
[aeroscout-mu] v6.0.0 -> latest
[sta-health] v6.2.0 -> latest
[spectral-analysis] v6.4.0 -> latest
- deny_mac_list - List of MAC addresses that are denied access to this WTP, FortiAP, or AP. type: list member_path: deny_mac_list:id
more...
Supported Version Ranges deny_mac_list v6.0.0 -> latest
- id - ID. see Notes. type: int required: true
more...
Supported Version Ranges id v6.0.0 -> latest
- mac - A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. type: str
more...
Supported Version Ranges mac v6.0.0 -> latest
- dtls_in_kernel - Enable/disable data channel DTLS in kernel. type: str choices: enable, disable
more...
Supported Version Ranges dtls_in_kernel v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- dtls_policy - WTP data channel DTLS policy . type: list choices: clear-text, dtls-enabled, ipsec-vpn, ipsec-sn-vpn
more...
Supported Version Ranges dtls_policy v6.0.0 -> latest
[clear-text] v6.0.0 -> latest
[dtls-enabled] v6.0.0 -> latest
[ipsec-vpn] v6.0.0 -> latest
[ipsec-sn-vpn] v7.4.0 -> latest
- energy_efficient_ethernet - Enable/disable use of energy efficient Ethernet on WTP. type: str choices: enable, disable
more...
Supported Version Ranges energy_efficient_ethernet v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- esl_ses_dongle - ESL SES-imagotag dongle configuration. type: dict
more...
Supported Version Ranges esl_ses_dongle v7.0.1 -> latest
- apc_addr_type - ESL SES-imagotag APC address type . type: str choices: fqdn, ip
more...
Supported Version Ranges apc_addr_type v7.0.1 -> latest
[fqdn] v6.0.0 -> latest
[ip] v6.0.0 -> latest
- apc_fqdn - FQDN of ESL SES-imagotag Access Point Controller (APC). type: str
more...
Supported Version Ranges apc_fqdn v7.0.1 -> latest
- apc_ip - IP address of ESL SES-imagotag Access Point Controller (APC). type: str
more...
Supported Version Ranges apc_ip v7.0.1 -> latest
- apc_port - Port of ESL SES-imagotag Access Point Controller (APC). type: int
more...
Supported Version Ranges apc_port v7.0.1 -> latest
- coex_level - ESL SES-imagotag dongle coexistence level . type: str choices: none
more...
Supported Version Ranges coex_level v7.0.1 -> latest
[none] v6.0.0 -> latest
- compliance_level - Compliance levels for the ESL solution integration . type: str choices: compliance-level-2
more...
Supported Version Ranges compliance_level v7.0.1 -> latest
[compliance-level-2] v6.0.0 -> latest
- esl_channel - ESL SES-imagotag dongle channel . type: str choices: -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 127
more...
Supported Version Ranges esl_channel v7.0.1 -> latest
[-1] v6.0.0 -> latest
[0] v6.0.0 -> latest
[1] v6.0.0 -> latest
[2] v6.0.0 -> latest
[3] v6.0.0 -> latest
[4] v6.0.0 -> latest
[5] v6.0.0 -> latest
[6] v6.0.0 -> latest
[7] v6.0.0 -> latest
[8] v6.0.0 -> latest
[9] v6.0.0 -> latest
[10] v6.0.0 -> latest
[127] v6.0.0 -> latest
- output_power - ESL SES-imagotag dongle output power . type: str choices: a, b, c, d, e, f, g, h
more...
Supported Version Ranges output_power v7.0.1 -> latest
[a] v6.0.0 -> latest
[b] v6.0.0 -> latest
[c] v6.0.0 -> latest
[d] v6.0.0 -> latest
[e] v6.0.0 -> latest
[f] v6.0.0 -> latest
[g] v6.0.0 -> latest
[h] v6.0.0 -> latest
- scd_enable - Enable/disable ESL SES-imagotag Serial Communication Daemon (SCD) . type: str choices: enable, disable
more...
Supported Version Ranges scd_enable v7.0.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- tls_cert_verification - Enable/disable TLS certificate verification . type: str choices: enable, disable
more...
Supported Version Ranges tls_cert_verification v7.0.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- tls_fqdn_verification - Enable/disable TLS certificate verification . type: str choices: enable, disable
more...
Supported Version Ranges tls_fqdn_verification v7.0.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ext_info_enable - Enable/disable station/VAP/radio extension information. type: str choices: enable, disable
more...
Supported Version Ranges ext_info_enable v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
more...
Supported Version Ranges frequency_handoff v6.4.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- handoff_roaming - Enable/disable client load balancing during roaming to avoid roaming delay . type: str choices: enable, disable
more...
Supported Version Ranges handoff_roaming v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- handoff_rssi - Minimum received signal strength indicator (RSSI) value for handoff (20 - 30). type: int
more...
Supported Version Ranges handoff_rssi v6.0.0 -> latest
- handoff_sta_thresh - Threshold value for AP handoff. type: int
more...
Supported Version Ranges handoff_sta_thresh v6.0.0 -> latest
- indoor_outdoor_deployment - Set to allow indoor/outdoor-only channels under regulatory rules . type: str choices: platform-determined, outdoor, indoor
more...
Supported Version Ranges indoor_outdoor_deployment v7.0.1 -> latest
[platform-determined] v6.0.0 -> latest
[outdoor] v6.0.0 -> latest
[indoor] v6.0.0 -> latest
- ip_fragment_preventing - Method(s) by which IP fragmentation is prevented for control and data packets through CAPWAP tunnel . type: list choices: tcp-mss-adjust, icmp-unreachable
more...
Supported Version Ranges ip_fragment_preventing v6.0.0 -> latest
[tcp-mss-adjust] v6.0.0 -> latest
[icmp-unreachable] v6.0.0 -> latest
- lan - WTP LAN port mapping. type: dict
more...
Supported Version Ranges lan v6.0.0 -> latest
- port_esl_mode - ESL port mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port_esl_mode v6.4.0 -> v6.4.0
v6.4.4 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port_esl_ssid - Bridge ESL port to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port_esl_ssid v6.4.0 -> v6.4.0
v6.4.4 -> latest
- port_mode - LAN port mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port_ssid - Bridge LAN port to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port_ssid v6.0.0 -> latest
- port1_mode - LAN port 1 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port1_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port1_ssid - Bridge LAN port 1 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port1_ssid v6.0.0 -> latest
- port2_mode - LAN port 2 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port2_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port2_ssid - Bridge LAN port 2 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port2_ssid v6.0.0 -> latest
- port3_mode - LAN port 3 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port3_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port3_ssid - Bridge LAN port 3 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port3_ssid v6.0.0 -> latest
- port4_mode - LAN port 4 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port4_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port4_ssid - Bridge LAN port 4 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port4_ssid v6.0.0 -> latest
- port5_mode - LAN port 5 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port5_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port5_ssid - Bridge LAN port 5 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port5_ssid v6.0.0 -> latest
- port6_mode - LAN port 6 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port6_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port6_ssid - Bridge LAN port 6 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port6_ssid v6.0.0 -> latest
- port7_mode - LAN port 7 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port7_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port7_ssid - Bridge LAN port 7 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port7_ssid v6.0.0 -> latest
- port8_mode - LAN port 8 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
more...
Supported Version Ranges port8_mode v6.0.0 -> latest
[offline] v6.0.0 -> latest
[nat-to-wan] v6.0.0 -> latest
[bridge-to-wan] v6.0.0 -> latest
[bridge-to-ssid] v6.0.0 -> latest
- port8_ssid - Bridge LAN port 8 to SSID. Source system.interface.name. type: str
more...
Supported Version Ranges port8_ssid v6.0.0 -> latest
- lbs - Set various location based service (LBS) options. type: dict
more...
Supported Version Ranges lbs v6.0.0 -> latest
- aeroscout - Enable/disable AeroScout Real Time Location Service (RTLS) support . type: str choices: enable, disable
more...
Supported Version Ranges aeroscout v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- aeroscout_ap_mac - Use BSSID or board MAC address as AP MAC address in AeroScout AP messages . type: str choices: bssid, board-mac
more...
Supported Version Ranges aeroscout_ap_mac v6.0.0 -> latest
[bssid] v6.0.0 -> latest
[board-mac] v6.0.0 -> latest
- aeroscout_mmu_report - Enable/disable compounded AeroScout tag and MU report . type: str choices: enable, disable
more...
Supported Version Ranges aeroscout_mmu_report v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- aeroscout_mu - Enable/disable AeroScout Mobile Unit (MU) support . type: str choices: enable, disable
more...
Supported Version Ranges aeroscout_mu v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- aeroscout_mu_factor - AeroScout MU mode dilution factor . type: int
more...
Supported Version Ranges aeroscout_mu_factor v6.0.0 -> latest
- aeroscout_mu_timeout - AeroScout MU mode timeout (0 - 65535 sec). type: int
more...
Supported Version Ranges aeroscout_mu_timeout v6.0.0 -> latest
- aeroscout_server_ip - IP address of AeroScout server. type: str
more...
Supported Version Ranges aeroscout_server_ip v6.0.0 -> latest
- aeroscout_server_port - AeroScout server UDP listening port. type: int
more...
Supported Version Ranges aeroscout_server_port v6.0.0 -> latest
- ekahau_blink_mode - Enable/disable Ekahau blink mode (now known as AiRISTA Flow) to track and locate WiFi tags . type: str choices: enable, disable
more...
Supported Version Ranges ekahau_blink_mode v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ekahau_tag - WiFi frame MAC address or WiFi Tag. type: str
more...
Supported Version Ranges ekahau_tag v6.0.0 -> latest
- erc_server_ip - IP address of Ekahau RTLS Controller (ERC). type: str
more...
Supported Version Ranges erc_server_ip v6.0.0 -> latest
- erc_server_port - Ekahau RTLS Controller (ERC) UDP listening port. type: int
more...
Supported Version Ranges erc_server_port v6.0.0 -> latest
- fortipresence - Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they don"t connect to this WiFi network . type: str choices: foreign, both, disable
more...
Supported Version Ranges fortipresence v6.0.0 -> latest
[foreign] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- fortipresence_ble - Enable/disable FortiPresence finding and reporting BLE devices. type: str choices: enable, disable
more...
Supported Version Ranges fortipresence_ble v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- fortipresence_frequency - FortiPresence report transmit frequency (5 - 65535 sec). type: int
more...
Supported Version Ranges fortipresence_frequency v6.0.0 -> latest
- fortipresence_port - UDP listening port of FortiPresence server . type: int
more...
Supported Version Ranges fortipresence_port v6.0.0 -> latest
- fortipresence_project - FortiPresence project name (max. 16 characters). type: str
more...
Supported Version Ranges fortipresence_project v6.0.0 -> latest
- fortipresence_rogue - Enable/disable FortiPresence finding and reporting rogue APs. type: str choices: enable, disable
more...
Supported Version Ranges fortipresence_rogue v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- fortipresence_secret - FortiPresence secret password (max. 16 characters). type: str
more...
Supported Version Ranges fortipresence_secret v6.0.0 -> latest
- fortipresence_server - IP address of FortiPresence server. type: str
more...
Supported Version Ranges fortipresence_server v6.0.0 -> latest
- fortipresence_server_addr_type - FortiPresence server address type . type: str choices: ipv4, fqdn
more...
Supported Version Ranges fortipresence_server_addr_type v7.0.2 -> latest
[ipv4] v6.0.0 -> latest
[fqdn] v6.0.0 -> latest
- fortipresence_server_fqdn - FQDN of FortiPresence server. type: str
more...
Supported Version Ranges fortipresence_server_fqdn v7.0.2 -> latest
- fortipresence_unassoc - Enable/disable FortiPresence finding and reporting unassociated stations. type: str choices: enable, disable
more...
Supported Version Ranges fortipresence_unassoc v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- polestar - Enable/disable PoleStar BLE NAO Track Real Time Location Service (RTLS) support . type: str choices: enable, disable
more...
Supported Version Ranges polestar v7.4.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- polestar_accumulation_interval - Time that measurements should be accumulated in seconds . type: int
more...
Supported Version Ranges polestar_accumulation_interval v7.4.1 -> latest
- polestar_asset_addrgrp_list - Tags and asset addrgrp list to be reported. Source firewall.addrgrp.name. type: str
more...
Supported Version Ranges polestar_asset_addrgrp_list v7.4.1 -> latest
- polestar_asset_uuid_list1 - Tags and asset UUID list 1 to be reported (string in the format of "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"). type: str
more...
Supported Version Ranges polestar_asset_uuid_list1 v7.4.1 -> latest
- polestar_asset_uuid_list2 - Tags and asset UUID list 2 to be reported (string in the format of "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"). type: str
more...
Supported Version Ranges polestar_asset_uuid_list2 v7.4.1 -> latest
- polestar_asset_uuid_list3 - Tags and asset UUID list 3 to be reported (string in the format of "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"). type: str
more...
Supported Version Ranges polestar_asset_uuid_list3 v7.4.1 -> latest
- polestar_asset_uuid_list4 - Tags and asset UUID list 4 to be reported (string in the format of "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"). type: str
more...
Supported Version Ranges polestar_asset_uuid_list4 v7.4.1 -> latest
- polestar_protocol - Select the protocol to report Measurements, Advertising Data, or Location Data to NAO Cloud. . type: str choices: WSS
more...
Supported Version Ranges polestar_protocol v7.4.1 -> latest
[WSS] v6.0.0 -> latest
- polestar_reporting_interval - Time between reporting accumulated measurements in seconds . type: int
more...
Supported Version Ranges polestar_reporting_interval v7.4.1 -> latest
- polestar_server_fqdn - FQDN of PoleStar Nao Track Server . type: str
more...
Supported Version Ranges polestar_server_fqdn v7.4.1 -> latest
- polestar_server_path - Path of PoleStar Nao Track Server . type: str
more...
Supported Version Ranges polestar_server_path v7.4.1 -> latest
- polestar_server_port - Port of PoleStar Nao Track Server . type: int
more...
Supported Version Ranges polestar_server_port v7.4.1 -> latest
- polestar_server_token - Access Token of PoleStar Nao Track Server. type: str
more...
Supported Version Ranges polestar_server_token v7.4.1 -> latest
- station_locate - Enable/disable client station locating services for all clients, whether associated or not . type: str choices: enable, disable
more...
Supported Version Ranges station_locate v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- led_schedules - Recurring firewall schedules for illuminating LEDs on the FortiAP. If led-state is enabled, LEDs will be visible when at least one of the schedules is valid. Separate multiple schedule names with a space. type: list member_path: led_schedules:name
more...
Supported Version Ranges led_schedules v6.0.0 -> latest
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- led_state - Enable/disable use of LEDs on WTP . type: str choices: enable, disable
more...
Supported Version Ranges led_state v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- lldp - Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP . type: str choices: enable, disable
more...
Supported Version Ranges lldp v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- login_passwd - Set the managed WTP, FortiAP, or AP"s administrator password. type: str
more...
Supported Version Ranges login_passwd v6.0.0 -> latest
- login_passwd_change - Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no). type: str choices: yes, default, no
more...
Supported Version Ranges login_passwd_change v6.0.0 -> latest
[yes] v6.0.0 -> latest
[default] v6.0.0 -> latest
[no] v6.0.0 -> latest
- max_clients - Maximum number of stations (STAs) supported by the WTP . type: int
more...
Supported Version Ranges max_clients v6.0.0 -> latest
- name - WTP (or FortiAP or AP) profile name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- platform - WTP, FortiAP, or AP platform. type: dict
more...
Supported Version Ranges platform v6.0.0 -> latest
- ddscan - Enable/disable use of one radio for dedicated full-band scanning to detect RF characterization and wireless threat management. type: str choices: enable, disable
more...
Supported Version Ranges ddscan v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- mode - Configure operation mode of 5G radios . type: str choices: single-5G, dual-5G
more...
Supported Version Ranges mode v6.2.0 -> latest
[single-5G] v6.0.0 -> latest
[dual-5G] v6.0.0 -> latest
- type - WTP, FortiAP or AP platform type. There are built-in WTP profiles for all supported FortiAP models. You can select a built-in profile and customize it or create a new profile. type: str choices: AP-11N, C24JE, 421E, 423E, 221E, 222E, 223E, 224E, 231E, 321E, 431F, 431FL, 432F, 432FR, 433F, 433FL, 231F, 231FL, 234F, 23JF, 831F, 231G, 233G, 234G, 431G, 433G, U421E, U422EV, U423E, U221EV, U223EV, U24JEV, U321EV, U323EV, U431F, U433F, U231F, U234F, U432F, U231G, 220B, 210B, 222B, 112B, 320B, 11C, 14C, 223B, 28C, 320C, 221C, 25D, 222C, 224D, 214B, 21D, 24D, 112D, 223C, 321C, C220C, C225C, C23JD, S321C, S322C, S323C, S311C, S313C, S321CR, S322CR, S323CR, S421E, S422E, S423E, S221E, S223E, U441G
more...
Supported Version Ranges type v6.0.0 -> latest
[AP-11N] v6.0.0 -> latest
[C24JE] v6.0.0 -> latest
[421E] v6.0.0 -> latest
[423E] v6.0.0 -> latest
[221E] v6.0.0 -> latest
[222E] v6.0.0 -> latest
[223E] v6.0.0 -> latest
[224E] v6.0.0 -> latest
[231E] v6.2.0 -> v6.2.0
v6.2.5 -> latest
[321E] v6.2.0 -> latest
[431F] v6.2.0 -> v6.2.0
v6.2.5 -> latest
[431FL] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[432F] v6.2.0 -> v6.2.0
v6.2.5 -> v6.4.0
v6.4.4 -> latest
[432FR] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[433F] v6.2.0 -> v6.2.0
v6.2.5 -> latest
[433FL] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[231F] v6.2.0 -> v6.2.0
v6.2.5 -> v6.4.0
v6.4.4 -> latest
[231FL] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[234F] v6.2.0 -> v6.2.0
v6.2.5 -> v6.4.0
v6.4.4 -> latest
[23JF] v6.2.0 -> v6.2.0
v6.2.5 -> v6.4.0
v6.4.4 -> latest
[831F] v6.4.4 -> latest
[231G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[233G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[234G] v7.4.0 -> latest
[431G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[433G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[U421E] v6.0.0 -> latest
[U422EV] v6.0.0 -> latest
[U423E] v6.0.0 -> latest
[U221EV] v6.0.0 -> latest
[U223EV] v6.0.0 -> latest
[U24JEV] v6.0.0 -> latest
[U321EV] v6.0.0 -> latest
[U323EV] v6.0.0 -> latest
[U431F] v6.2.0 -> latest
[U433F] v6.2.0 -> latest
[U231F] v6.4.4 -> latest
[U234F] v6.4.4 -> latest
[U432F] v6.4.4 -> latest
[U231G] v7.0.8 -> v7.0.12
v7.2.4 -> latest
[220B] v6.0.0 -> v7.2.4
[210B] v6.0.0 -> v7.2.4
[222B] v6.0.0 -> v7.2.4
[112B] v6.0.0 -> v7.2.4
[320B] v6.0.0 -> v7.2.4
[11C] v6.0.0 -> v7.2.4
[14C] v6.0.0 -> v7.2.4
[223B] v6.0.0 -> v7.2.4
[28C] v6.0.0 -> v7.2.4
[320C] v6.0.0 -> v7.2.4
[221C] v6.0.0 -> v7.2.4
[25D] v6.0.0 -> v7.2.4
[222C] v6.0.0 -> v7.2.4
[224D] v6.0.0 -> v7.2.4
[214B] v6.0.0 -> v7.2.4
[21D] v6.0.0 -> v7.2.4
[24D] v6.0.0 -> v7.2.4
[112D] v6.0.0 -> v7.2.4
[223C] v6.0.0 -> v7.2.4
[321C] v6.0.0 -> v7.2.4
[C220C] v6.0.0 -> v7.2.4
[C225C] v6.0.0 -> v7.2.4
[C23JD] v6.0.0 -> v7.2.4
[S321C] v6.0.0 -> v7.2.4
[S322C] v6.0.0 -> v7.2.4
[S323C] v6.0.0 -> v7.2.4
[S311C] v6.0.0 -> v7.2.4
[S313C] v6.0.0 -> v7.2.4
[S321CR] v6.0.0 -> v7.2.4
[S322CR] v6.0.0 -> v7.2.4
[S323CR] v6.0.0 -> v7.2.4
[S421E] v6.0.0 -> v7.2.4
[S422E] v6.0.0 -> v7.2.4
[S423E] v6.0.0 -> v7.2.4
[S221E] v6.0.0 -> v7.2.4
[S223E] v6.0.0 -> v7.2.4
[U441G] v7.0.8 -> v7.0.12
v7.2.4 -> v7.2.4
- poe_mode - Set the WTP, FortiAP, or AP"s PoE mode. type: str choices: auto, 8023af, 8023at, power-adapter, full, high, low
more...
Supported Version Ranges poe_mode v6.0.0 -> latest
[auto] v6.0.0 -> latest
[8023af] v6.0.0 -> latest
[8023at] v6.0.0 -> latest
[power-adapter] v6.0.0 -> latest
[full] v6.4.4 -> latest
[high] v6.4.4 -> latest
[low] v6.4.4 -> latest
- radio_1 - Configuration options for radio 1. type: dict
more...
Supported Version Ranges radio_1 v6.0.0 -> latest
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
Supported Version Ranges airtime_fairness v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- amsdu - Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . type: str choices: enable, disable
more...
Supported Version Ranges amsdu v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
more...
Supported Version Ranges ap_handoff v6.0.0 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_addr - MAC address to monitor. type: str
more...
Supported Version Ranges ap_sniffer_addr v6.0.0 -> latest
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
Supported Version Ranges ap_sniffer_bufsize v6.0.0 -> latest
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
Supported Version Ranges ap_sniffer_chan v6.0.0 -> latest
- ap_sniffer_ctl - Enable/disable sniffer on WiFi control frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_ctl v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_data - Enable/disable sniffer on WiFi data frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_data v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_beacon - Enable/disable sniffer on WiFi management Beacon frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_beacon v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_other - Enable/disable sniffer on WiFi management other frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_other v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_probe - Enable/disable sniffer on WiFi management probe frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_probe v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- arrp_profile - Distributed Automatic Radio Resource Provisioning (DARRP) profile name to assign to the radio. Source wireless-controller .arrp-profile.name. type: str
more...
Supported Version Ranges arrp_profile v7.0.4 -> latest
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_high v6.0.0 -> latest
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
Supported Version Ranges auto_power_level v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_low v6.0.0 -> latest
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
Supported Version Ranges auto_power_target v6.4.4 -> latest
- band - WiFi band that Radio 1 operates on. type: str choices: 802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11ac, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11ax-6G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
Supported Version Ranges band v6.0.0 -> latest
[802.11a] v6.0.0 -> latest
[802.11b] v6.0.0 -> latest
[802.11g] v6.0.0 -> latest
[802.11n] v6.0.0 -> latest
[802.11n-5G] v6.0.0 -> latest
[802.11ac] v6.0.0 -> latest
[802.11ax-5G] v6.2.0 -> latest
[802.11ax] v6.2.0 -> latest
[802.11ac-2G] v6.4.0 -> latest
[802.11ax-6G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[802.11n,g-only] v6.0.0 -> latest
[802.11g-only] v6.0.0 -> latest
[802.11n-only] v6.0.0 -> latest
[802.11n-5G-only] v6.0.0 -> latest
[802.11ac,n-only] v6.0.0 -> latest
[802.11ac-only] v6.0.0 -> latest
[802.11ax,ac-only] v6.2.0 -> latest
[802.11ax,ac,n-only] v6.2.0 -> latest
[802.11ax-5G-only] v6.2.0 -> latest
[802.11ax,n-only] v6.2.0 -> latest
[802.11ax,n,g-only] v6.2.0 -> latest
[802.11ax-only] v6.2.0 -> latest
- band_5g_type - WiFi 5G band type. type: str choices: 5g-full, 5g-high, 5g-low
more...
Supported Version Ranges band_5g_type v6.2.0 -> v6.2.0
v6.2.5 -> latest
[5g-full] v6.0.0 -> latest
[5g-high] v6.0.0 -> latest
[5g-low] v6.0.0 -> latest
- bandwidth_admission_control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. type: str choices: enable, disable
more...
Supported Version Ranges bandwidth_admission_control v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
Supported Version Ranges bandwidth_capacity v6.0.0 -> latest
- beacon_interval - Beacon interval. The time between beacon frames in milliseconds. Actual range of beacon interval depends on the AP platform type . type: int
more...
Supported Version Ranges beacon_interval v6.0.0 -> latest
- bss_color - BSS color value for this 11ax radio (0 - 63, disable = 0). type: int
more...
Supported Version Ranges bss_color v6.4.0 -> v6.4.0
v6.4.4 -> latest
- bss_color_mode - BSS color mode for this 11ax radio . type: str choices: auto, static
more...
Supported Version Ranges bss_color_mode v7.0.2 -> latest
[auto] v6.0.0 -> latest
[static] v6.0.0 -> latest
- call_admission_control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. type: str choices: enable, disable
more...
Supported Version Ranges call_admission_control v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). type: int
more...
Supported Version Ranges call_capacity v6.0.0 -> latest
- channel - Selected list of wireless radio channels. type: list member_path: radio_1/channel:chan
more...
Supported Version Ranges channel v6.0.0 -> latest
- chan - Channel number. type: str required: true
more...
Supported Version Ranges chan v6.0.0 -> latest
- channel_bonding - Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 160MHz, 80MHz, 40MHz, 20MHz
more...
Supported Version Ranges channel_bonding v6.0.0 -> latest
[160MHz] v6.2.0 -> latest
[80MHz] v6.0.0 -> latest
[40MHz] v6.0.0 -> latest
[20MHz] v6.0.0 -> latest
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
Supported Version Ranges channel_utilization v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- coexistence - Enable/disable allowing both HT20 and HT40 on the same radio . type: str choices: enable, disable
more...
Supported Version Ranges coexistence v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . type: str choices: enable, disable
more...
Supported Version Ranges darrp v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
Supported Version Ranges drma v6.4.4 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- drma_sensitivity - Network Coverage Factor (NCF) percentage required to consider a radio as redundant . type: str choices: low, medium, high
more...
Supported Version Ranges drma_sensitivity v6.4.4 -> latest
[low] v6.0.0 -> latest
[medium] v6.0.0 -> latest
[high] v6.0.0 -> latest
- dtim - Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode. type: int
more...
Supported Version Ranges dtim v6.0.0 -> latest
- frag_threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). type: int
more...
Supported Version Ranges frag_threshold v6.0.0 -> latest
- frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
more...
Supported Version Ranges frequency_handoff v6.0.0 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
Supported Version Ranges iperf_protocol v7.0.0 -> latest
[udp] v6.0.0 -> latest
[tcp] v6.0.0 -> latest
- iperf_server_port - Iperf service port number. type: int
more...
Supported Version Ranges iperf_server_port v7.0.0 -> latest
- max_clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. type: int
more...
Supported Version Ranges max_clients v6.0.0 -> latest
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
Supported Version Ranges max_distance v6.0.0 -> latest
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
Supported Version Ranges mimo_mode v7.4.1 -> latest
[default] v6.0.0 -> latest
[1x1] v6.0.0 -> latest
[2x2] v6.0.0 -> latest
[3x3] v6.0.0 -> latest
[4x4] v6.0.0 -> latest
[8x8] v6.0.0 -> latest
- mode - Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, a sniffer, or a station. type: str choices: disabled, ap, monitor, sniffer, sam
more...
Supported Version Ranges mode v6.0.0 -> latest
[disabled] v6.0.0 -> latest
[ap] v6.0.0 -> latest
[monitor] v6.0.0 -> latest
[sniffer] v6.0.0 -> latest
[sam] v7.0.0 -> latest
- optional_antenna - Optional antenna used on FAP . type: str choices: none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R
more...
Supported Version Ranges optional_antenna v7.4.0 -> latest
[none] v6.0.0 -> latest
[FANT-04ABGN-0606-O-N] v6.0.0 -> latest
[FANT-04ABGN-1414-P-N] v6.0.0 -> latest
[FANT-04ABGN-8065-P-N] v6.0.0 -> latest
[FANT-04ABGN-0606-O-R] v6.0.0 -> latest
[FANT-04ABGN-0606-P-R] v6.0.0 -> latest
[FANT-10ACAX-1213-D-N] v6.0.0 -> latest
[FANT-08ABGN-1213-D-R] v6.0.0 -> latest
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
Supported Version Ranges power_level v6.0.0 -> latest
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
Supported Version Ranges power_mode v7.0.0 -> latest
[dBm] v6.0.0 -> latest
[percentage] v6.0.0 -> latest
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
Supported Version Ranges power_value v7.0.0 -> latest
- powersave_optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: list choices: tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow
more...
Supported Version Ranges powersave_optimize v6.0.0 -> latest
[tim] v6.0.0 -> latest
[ac-vo] v6.0.0 -> latest
[no-obss-scan] v6.0.0 -> latest
[no-11b-rate] v6.0.0 -> latest
[client-rate-follow] v6.0.0 -> latest
- protection_mode - Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). type: str choices: rtscts, ctsonly, disable
more...
Supported Version Ranges protection_mode v6.0.0 -> latest
[rtscts] v6.0.0 -> latest
[ctsonly] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- radio_id - radio-id type: int
more...
Supported Version Ranges radio_id v6.0.0 -> v6.0.11
v6.2.3 -> v6.2.3
- rts_threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). type: int
more...
Supported Version Ranges rts_threshold v6.0.0 -> latest
- sam_bssid - BSSID for WiFi network. type: str
more...
Supported Version Ranges sam_bssid v7.0.0 -> latest
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
Supported Version Ranges sam_captive_portal v7.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- sam_cwp_failure_string - Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges sam_cwp_failure_string v7.0.1 -> latest
- sam_cwp_match_string - Identification string from the captive portal login form. type: str
more...
Supported Version Ranges sam_cwp_match_string v7.0.1 -> latest
- sam_cwp_password - Password for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_password v7.0.1 -> latest
- sam_cwp_success_string - Success identification on the page after a successful login. type: str
more...
Supported Version Ranges sam_cwp_success_string v7.0.1 -> latest
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
Supported Version Ranges sam_cwp_test_url v7.0.1 -> latest
- sam_cwp_username - Username for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_username v7.0.1 -> latest
- sam_password - Passphrase for WiFi network connection. type: str
more...
Supported Version Ranges sam_password v7.0.0 -> latest
- sam_report_intv - SAM report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges sam_report_intv v7.0.0 -> latest
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise
more...
Supported Version Ranges sam_security_type v7.0.0 -> latest
[open] v6.0.0 -> latest
[wpa-personal] v6.0.0 -> latest
[wpa-enterprise] v6.0.0 -> latest
- sam_server - SAM test server IP address or domain name. type: str
more...
Supported Version Ranges sam_server v7.0.0 -> v7.0.0
- sam_server_fqdn - SAM test server domain name. type: str
more...
Supported Version Ranges sam_server_fqdn v7.0.1 -> latest
- sam_server_ip - SAM test server IP address. type: str
more...
Supported Version Ranges sam_server_ip v7.0.1 -> latest
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
Supported Version Ranges sam_server_type v7.0.1 -> latest
[ip] v6.0.0 -> latest
[fqdn] v6.0.0 -> latest
- sam_ssid - SSID for WiFi network. type: str
more...
Supported Version Ranges sam_ssid v7.0.0 -> latest
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
Supported Version Ranges sam_test v7.0.0 -> latest
[ping] v6.0.0 -> latest
[iperf] v6.0.0 -> latest
- sam_username - Username for WiFi network connection. type: str
more...
Supported Version Ranges sam_username v7.0.0 -> latest
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
Supported Version Ranges set_80211d v7.2.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- short_guard_interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: enable, disable
more...
Supported Version Ranges short_guard_interval v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
Supported Version Ranges spectrum_analysis v6.0.0 -> v6.2.7
v6.4.1 -> v6.4.1
[enable] v6.0.0 -> latest
[scan-only] v6.4.1 -> v6.4.1
[disable] v6.0.0 -> latest
- transmit_optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. type: list choices: disable, power-save, aggr-limit, retry-limit, send-bar
more...
Supported Version Ranges transmit_optimize v6.0.0 -> latest
[disable] v6.0.0 -> latest
[power-save] v6.0.0 -> latest
[aggr-limit] v6.0.0 -> latest
[retry-limit] v6.0.0 -> latest
[send-bar] v6.0.0 -> latest
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
Supported Version Ranges vap_all v6.0.0 -> latest
[tunnel] v6.4.0 -> latest
[bridge] v6.4.0 -> latest
[manual] v6.4.0 -> latest
[enable] v6.0.0 -> v6.2.7
[disable] v6.0.0 -> v6.2.7
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_1/vaps:name
more...
Supported Version Ranges vaps v6.0.0 -> latest
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- wids_profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. type: str
more...
Supported Version Ranges wids_profile v6.0.0 -> latest
- zero_wait_dfs - Enable/disable zero wait DFS on radio . type: str choices: enable, disable
more...
Supported Version Ranges zero_wait_dfs v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- radio_2 - Configuration options for radio 2. type: dict
more...
Supported Version Ranges radio_2 v6.0.0 -> latest
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
Supported Version Ranges airtime_fairness v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- amsdu - Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . type: str choices: enable, disable
more...
Supported Version Ranges amsdu v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
more...
Supported Version Ranges ap_handoff v6.0.0 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_addr - MAC address to monitor. type: str
more...
Supported Version Ranges ap_sniffer_addr v6.0.0 -> latest
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
Supported Version Ranges ap_sniffer_bufsize v6.0.0 -> latest
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
Supported Version Ranges ap_sniffer_chan v6.0.0 -> latest
- ap_sniffer_ctl - Enable/disable sniffer on WiFi control frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_ctl v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_data - Enable/disable sniffer on WiFi data frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_data v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_beacon - Enable/disable sniffer on WiFi management Beacon frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_beacon v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_other - Enable/disable sniffer on WiFi management other frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_other v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_probe - Enable/disable sniffer on WiFi management probe frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_probe v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- arrp_profile - Distributed Automatic Radio Resource Provisioning (DARRP) profile name to assign to the radio. Source wireless-controller .arrp-profile.name. type: str
more...
Supported Version Ranges arrp_profile v7.0.4 -> latest
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_high v6.0.0 -> latest
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
Supported Version Ranges auto_power_level v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_low v6.0.0 -> latest
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
Supported Version Ranges auto_power_target v6.4.4 -> latest
- band - WiFi band that Radio 2 operates on. type: str choices: 802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11ac, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11ax-6G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
Supported Version Ranges band v6.0.0 -> latest
[802.11a] v6.0.0 -> latest
[802.11b] v6.0.0 -> latest
[802.11g] v6.0.0 -> latest
[802.11n] v6.0.0 -> latest
[802.11n-5G] v6.0.0 -> latest
[802.11ac] v6.0.0 -> latest
[802.11ax-5G] v6.2.0 -> latest
[802.11ax] v6.2.0 -> latest
[802.11ac-2G] v6.4.0 -> latest
[802.11ax-6G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[802.11n,g-only] v6.0.0 -> latest
[802.11g-only] v6.0.0 -> latest
[802.11n-only] v6.0.0 -> latest
[802.11n-5G-only] v6.0.0 -> latest
[802.11ac,n-only] v6.0.0 -> latest
[802.11ac-only] v6.0.0 -> latest
[802.11ax,ac-only] v6.2.0 -> latest
[802.11ax,ac,n-only] v6.2.0 -> latest
[802.11ax-5G-only] v6.2.0 -> latest
[802.11ax,n-only] v6.2.0 -> latest
[802.11ax,n,g-only] v6.2.0 -> latest
[802.11ax-only] v6.2.0 -> latest
- band_5g_type - WiFi 5G band type. type: str choices: 5g-full, 5g-high, 5g-low
more...
Supported Version Ranges band_5g_type v6.2.0 -> v6.2.0
v6.2.5 -> latest
[5g-full] v6.0.0 -> latest
[5g-high] v6.0.0 -> latest
[5g-low] v6.0.0 -> latest
- bandwidth_admission_control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. type: str choices: enable, disable
more...
Supported Version Ranges bandwidth_admission_control v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
Supported Version Ranges bandwidth_capacity v6.0.0 -> latest
- beacon_interval - Beacon interval. The time between beacon frames in milliseconds. Actual range of beacon interval depends on the AP platform type . type: int
more...
Supported Version Ranges beacon_interval v6.0.0 -> latest
- bss_color - BSS color value for this 11ax radio (0 - 63, disable = 0). type: int
more...
Supported Version Ranges bss_color v6.4.0 -> v6.4.0
v6.4.4 -> latest
- bss_color_mode - BSS color mode for this 11ax radio . type: str choices: auto, static
more...
Supported Version Ranges bss_color_mode v7.0.2 -> latest
[auto] v6.0.0 -> latest
[static] v6.0.0 -> latest
- call_admission_control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. type: str choices: enable, disable
more...
Supported Version Ranges call_admission_control v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). type: int
more...
Supported Version Ranges call_capacity v6.0.0 -> latest
- channel - Selected list of wireless radio channels. type: list member_path: radio_2/channel:chan
more...
Supported Version Ranges channel v6.0.0 -> latest
- chan - Channel number. type: str required: true
more...
Supported Version Ranges chan v6.0.0 -> latest
- channel_bonding - Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 160MHz, 80MHz, 40MHz, 20MHz
more...
Supported Version Ranges channel_bonding v6.0.0 -> latest
[160MHz] v6.2.0 -> latest
[80MHz] v6.0.0 -> latest
[40MHz] v6.0.0 -> latest
[20MHz] v6.0.0 -> latest
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
Supported Version Ranges channel_utilization v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- coexistence - Enable/disable allowing both HT20 and HT40 on the same radio . type: str choices: enable, disable
more...
Supported Version Ranges coexistence v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . type: str choices: enable, disable
more...
Supported Version Ranges darrp v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
Supported Version Ranges drma v6.4.4 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- drma_sensitivity - Network Coverage Factor (NCF) percentage required to consider a radio as redundant . type: str choices: low, medium, high
more...
Supported Version Ranges drma_sensitivity v6.4.4 -> latest
[low] v6.0.0 -> latest
[medium] v6.0.0 -> latest
[high] v6.0.0 -> latest
- dtim - Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode. type: int
more...
Supported Version Ranges dtim v6.0.0 -> latest
- frag_threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). type: int
more...
Supported Version Ranges frag_threshold v6.0.0 -> latest
- frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
more...
Supported Version Ranges frequency_handoff v6.0.0 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
Supported Version Ranges iperf_protocol v7.0.0 -> latest
[udp] v6.0.0 -> latest
[tcp] v6.0.0 -> latest
- iperf_server_port - Iperf service port number. type: int
more...
Supported Version Ranges iperf_server_port v7.0.0 -> latest
- max_clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. type: int
more...
Supported Version Ranges max_clients v6.0.0 -> latest
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
Supported Version Ranges max_distance v6.0.0 -> latest
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
Supported Version Ranges mimo_mode v7.4.1 -> latest
[default] v6.0.0 -> latest
[1x1] v6.0.0 -> latest
[2x2] v6.0.0 -> latest
[3x3] v6.0.0 -> latest
[4x4] v6.0.0 -> latest
[8x8] v6.0.0 -> latest
- mode - Mode of radio 2. Radio 2 can be disabled, configured as an access point, a rogue AP monitor, a sniffer, or a station. type: str choices: disabled, ap, monitor, sniffer, sam
more...
Supported Version Ranges mode v6.0.0 -> latest
[disabled] v6.0.0 -> latest
[ap] v6.0.0 -> latest
[monitor] v6.0.0 -> latest
[sniffer] v6.0.0 -> latest
[sam] v7.0.0 -> latest
- optional_antenna - Optional antenna used on FAP . type: str choices: none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R
more...
Supported Version Ranges optional_antenna v7.4.0 -> latest
[none] v6.0.0 -> latest
[FANT-04ABGN-0606-O-N] v6.0.0 -> latest
[FANT-04ABGN-1414-P-N] v6.0.0 -> latest
[FANT-04ABGN-8065-P-N] v6.0.0 -> latest
[FANT-04ABGN-0606-O-R] v6.0.0 -> latest
[FANT-04ABGN-0606-P-R] v6.0.0 -> latest
[FANT-10ACAX-1213-D-N] v6.0.0 -> latest
[FANT-08ABGN-1213-D-R] v6.0.0 -> latest
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
Supported Version Ranges power_level v6.0.0 -> latest
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
Supported Version Ranges power_mode v7.0.0 -> latest
[dBm] v6.0.0 -> latest
[percentage] v6.0.0 -> latest
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
Supported Version Ranges power_value v7.0.0 -> latest
- powersave_optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: list choices: tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow
more...
Supported Version Ranges powersave_optimize v6.0.0 -> latest
[tim] v6.0.0 -> latest
[ac-vo] v6.0.0 -> latest
[no-obss-scan] v6.0.0 -> latest
[no-11b-rate] v6.0.0 -> latest
[client-rate-follow] v6.0.0 -> latest
- protection_mode - Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). type: str choices: rtscts, ctsonly, disable
more...
Supported Version Ranges protection_mode v6.0.0 -> latest
[rtscts] v6.0.0 -> latest
[ctsonly] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- radio_id - radio-id type: int
more...
Supported Version Ranges radio_id v6.0.0 -> v6.0.11
v6.2.3 -> v6.2.3
- rts_threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). type: int
more...
Supported Version Ranges rts_threshold v6.0.0 -> latest
- sam_bssid - BSSID for WiFi network. type: str
more...
Supported Version Ranges sam_bssid v7.0.0 -> latest
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
Supported Version Ranges sam_captive_portal v7.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- sam_cwp_failure_string - Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges sam_cwp_failure_string v7.0.1 -> latest
- sam_cwp_match_string - Identification string from the captive portal login form. type: str
more...
Supported Version Ranges sam_cwp_match_string v7.0.1 -> latest
- sam_cwp_password - Password for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_password v7.0.1 -> latest
- sam_cwp_success_string - Success identification on the page after a successful login. type: str
more...
Supported Version Ranges sam_cwp_success_string v7.0.1 -> latest
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
Supported Version Ranges sam_cwp_test_url v7.0.1 -> latest
- sam_cwp_username - Username for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_username v7.0.1 -> latest
- sam_password - Passphrase for WiFi network connection. type: str
more...
Supported Version Ranges sam_password v7.0.0 -> latest
- sam_report_intv - SAM report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges sam_report_intv v7.0.0 -> latest
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise
more...
Supported Version Ranges sam_security_type v7.0.0 -> latest
[open] v6.0.0 -> latest
[wpa-personal] v6.0.0 -> latest
[wpa-enterprise] v6.0.0 -> latest
- sam_server - SAM test server IP address or domain name. type: str
more...
Supported Version Ranges sam_server v7.0.0 -> v7.0.0
- sam_server_fqdn - SAM test server domain name. type: str
more...
Supported Version Ranges sam_server_fqdn v7.0.1 -> latest
- sam_server_ip - SAM test server IP address. type: str
more...
Supported Version Ranges sam_server_ip v7.0.1 -> latest
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
Supported Version Ranges sam_server_type v7.0.1 -> latest
[ip] v6.0.0 -> latest
[fqdn] v6.0.0 -> latest
- sam_ssid - SSID for WiFi network. type: str
more...
Supported Version Ranges sam_ssid v7.0.0 -> latest
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
Supported Version Ranges sam_test v7.0.0 -> latest
[ping] v6.0.0 -> latest
[iperf] v6.0.0 -> latest
- sam_username - Username for WiFi network connection. type: str
more...
Supported Version Ranges sam_username v7.0.0 -> latest
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
Supported Version Ranges set_80211d v7.2.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- short_guard_interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: enable, disable
more...
Supported Version Ranges short_guard_interval v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
Supported Version Ranges spectrum_analysis v6.0.0 -> v6.2.7
v6.4.1 -> v6.4.1
[enable] v6.0.0 -> latest
[scan-only] v6.4.1 -> v6.4.1
[disable] v6.0.0 -> latest
- transmit_optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. type: list choices: disable, power-save, aggr-limit, retry-limit, send-bar
more...
Supported Version Ranges transmit_optimize v6.0.0 -> latest
[disable] v6.0.0 -> latest
[power-save] v6.0.0 -> latest
[aggr-limit] v6.0.0 -> latest
[retry-limit] v6.0.0 -> latest
[send-bar] v6.0.0 -> latest
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
Supported Version Ranges vap_all v6.0.0 -> latest
[tunnel] v6.4.0 -> latest
[bridge] v6.4.0 -> latest
[manual] v6.4.0 -> latest
[enable] v6.0.0 -> v6.2.7
[disable] v6.0.0 -> v6.2.7
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_2/vaps:name
more...
Supported Version Ranges vaps v6.0.0 -> latest
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- wids_profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. type: str
more...
Supported Version Ranges wids_profile v6.0.0 -> latest
- zero_wait_dfs - Enable/disable zero wait DFS on radio . type: str choices: enable, disable
more...
Supported Version Ranges zero_wait_dfs v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- radio_3 - Configuration options for radio 3. type: dict
more...
Supported Version Ranges radio_3 v6.2.0 -> latest
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
Supported Version Ranges airtime_fairness v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- amsdu - Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . type: str choices: enable, disable
more...
Supported Version Ranges amsdu v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
more...
Supported Version Ranges ap_handoff v6.2.0 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_addr - MAC address to monitor. type: str
more...
Supported Version Ranges ap_sniffer_addr v6.2.0 -> latest
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
Supported Version Ranges ap_sniffer_bufsize v6.2.0 -> latest
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
Supported Version Ranges ap_sniffer_chan v6.2.0 -> latest
- ap_sniffer_ctl - Enable/disable sniffer on WiFi control frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_ctl v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_data - Enable/disable sniffer on WiFi data frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_data v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_beacon - Enable/disable sniffer on WiFi management Beacon frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_beacon v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_other - Enable/disable sniffer on WiFi management other frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_other v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_probe - Enable/disable sniffer on WiFi management probe frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_probe v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- arrp_profile - Distributed Automatic Radio Resource Provisioning (DARRP) profile name to assign to the radio. Source wireless-controller .arrp-profile.name. type: str
more...
Supported Version Ranges arrp_profile v7.0.4 -> latest
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_high v6.2.0 -> latest
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
Supported Version Ranges auto_power_level v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_low v6.2.0 -> latest
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
Supported Version Ranges auto_power_target v6.4.4 -> latest
- band - WiFi band that Radio 3 operates on. type: str choices: 802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11ac, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11ax-6G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
Supported Version Ranges band v6.2.0 -> latest
[802.11a] v6.0.0 -> latest
[802.11b] v6.0.0 -> latest
[802.11g] v6.0.0 -> latest
[802.11n] v6.0.0 -> latest
[802.11n-5G] v6.0.0 -> latest
[802.11ac] v6.0.0 -> latest
[802.11ax-5G] v6.0.0 -> latest
[802.11ax] v6.0.0 -> latest
[802.11ac-2G] v6.4.0 -> latest
[802.11ax-6G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[802.11n,g-only] v6.0.0 -> latest
[802.11g-only] v6.0.0 -> latest
[802.11n-only] v6.0.0 -> latest
[802.11n-5G-only] v6.0.0 -> latest
[802.11ac,n-only] v6.0.0 -> latest
[802.11ac-only] v6.0.0 -> latest
[802.11ax,ac-only] v6.0.0 -> latest
[802.11ax,ac,n-only] v6.0.0 -> latest
[802.11ax-5G-only] v6.0.0 -> latest
[802.11ax,n-only] v6.0.0 -> latest
[802.11ax,n,g-only] v6.0.0 -> latest
[802.11ax-only] v6.0.0 -> latest
- band_5g_type - WiFi 5G band type. type: str choices: 5g-full, 5g-high, 5g-low
more...
Supported Version Ranges band_5g_type v6.2.0 -> v6.2.0
v6.2.5 -> latest
[5g-full] v6.0.0 -> latest
[5g-high] v6.0.0 -> latest
[5g-low] v6.0.0 -> latest
- bandwidth_admission_control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. type: str choices: enable, disable
more...
Supported Version Ranges bandwidth_admission_control v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
Supported Version Ranges bandwidth_capacity v6.2.0 -> latest
- beacon_interval - Beacon interval. The time between beacon frames in milliseconds. Actual range of beacon interval depends on the AP platform type . type: int
more...
Supported Version Ranges beacon_interval v6.2.0 -> latest
- bss_color - BSS color value for this 11ax radio (0 - 63, disable = 0). type: int
more...
Supported Version Ranges bss_color v6.4.0 -> v6.4.0
v6.4.4 -> latest
- bss_color_mode - BSS color mode for this 11ax radio . type: str choices: auto, static
more...
Supported Version Ranges bss_color_mode v7.0.2 -> latest
[auto] v6.0.0 -> latest
[static] v6.0.0 -> latest
- call_admission_control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. type: str choices: enable, disable
more...
Supported Version Ranges call_admission_control v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). type: int
more...
Supported Version Ranges call_capacity v6.2.0 -> latest
- channel - Selected list of wireless radio channels. type: list member_path: radio_3/channel:chan
more...
Supported Version Ranges channel v6.2.0 -> latest
- chan - Channel number. type: str required: true
more...
Supported Version Ranges chan v6.2.0 -> latest
- channel_bonding - Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 160MHz, 80MHz, 40MHz, 20MHz
more...
Supported Version Ranges channel_bonding v6.2.0 -> latest
[160MHz] v6.0.0 -> latest
[80MHz] v6.0.0 -> latest
[40MHz] v6.0.0 -> latest
[20MHz] v6.0.0 -> latest
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
Supported Version Ranges channel_utilization v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- coexistence - Enable/disable allowing both HT20 and HT40 on the same radio . type: str choices: enable, disable
more...
Supported Version Ranges coexistence v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . type: str choices: enable, disable
more...
Supported Version Ranges darrp v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
Supported Version Ranges drma v6.4.4 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- drma_sensitivity - Network Coverage Factor (NCF) percentage required to consider a radio as redundant . type: str choices: low, medium, high
more...
Supported Version Ranges drma_sensitivity v6.4.4 -> latest
[low] v6.0.0 -> latest
[medium] v6.0.0 -> latest
[high] v6.0.0 -> latest
- dtim - Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode. type: int
more...
Supported Version Ranges dtim v6.2.0 -> latest
- frag_threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). type: int
more...
Supported Version Ranges frag_threshold v6.2.0 -> latest
- frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
more...
Supported Version Ranges frequency_handoff v6.2.0 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
Supported Version Ranges iperf_protocol v7.0.0 -> latest
[udp] v6.0.0 -> latest
[tcp] v6.0.0 -> latest
- iperf_server_port - Iperf service port number. type: int
more...
Supported Version Ranges iperf_server_port v7.0.0 -> latest
- max_clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. type: int
more...
Supported Version Ranges max_clients v6.2.0 -> latest
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
Supported Version Ranges max_distance v6.2.0 -> latest
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
Supported Version Ranges mimo_mode v7.4.1 -> latest
[default] v6.0.0 -> latest
[1x1] v6.0.0 -> latest
[2x2] v6.0.0 -> latest
[3x3] v6.0.0 -> latest
[4x4] v6.0.0 -> latest
[8x8] v6.0.0 -> latest
- mode - Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, a sniffer, or a station. type: str choices: disabled, ap, monitor, sniffer, sam
more...
Supported Version Ranges mode v6.2.0 -> latest
[disabled] v6.0.0 -> latest
[ap] v6.0.0 -> latest
[monitor] v6.0.0 -> latest
[sniffer] v6.0.0 -> latest
[sam] v7.0.0 -> latest
- optional_antenna - Optional antenna used on FAP . type: str choices: none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R
more...
Supported Version Ranges optional_antenna v7.4.0 -> latest
[none] v6.0.0 -> latest
[FANT-04ABGN-0606-O-N] v6.0.0 -> latest
[FANT-04ABGN-1414-P-N] v6.0.0 -> latest
[FANT-04ABGN-8065-P-N] v6.0.0 -> latest
[FANT-04ABGN-0606-O-R] v6.0.0 -> latest
[FANT-04ABGN-0606-P-R] v6.0.0 -> latest
[FANT-10ACAX-1213-D-N] v6.0.0 -> latest
[FANT-08ABGN-1213-D-R] v6.0.0 -> latest
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
Supported Version Ranges power_level v6.2.0 -> latest
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
Supported Version Ranges power_mode v7.0.0 -> latest
[dBm] v6.0.0 -> latest
[percentage] v6.0.0 -> latest
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
Supported Version Ranges power_value v7.0.0 -> latest
- powersave_optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: list choices: tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow
more...
Supported Version Ranges powersave_optimize v6.2.0 -> latest
[tim] v6.0.0 -> latest
[ac-vo] v6.0.0 -> latest
[no-obss-scan] v6.0.0 -> latest
[no-11b-rate] v6.0.0 -> latest
[client-rate-follow] v6.0.0 -> latest
- protection_mode - Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). type: str choices: rtscts, ctsonly, disable
more...
Supported Version Ranges protection_mode v6.2.0 -> latest
[rtscts] v6.0.0 -> latest
[ctsonly] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- radio_id - radio-id type: int
more...
Supported Version Ranges radio_id v6.2.3 -> v6.2.3
- rts_threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). type: int
more...
Supported Version Ranges rts_threshold v6.2.0 -> latest
- sam_bssid - BSSID for WiFi network. type: str
more...
Supported Version Ranges sam_bssid v7.0.0 -> latest
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
Supported Version Ranges sam_captive_portal v7.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- sam_cwp_failure_string - Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges sam_cwp_failure_string v7.0.1 -> latest
- sam_cwp_match_string - Identification string from the captive portal login form. type: str
more...
Supported Version Ranges sam_cwp_match_string v7.0.1 -> latest
- sam_cwp_password - Password for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_password v7.0.1 -> latest
- sam_cwp_success_string - Success identification on the page after a successful login. type: str
more...
Supported Version Ranges sam_cwp_success_string v7.0.1 -> latest
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
Supported Version Ranges sam_cwp_test_url v7.0.1 -> latest
- sam_cwp_username - Username for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_username v7.0.1 -> latest
- sam_password - Passphrase for WiFi network connection. type: str
more...
Supported Version Ranges sam_password v7.0.0 -> latest
- sam_report_intv - SAM report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges sam_report_intv v7.0.0 -> latest
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise
more...
Supported Version Ranges sam_security_type v7.0.0 -> latest
[open] v6.0.0 -> latest
[wpa-personal] v6.0.0 -> latest
[wpa-enterprise] v6.0.0 -> latest
- sam_server - SAM test server IP address or domain name. type: str
more...
Supported Version Ranges sam_server v7.0.0 -> v7.0.0
- sam_server_fqdn - SAM test server domain name. type: str
more...
Supported Version Ranges sam_server_fqdn v7.0.1 -> latest
- sam_server_ip - SAM test server IP address. type: str
more...
Supported Version Ranges sam_server_ip v7.0.1 -> latest
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
Supported Version Ranges sam_server_type v7.0.1 -> latest
[ip] v6.0.0 -> latest
[fqdn] v6.0.0 -> latest
- sam_ssid - SSID for WiFi network. type: str
more...
Supported Version Ranges sam_ssid v7.0.0 -> latest
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
Supported Version Ranges sam_test v7.0.0 -> latest
[ping] v6.0.0 -> latest
[iperf] v6.0.0 -> latest
- sam_username - Username for WiFi network connection. type: str
more...
Supported Version Ranges sam_username v7.0.0 -> latest
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
Supported Version Ranges set_80211d v7.2.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- short_guard_interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: enable, disable
more...
Supported Version Ranges short_guard_interval v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
Supported Version Ranges spectrum_analysis v6.2.0 -> v6.2.7
v6.4.1 -> v6.4.1
[enable] v6.0.0 -> latest
[scan-only] v6.4.1 -> v6.4.1
[disable] v6.0.0 -> latest
- transmit_optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. type: list choices: disable, power-save, aggr-limit, retry-limit, send-bar
more...
Supported Version Ranges transmit_optimize v6.2.0 -> latest
[disable] v6.0.0 -> latest
[power-save] v6.0.0 -> latest
[aggr-limit] v6.0.0 -> latest
[retry-limit] v6.0.0 -> latest
[send-bar] v6.0.0 -> latest
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
Supported Version Ranges vap_all v6.2.0 -> latest
[tunnel] v6.4.0 -> latest
[bridge] v6.4.0 -> latest
[manual] v6.4.0 -> latest
[enable] v6.2.0 -> v6.2.7
[disable] v6.2.0 -> v6.2.7
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_3/vaps:name
more...
Supported Version Ranges vaps v6.2.0 -> latest
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
Supported Version Ranges name v6.2.0 -> latest
- wids_profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. type: str
more...
Supported Version Ranges wids_profile v6.2.0 -> latest
- zero_wait_dfs - Enable/disable zero wait DFS on radio . type: str choices: enable, disable
more...
Supported Version Ranges zero_wait_dfs v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- radio_4 - Configuration options for radio 4. type: dict
more...
Supported Version Ranges radio_4 v6.2.0 -> v6.2.0
v6.2.5 -> latest
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
Supported Version Ranges airtime_fairness v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- amsdu - Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . type: str choices: enable, disable
more...
Supported Version Ranges amsdu v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
more...
Supported Version Ranges ap_handoff v6.2.0 -> v6.2.0
v6.2.5 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_addr - MAC address to monitor. type: str
more...
Supported Version Ranges ap_sniffer_addr v6.2.0 -> v6.2.0
v6.2.5 -> latest
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
Supported Version Ranges ap_sniffer_bufsize v6.2.0 -> v6.2.0
v6.2.5 -> latest
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
Supported Version Ranges ap_sniffer_chan v6.2.0 -> v6.2.0
v6.2.5 -> latest
- ap_sniffer_ctl - Enable/disable sniffer on WiFi control frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_ctl v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_data - Enable/disable sniffer on WiFi data frame . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_data v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_beacon - Enable/disable sniffer on WiFi management Beacon frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_beacon v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_other - Enable/disable sniffer on WiFi management other frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_other v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ap_sniffer_mgmt_probe - Enable/disable sniffer on WiFi management probe frames . type: str choices: enable, disable
more...
Supported Version Ranges ap_sniffer_mgmt_probe v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- arrp_profile - Distributed Automatic Radio Resource Provisioning (DARRP) profile name to assign to the radio. Source wireless-controller .arrp-profile.name. type: str
more...
Supported Version Ranges arrp_profile v7.0.4 -> latest
- auto_power_high - The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_high v6.2.0 -> v6.2.0
v6.2.5 -> latest
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
more...
Supported Version Ranges auto_power_level v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- auto_power_low - The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). type: int
more...
Supported Version Ranges auto_power_low v6.2.0 -> v6.2.0
v6.2.5 -> latest
- auto_power_target - Target of automatic transmit power adjustment in dBm (-95 to -20). type: str
more...
Supported Version Ranges auto_power_target v6.4.4 -> latest
- band - WiFi band that Radio 3 operates on. type: str choices: 802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11ac, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11ax-6G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac,n-only, 802.11ac-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only
more...
Supported Version Ranges band v6.2.0 -> v6.2.0
v6.2.5 -> latest
[802.11a] v6.0.0 -> latest
[802.11b] v6.0.0 -> latest
[802.11g] v6.0.0 -> latest
[802.11n] v6.0.0 -> latest
[802.11n-5G] v6.0.0 -> latest
[802.11ac] v6.0.0 -> latest
[802.11ax-5G] v6.0.0 -> latest
[802.11ax] v6.0.0 -> latest
[802.11ac-2G] v6.4.0 -> latest
[802.11ax-6G] v7.0.8 -> v7.0.12
v7.2.1 -> latest
[802.11n,g-only] v6.0.0 -> latest
[802.11g-only] v6.0.0 -> latest
[802.11n-only] v6.0.0 -> latest
[802.11n-5G-only] v6.0.0 -> latest
[802.11ac,n-only] v6.0.0 -> latest
[802.11ac-only] v6.0.0 -> latest
[802.11ax,ac-only] v6.0.0 -> latest
[802.11ax,ac,n-only] v6.0.0 -> latest
[802.11ax-5G-only] v6.0.0 -> latest
[802.11ax,n-only] v6.0.0 -> latest
[802.11ax,n,g-only] v6.0.0 -> latest
[802.11ax-only] v6.0.0 -> latest
- band_5g_type - WiFi 5G band type. type: str choices: 5g-full, 5g-high, 5g-low
more...
Supported Version Ranges band_5g_type v6.2.0 -> v6.2.0
v6.2.5 -> latest
[5g-full] v6.0.0 -> latest
[5g-high] v6.0.0 -> latest
[5g-low] v6.0.0 -> latest
- bandwidth_admission_control - Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it. type: str choices: enable, disable
more...
Supported Version Ranges bandwidth_admission_control v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
Supported Version Ranges bandwidth_capacity v6.2.0 -> v6.2.0
v6.2.5 -> latest
- beacon_interval - Beacon interval. The time between beacon frames in milliseconds. Actual range of beacon interval depends on the AP platform type . type: int
more...
Supported Version Ranges beacon_interval v6.2.0 -> v6.2.0
v6.2.5 -> latest
- bss_color - BSS color value for this 11ax radio (0 - 63, disable = 0). type: int
more...
Supported Version Ranges bss_color v6.4.0 -> v6.4.0
v6.4.4 -> latest
- bss_color_mode - BSS color mode for this 11ax radio . type: str choices: auto, static
more...
Supported Version Ranges bss_color_mode v7.0.2 -> latest
[auto] v6.0.0 -> latest
[static] v6.0.0 -> latest
- call_admission_control - Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them. type: str choices: enable, disable
more...
Supported Version Ranges call_admission_control v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). type: int
more...
Supported Version Ranges call_capacity v6.2.0 -> v6.2.0
v6.2.5 -> latest
- channel - Selected list of wireless radio channels. type: list member_path: radio_4/channel:chan
more...
Supported Version Ranges channel v6.2.0 -> v6.2.0
v6.2.5 -> latest
- chan - Channel number. type: str required: true
more...
Supported Version Ranges chan v6.2.0 -> v6.2.0
v6.2.5 -> latest
- channel_bonding - Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 160MHz, 80MHz, 40MHz, 20MHz
more...
Supported Version Ranges channel_bonding v6.2.0 -> v6.2.0
v6.2.5 -> latest
[160MHz] v6.0.0 -> latest
[80MHz] v6.0.0 -> latest
[40MHz] v6.0.0 -> latest
[20MHz] v6.0.0 -> latest
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
Supported Version Ranges channel_utilization v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- coexistence - Enable/disable allowing both HT20 and HT40 on the same radio . type: str choices: enable, disable
more...
Supported Version Ranges coexistence v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . type: str choices: enable, disable
more...
Supported Version Ranges darrp v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
Supported Version Ranges drma v6.4.4 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- drma_sensitivity - Network Coverage Factor (NCF) percentage required to consider a radio as redundant . type: str choices: low, medium, high
more...
Supported Version Ranges drma_sensitivity v6.4.4 -> latest
[low] v6.0.0 -> latest
[medium] v6.0.0 -> latest
[high] v6.0.0 -> latest
- dtim - Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode. type: int
more...
Supported Version Ranges dtim v6.2.0 -> v6.2.0
v6.2.5 -> latest
- frag_threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). type: int
more...
Supported Version Ranges frag_threshold v6.2.0 -> v6.2.0
v6.2.5 -> latest
- frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
more...
Supported Version Ranges frequency_handoff v6.2.0 -> v6.2.0
v6.2.5 -> v6.2.7
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
Supported Version Ranges iperf_protocol v7.0.0 -> latest
[udp] v6.0.0 -> latest
[tcp] v6.0.0 -> latest
- iperf_server_port - Iperf service port number. type: int
more...
Supported Version Ranges iperf_server_port v7.0.0 -> latest
- max_clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. type: int
more...
Supported Version Ranges max_clients v6.2.0 -> v6.2.0
v6.2.5 -> latest
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
Supported Version Ranges max_distance v6.2.0 -> v6.2.0
v6.2.5 -> latest
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
Supported Version Ranges mimo_mode v7.4.1 -> latest
[default] v6.0.0 -> latest
[1x1] v6.0.0 -> latest
[2x2] v6.0.0 -> latest
[3x3] v6.0.0 -> latest
[4x4] v6.0.0 -> latest
[8x8] v6.0.0 -> latest
- mode - Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, a sniffer, or a station. type: str choices: disabled, ap, monitor, sniffer, sam
more...
Supported Version Ranges mode v6.2.0 -> v6.2.0
v6.2.5 -> latest
[disabled] v6.0.0 -> latest
[ap] v6.0.0 -> latest
[monitor] v6.0.0 -> latest
[sniffer] v6.0.0 -> latest
[sam] v7.0.0 -> latest
- optional_antenna - Optional antenna used on FAP . type: str choices: none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R
more...
Supported Version Ranges optional_antenna v7.4.0 -> latest
[none] v6.0.0 -> latest
[FANT-04ABGN-0606-O-N] v6.0.0 -> latest
[FANT-04ABGN-1414-P-N] v6.0.0 -> latest
[FANT-04ABGN-8065-P-N] v6.0.0 -> latest
[FANT-04ABGN-0606-O-R] v6.0.0 -> latest
[FANT-04ABGN-0606-P-R] v6.0.0 -> latest
[FANT-10ACAX-1213-D-N] v6.0.0 -> latest
[FANT-08ABGN-1213-D-R] v6.0.0 -> latest
- power_level - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). type: int
more...
Supported Version Ranges power_level v6.2.0 -> v6.2.0
v6.2.5 -> latest
- power_mode - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities. type: str choices: dBm, percentage
more...
Supported Version Ranges power_mode v7.0.0 -> latest
[dBm] v6.0.0 -> latest
[percentage] v6.0.0 -> latest
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
Supported Version Ranges power_value v7.0.0 -> latest
- powersave_optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: list choices: tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow
more...
Supported Version Ranges powersave_optimize v6.2.0 -> v6.2.0
v6.2.5 -> latest
[tim] v6.0.0 -> latest
[ac-vo] v6.0.0 -> latest
[no-obss-scan] v6.0.0 -> latest
[no-11b-rate] v6.0.0 -> latest
[client-rate-follow] v6.0.0 -> latest
- protection_mode - Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). type: str choices: rtscts, ctsonly, disable
more...
Supported Version Ranges protection_mode v6.2.0 -> v6.2.0
v6.2.5 -> latest
[rtscts] v6.0.0 -> latest
[ctsonly] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- rts_threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). type: int
more...
Supported Version Ranges rts_threshold v6.2.0 -> v6.2.0
v6.2.5 -> latest
- sam_bssid - BSSID for WiFi network. type: str
more...
Supported Version Ranges sam_bssid v7.0.0 -> latest
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
Supported Version Ranges sam_captive_portal v7.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- sam_cwp_failure_string - Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges sam_cwp_failure_string v7.0.1 -> latest
- sam_cwp_match_string - Identification string from the captive portal login form. type: str
more...
Supported Version Ranges sam_cwp_match_string v7.0.1 -> latest
- sam_cwp_password - Password for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_password v7.0.1 -> latest
- sam_cwp_success_string - Success identification on the page after a successful login. type: str
more...
Supported Version Ranges sam_cwp_success_string v7.0.1 -> latest
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
Supported Version Ranges sam_cwp_test_url v7.0.1 -> latest
- sam_cwp_username - Username for captive portal authentication. type: str
more...
Supported Version Ranges sam_cwp_username v7.0.1 -> latest
- sam_password - Passphrase for WiFi network connection. type: str
more...
Supported Version Ranges sam_password v7.0.0 -> latest
- sam_report_intv - SAM report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges sam_report_intv v7.0.0 -> latest
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise
more...
Supported Version Ranges sam_security_type v7.0.0 -> latest
[open] v6.0.0 -> latest
[wpa-personal] v6.0.0 -> latest
[wpa-enterprise] v6.0.0 -> latest
- sam_server - SAM test server IP address or domain name. type: str
more...
Supported Version Ranges sam_server v7.0.0 -> v7.0.0
- sam_server_fqdn - SAM test server domain name. type: str
more...
Supported Version Ranges sam_server_fqdn v7.0.1 -> latest
- sam_server_ip - SAM test server IP address. type: str
more...
Supported Version Ranges sam_server_ip v7.0.1 -> latest
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
Supported Version Ranges sam_server_type v7.0.1 -> latest
[ip] v6.0.0 -> latest
[fqdn] v6.0.0 -> latest
- sam_ssid - SSID for WiFi network. type: str
more...
Supported Version Ranges sam_ssid v7.0.0 -> latest
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
Supported Version Ranges sam_test v7.0.0 -> latest
[ping] v6.0.0 -> latest
[iperf] v6.0.0 -> latest
- sam_username - Username for WiFi network connection. type: str
more...
Supported Version Ranges sam_username v7.0.0 -> latest
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
Supported Version Ranges set_80211d v7.2.1 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- short_guard_interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: enable, disable
more...
Supported Version Ranges short_guard_interval v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
more...
Supported Version Ranges spectrum_analysis v6.2.0 -> v6.2.0
v6.2.5 -> v6.2.7
v6.4.1 -> v6.4.1
[enable] v6.0.0 -> latest
[scan-only] v6.4.1 -> v6.4.1
[disable] v6.0.0 -> latest
- transmit_optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. type: list choices: disable, power-save, aggr-limit, retry-limit, send-bar
more...
Supported Version Ranges transmit_optimize v6.2.0 -> v6.2.0
v6.2.5 -> latest
[disable] v6.0.0 -> latest
[power-save] v6.0.0 -> latest
[aggr-limit] v6.0.0 -> latest
[retry-limit] v6.0.0 -> latest
[send-bar] v6.0.0 -> latest
- vap_all - Configure method for assigning SSIDs to this FortiAP . type: str choices: tunnel, bridge, manual, enable, disable
more...
Supported Version Ranges vap_all v6.2.0 -> v6.2.0
v6.2.5 -> latest
[tunnel] v6.4.0 -> latest
[bridge] v6.4.0 -> latest
[manual] v6.4.0 -> latest
[enable] v6.2.0 -> v6.2.0
v6.2.5 -> v6.2.7
[disable] v6.2.0 -> v6.2.0
v6.2.5 -> v6.2.7
- vaps - Manually selected list of Virtual Access Points (VAPs). type: list member_path: radio_4/vaps:name
more...
Supported Version Ranges vaps v6.2.0 -> v6.2.0
v6.2.5 -> latest
- name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. type: str required: true
more...
Supported Version Ranges name v6.2.0 -> v6.2.0
v6.2.5 -> latest
- wids_profile - Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name. type: str
more...
Supported Version Ranges wids_profile v6.2.0 -> v6.2.0
v6.2.5 -> latest
- zero_wait_dfs - Enable/disable zero wait DFS on radio . type: str choices: enable, disable
more...
Supported Version Ranges zero_wait_dfs v6.2.0 -> v6.2.0
v6.2.5 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- split_tunneling_acl - Split tunneling ACL filter list. type: list member_path: split_tunneling_acl:id
more...
Supported Version Ranges split_tunneling_acl v6.0.0 -> latest
- dest_ip - Destination IP and mask for the split-tunneling subnet. type: str
more...
Supported Version Ranges dest_ip v6.0.0 -> latest
- id - ID. see Notes. type: int required: true
more...
Supported Version Ranges id v6.0.0 -> latest
- split_tunneling_acl_local_ap_subnet - Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL . type: str choices: enable, disable
more...
Supported Version Ranges split_tunneling_acl_local_ap_subnet v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- split_tunneling_acl_path - Split tunneling ACL path is local/tunnel. type: str choices: tunnel, local
more...
Supported Version Ranges split_tunneling_acl_path v6.0.0 -> latest
[tunnel] v6.0.0 -> latest
[local] v6.0.0 -> latest
- syslog_profile - System log server configuration profile name. Source wireless-controller.syslog-profile.name. type: str
more...
Supported Version Ranges syslog_profile v7.0.2 -> latest
- tun_mtu_downlink - The MTU of downlink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). type: int
more...
Supported Version Ranges tun_mtu_downlink v6.0.0 -> latest
- tun_mtu_uplink - The maximum transmission unit (MTU) of uplink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). type: int
more...
Supported Version Ranges tun_mtu_uplink v6.0.0 -> latest
- unii_4_5ghz_band - Enable/disable UNII-4 5Ghz band channels . type: str choices: enable, disable
more...
Supported Version Ranges unii_4_5ghz_band v7.4.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- wan_port_auth - Set WAN port authentication mode . type: str choices: none, 802.1x
more...
Supported Version Ranges wan_port_auth v7.0.2 -> latest
[none] v6.0.0 -> latest
[802.1x] v6.0.0 -> latest
- wan_port_auth_methods - WAN port 802.1x supplicant EAP methods . type: str choices: all, EAP-FAST, EAP-TLS, EAP-PEAP
more...
Supported Version Ranges wan_port_auth_methods v7.0.2 -> latest
[all] v6.0.0 -> latest
[EAP-FAST] v6.0.0 -> latest
[EAP-TLS] v6.0.0 -> latest
[EAP-PEAP] v6.0.0 -> latest
- wan_port_auth_password - Set WAN port 802.1x supplicant password. type: str
more...
Supported Version Ranges wan_port_auth_password v7.0.2 -> latest
- wan_port_auth_usrname - Set WAN port 802.1x supplicant user name. type: str
more...
Supported Version Ranges wan_port_auth_usrname v7.0.2 -> latest
- wan_port_mode - Enable/disable using a WAN port as a LAN port. type: str choices: wan-lan, wan-only
more...
Supported Version Ranges wan_port_mode v6.0.0 -> latest
[wan-lan] v6.0.0 -> latest
[wan-only] v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fortinet.fortios.fortios_wireless_controller_wtp_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wtp_profile:
allowaccess: "https"
ap_country: "--"
ap_handoff: "enable"
apcfg_profile: "<your_own_value> (source wireless-controller.apcfg-profile.name)"
ble_profile: "<your_own_value> (source wireless-controller.ble-profile.name)"
comment: "Comment."
console_login: "enable"
control_message_offload: "ebp-frame"
deny_mac_list:
-
id: "12"
mac: "<your_own_value>"
dtls_in_kernel: "enable"
dtls_policy: "clear-text"
energy_efficient_ethernet: "enable"
esl_ses_dongle:
apc_addr_type: "fqdn"
apc_fqdn: "<your_own_value>"
apc_ip: "<your_own_value>"
apc_port: "0"
coex_level: "none"
compliance_level: "compliance-level-2"
esl_channel: "-1"
output_power: "a"
scd_enable: "enable"
tls_cert_verification: "enable"
tls_fqdn_verification: "enable"
ext_info_enable: "enable"
frequency_handoff: "enable"
handoff_roaming: "enable"
handoff_rssi: "25"
handoff_sta_thresh: "0"
indoor_outdoor_deployment: "platform-determined"
ip_fragment_preventing: "tcp-mss-adjust"
lan:
port_esl_mode: "offline"
port_esl_ssid: "<your_own_value> (source system.interface.name)"
port_mode: "offline"
port_ssid: "<your_own_value> (source system.interface.name)"
port1_mode: "offline"
port1_ssid: "<your_own_value> (source system.interface.name)"
port2_mode: "offline"
port2_ssid: "<your_own_value> (source system.interface.name)"
port3_mode: "offline"
port3_ssid: "<your_own_value> (source system.interface.name)"
port4_mode: "offline"
port4_ssid: "<your_own_value> (source system.interface.name)"
port5_mode: "offline"
port5_ssid: "<your_own_value> (source system.interface.name)"
port6_mode: "offline"
port6_ssid: "<your_own_value> (source system.interface.name)"
port7_mode: "offline"
port7_ssid: "<your_own_value> (source system.interface.name)"
port8_mode: "offline"
port8_ssid: "<your_own_value> (source system.interface.name)"
lbs:
aeroscout: "enable"
aeroscout_ap_mac: "bssid"
aeroscout_mmu_report: "enable"
aeroscout_mu: "enable"
aeroscout_mu_factor: "20"
aeroscout_mu_timeout: "5"
aeroscout_server_ip: "<your_own_value>"
aeroscout_server_port: "0"
ekahau_blink_mode: "enable"
ekahau_tag: "<your_own_value>"
erc_server_ip: "<your_own_value>"
erc_server_port: "8569"
fortipresence: "foreign"
fortipresence_ble: "enable"
fortipresence_frequency: "30"
fortipresence_port: "3000"
fortipresence_project: "<your_own_value>"
fortipresence_rogue: "enable"
fortipresence_secret: "<your_own_value>"
fortipresence_server: "<your_own_value>"
fortipresence_server_addr_type: "ipv4"
fortipresence_server_fqdn: "<your_own_value>"
fortipresence_unassoc: "enable"
polestar: "enable"
polestar_accumulation_interval: "2"
polestar_asset_addrgrp_list: "<your_own_value> (source firewall.addrgrp.name)"
polestar_asset_uuid_list1: "<your_own_value>"
polestar_asset_uuid_list2: "<your_own_value>"
polestar_asset_uuid_list3: "<your_own_value>"
polestar_asset_uuid_list4: "<your_own_value>"
polestar_protocol: "WSS"
polestar_reporting_interval: "2"
polestar_server_fqdn: "<your_own_value>"
polestar_server_path: "<your_own_value>"
polestar_server_port: "443"
polestar_server_token: "<your_own_value>"
station_locate: "enable"
led_schedules:
-
name: "default_name_96 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
led_state: "enable"
lldp: "enable"
login_passwd: "<your_own_value>"
login_passwd_change: "yes"
max_clients: "0"
name: "default_name_102"
platform:
ddscan: "enable"
mode: "single-5G"
type: "AP-11N"
poe_mode: "auto"
radio_1:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "36"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
arrp_profile: "<your_own_value> (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "2000"
beacon_interval: "100"
bss_color: "0"
bss_color_mode: "auto"
call_admission_control: "enable"
call_capacity: "10"
channel:
-
chan: "<your_own_value>"
channel_bonding: "160MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "1"
frag_threshold: "2346"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "5001"
max_clients: "0"
max_distance: "0"
mimo_mode: "default"
mode: "disabled"
optional_antenna: "none"
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "2"
rts_threshold: "2346"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_cwp_failure_string: "<your_own_value>"
sam_cwp_match_string: "<your_own_value>"
sam_cwp_password: "<your_own_value>"
sam_cwp_success_string: "<your_own_value>"
sam_cwp_test_url: "<your_own_value>"
sam_cwp_username: "<your_own_value>"
sam_password: "<your_own_value>"
sam_report_intv: "0"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_server_fqdn: "<your_own_value>"
sam_server_ip: "<your_own_value>"
sam_server_type: "ip"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
set_80211d: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_183 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_2:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "6"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
arrp_profile: "<your_own_value> (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "2000"
beacon_interval: "100"
bss_color: "0"
bss_color_mode: "auto"
call_admission_control: "enable"
call_capacity: "10"
channel:
-
chan: "<your_own_value>"
channel_bonding: "160MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "1"
frag_threshold: "2346"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "5001"
max_clients: "0"
max_distance: "0"
mimo_mode: "default"
mode: "disabled"
optional_antenna: "none"
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "2"
rts_threshold: "2346"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_cwp_failure_string: "<your_own_value>"
sam_cwp_match_string: "<your_own_value>"
sam_cwp_password: "<your_own_value>"
sam_cwp_success_string: "<your_own_value>"
sam_cwp_test_url: "<your_own_value>"
sam_cwp_username: "<your_own_value>"
sam_password: "<your_own_value>"
sam_report_intv: "0"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_server_fqdn: "<your_own_value>"
sam_server_ip: "<your_own_value>"
sam_server_type: "ip"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
set_80211d: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_261 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_3:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "6"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
arrp_profile: "<your_own_value> (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "2000"
beacon_interval: "100"
bss_color: "0"
bss_color_mode: "auto"
call_admission_control: "enable"
call_capacity: "10"
channel:
-
chan: "<your_own_value>"
channel_bonding: "160MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "1"
frag_threshold: "2346"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "5001"
max_clients: "0"
max_distance: "0"
mimo_mode: "default"
mode: "disabled"
optional_antenna: "none"
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "2"
rts_threshold: "2346"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_cwp_failure_string: "<your_own_value>"
sam_cwp_match_string: "<your_own_value>"
sam_cwp_password: "<your_own_value>"
sam_cwp_success_string: "<your_own_value>"
sam_cwp_test_url: "<your_own_value>"
sam_cwp_username: "<your_own_value>"
sam_password: "<your_own_value>"
sam_report_intv: "0"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_server_fqdn: "<your_own_value>"
sam_server_ip: "<your_own_value>"
sam_server_type: "ip"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
set_80211d: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_339 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_4:
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: "<your_own_value>"
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "6"
ap_sniffer_ctl: "enable"
ap_sniffer_data: "enable"
ap_sniffer_mgmt_beacon: "enable"
ap_sniffer_mgmt_other: "enable"
ap_sniffer_mgmt_probe: "enable"
arrp_profile: "<your_own_value> (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
band_5g_type: "5g-full"
bandwidth_admission_control: "enable"
bandwidth_capacity: "2000"
beacon_interval: "100"
bss_color: "0"
bss_color_mode: "auto"
call_admission_control: "enable"
call_capacity: "10"
channel:
-
chan: "<your_own_value>"
channel_bonding: "160MHz"
channel_utilization: "enable"
coexistence: "enable"
darrp: "enable"
drma: "disable"
drma_sensitivity: "low"
dtim: "1"
frag_threshold: "2346"
frequency_handoff: "enable"
iperf_protocol: "udp"
iperf_server_port: "5001"
max_clients: "0"
max_distance: "0"
mimo_mode: "default"
mode: "disabled"
optional_antenna: "none"
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
rts_threshold: "2346"
sam_bssid: "<your_own_value>"
sam_captive_portal: "enable"
sam_cwp_failure_string: "<your_own_value>"
sam_cwp_match_string: "<your_own_value>"
sam_cwp_password: "<your_own_value>"
sam_cwp_success_string: "<your_own_value>"
sam_cwp_test_url: "<your_own_value>"
sam_cwp_username: "<your_own_value>"
sam_password: "<your_own_value>"
sam_report_intv: "0"
sam_security_type: "open"
sam_server: "<your_own_value>"
sam_server_fqdn: "<your_own_value>"
sam_server_ip: "<your_own_value>"
sam_server_type: "ip"
sam_ssid: "<your_own_value>"
sam_test: "ping"
sam_username: "<your_own_value>"
set_80211d: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_416 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
split_tunneling_acl:
-
dest_ip: "<your_own_value>"
id: "421"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
syslog_profile: "<your_own_value> (source wireless-controller.syslog-profile.name)"
tun_mtu_downlink: "0"
tun_mtu_uplink: "0"
unii_4_5ghz_band: "enable"
wan_port_auth: "none"
wan_port_auth_methods: "all"
wan_port_auth_password: "<your_own_value>"
wan_port_auth_usrname: "<your_own_value>"
wan_port_mode: "wan-lan"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.