:source: fortios_wireless_controller_wtp_profile.py
:orphan:
.. fortios_wireless_controller_wtp_profile:
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
.. contents::
:local:
:depth: 1
Synopsis
--------
- 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
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.15
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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 -> 7.6.6 |
- admin_auth_tacacs_plus - Remote authentication server for admin user. Source user.tacacs+.name. type: str
more...
|
Supported Version Ranges |
| admin_auth_tacacs_plus |
v7.6.1 -> 7.6.6 |
- admin_restrict_local - Enable/disable local admin authentication restriction when remote authenticator is up and running . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| admin_restrict_local |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [https] |
v6.0.0 -> 7.6.6 |
| [ssh] |
v6.0.0 -> 7.6.6 |
| [snmp] |
v6.2.0 -> 7.6.6 |
| [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, TL, 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 -> 7.6.6 |
| [--] |
v7.0.1 -> 7.6.6 |
| [AF] |
v7.0.0 -> 7.6.6 |
| [AL] |
v6.0.0 -> 7.6.6 |
| [DZ] |
v6.0.0 -> 7.6.6 |
| [AS] |
v7.0.0 -> 7.6.6 |
| [AO] |
v6.0.0 -> 7.6.6 |
| [AR] |
v6.0.0 -> 7.6.6 |
| [AM] |
v6.0.0 -> 7.6.6 |
| [AU] |
v6.0.0 -> 7.6.6 |
| [AT] |
v6.0.0 -> 7.6.6 |
| [AZ] |
v6.0.0 -> 7.6.6 |
| [BS] |
v6.4.0 -> 7.6.6 |
| [BH] |
v6.0.0 -> 7.6.6 |
| [BD] |
v6.0.0 -> 7.6.6 |
| [BB] |
v6.0.0 -> 7.6.6 |
| [BY] |
v6.0.0 -> 7.6.6 |
| [BE] |
v6.0.0 -> 7.6.6 |
| [BZ] |
v6.0.0 -> 7.6.6 |
| [BJ] |
v7.0.0 -> 7.6.6 |
| [BM] |
v7.0.0 -> 7.6.6 |
| [BT] |
v7.0.0 -> 7.6.6 |
| [BO] |
v6.0.0 -> 7.6.6 |
| [BA] |
v6.0.0 -> 7.6.6 |
| [BW] |
v7.0.0 -> 7.6.6 |
| [BR] |
v6.0.0 -> 7.6.6 |
| [BN] |
v6.0.0 -> 7.6.6 |
| [BG] |
v6.0.0 -> 7.6.6 |
| [BF] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [KH] |
v6.0.0 -> 7.6.6 |
| [CM] |
v7.0.0 -> 7.6.6 |
| [KY] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [CF] |
v6.2.0 -> 7.6.6 |
| [TD] |
v7.0.0 -> 7.6.6 |
| [CL] |
v6.0.0 -> 7.6.6 |
| [CN] |
v6.0.0 -> 7.6.6 |
| [CX] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [CO] |
v6.0.0 -> 7.6.6 |
| [CG] |
v7.0.0 -> 7.6.6 |
| [CD] |
v7.0.0 -> 7.6.6 |
| [CR] |
v6.0.0 -> 7.6.6 |
| [HR] |
v6.0.0 -> 7.6.6 |
| [CY] |
v6.0.0 -> 7.6.6 |
| [CZ] |
v6.0.0 -> 7.6.6 |
| [DK] |
v6.0.0 -> 7.6.6 |
| [DJ] |
v7.4.1 -> 7.6.6 |
| [DM] |
v7.0.0 -> 7.6.6 |
| [DO] |
v6.0.0 -> 7.6.6 |
| [EC] |
v6.0.0 -> 7.6.6 |
| [EG] |
v6.0.0 -> 7.6.6 |
| [SV] |
v6.0.0 -> 7.6.6 |
| [ET] |
v7.0.0 -> 7.6.6 |
| [EE] |
v6.0.0 -> 7.6.6 |
| [GF] |
v7.0.0 -> 7.6.6 |
| [PF] |
v7.0.0 -> 7.6.6 |
| [FO] |
v7.0.0 -> 7.6.6 |
| [FJ] |
v7.0.0 -> 7.6.6 |
| [FI] |
v6.0.0 -> 7.6.6 |
| [FR] |
v6.0.0 -> 7.6.6 |
| [GA] |
v7.4.1 -> 7.6.6 |
| [GE] |
v6.0.0 -> 7.6.6 |
| [GM] |
v7.4.1 -> 7.6.6 |
| [DE] |
v6.0.0 -> 7.6.6 |
| [GH] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [GI] |
v7.0.0 -> 7.6.6 |
| [GR] |
v6.0.0 -> 7.6.6 |
| [GL] |
v6.0.0 -> 7.6.6 |
| [GD] |
v6.0.0 -> 7.6.6 |
| [GP] |
v7.0.0 -> 7.6.6 |
| [GU] |
v6.0.0 -> 7.6.6 |
| [GT] |
v6.0.0 -> 7.6.6 |
| [GY] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [HT] |
v6.0.0 -> 7.6.6 |
| [HN] |
v6.0.0 -> 7.6.6 |
| [HK] |
v6.0.0 -> 7.6.6 |
| [HU] |
v6.0.0 -> 7.6.6 |
| [IS] |
v6.0.0 -> 7.6.6 |
| [IN] |
v6.0.0 -> 7.6.6 |
| [ID] |
v6.0.0 -> 7.6.6 |
| [IQ] |
v7.0.0 -> 7.6.6 |
| [IE] |
v6.0.0 -> 7.6.6 |
| [IM] |
v7.0.0 -> 7.6.6 |
| [IL] |
v6.0.0 -> 7.6.6 |
| [IT] |
v6.0.0 -> 7.6.6 |
| [CI] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [JM] |
v6.0.0 -> 7.6.6 |
| [JO] |
v6.0.0 -> 7.6.6 |
| [KZ] |
v6.0.0 -> 7.6.6 |
| [KE] |
v6.0.0 -> 7.6.6 |
| [KR] |
v6.0.0 -> 7.6.6 |
| [KW] |
v6.0.0 -> 7.6.6 |
| [LA] |
v7.0.0 -> 7.6.6 |
| [LV] |
v6.0.0 -> 7.6.6 |
| [LB] |
v6.0.0 -> 7.6.6 |
| [LS] |
v7.0.0 -> 7.6.6 |
| [LR] |
v7.4.1 -> 7.6.6 |
| [LY] |
v7.0.0 -> 7.6.6 |
| [LI] |
v6.0.0 -> 7.6.6 |
| [LT] |
v6.0.0 -> 7.6.6 |
| [LU] |
v6.0.0 -> 7.6.6 |
| [MO] |
v6.0.0 -> 7.6.6 |
| [MK] |
v6.0.0 -> 7.6.6 |
| [MG] |
v7.0.0 -> 7.6.6 |
| [MW] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [MY] |
v6.0.0 -> 7.6.6 |
| [MV] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [ML] |
v7.0.0 -> 7.6.6 |
| [MT] |
v6.0.0 -> 7.6.6 |
| [MH] |
v7.0.0 -> 7.6.6 |
| [MQ] |
v7.0.0 -> 7.6.6 |
| [MR] |
v7.0.0 -> 7.6.6 |
| [MU] |
v7.0.0 -> 7.6.6 |
| [YT] |
v7.0.0 -> 7.6.6 |
| [MX] |
v6.0.0 -> 7.6.6 |
| [FM] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [MD] |
v7.0.0 -> 7.6.6 |
| [MC] |
v6.0.0 -> 7.6.6 |
| [MN] |
v7.0.8 -> v7.0.12 |
v7.2.4 -> 7.6.6 |
| [MA] |
v6.0.0 -> 7.6.6 |
| [MZ] |
v6.0.0 -> 7.6.6 |
| [MM] |
v6.0.0 -> 7.6.6 |
| [NA] |
v6.0.0 -> 7.6.6 |
| [NP] |
v6.0.0 -> 7.6.6 |
| [NL] |
v6.0.0 -> 7.6.6 |
| [AN] |
v6.0.0 -> 7.6.6 |
| [AW] |
v6.0.0 -> 7.6.6 |
| [NZ] |
v6.0.0 -> 7.6.6 |
| [NI] |
v7.0.0 -> 7.6.6 |
| [NE] |
v7.0.0 -> 7.6.6 |
| [NG] |
v7.4.1 -> 7.6.6 |
| [NO] |
v6.0.0 -> 7.6.6 |
| [MP] |
v7.0.0 -> 7.6.6 |
| [OM] |
v6.0.0 -> 7.6.6 |
| [PK] |
v6.0.0 -> 7.6.6 |
| [PW] |
v7.0.0 -> 7.6.6 |
| [PA] |
v6.0.0 -> 7.6.6 |
| [PG] |
v6.0.0 -> 7.6.6 |
| [PY] |
v6.0.0 -> 7.6.6 |
| [PE] |
v6.0.0 -> 7.6.6 |
| [PH] |
v6.0.0 -> 7.6.6 |
| [PL] |
v6.0.0 -> 7.6.6 |
| [PT] |
v6.0.0 -> 7.6.6 |
| [PR] |
v6.0.0 -> 7.6.6 |
| [QA] |
v6.0.0 -> 7.6.6 |
| [RE] |
v7.0.0 -> 7.6.6 |
| [RO] |
v6.0.0 -> 7.6.6 |
| [RU] |
v6.0.0 -> 7.6.6 |
| [RW] |
v6.0.0 -> 7.6.6 |
| [BL] |
v7.0.0 -> 7.6.6 |
| [KN] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [LC] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [MF] |
v7.0.0 -> 7.6.6 |
| [PM] |
v7.0.0 -> 7.6.6 |
| [VC] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [SA] |
v6.0.0 -> 7.6.6 |
| [SN] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [RS] |
v6.0.0 -> 7.6.6 |
| [ME] |
v6.0.0 -> 7.6.6 |
| [SL] |
v7.0.0 -> 7.6.6 |
| [SG] |
v6.0.0 -> 7.6.6 |
| [SK] |
v6.0.0 -> 7.6.6 |
| [SI] |
v6.0.0 -> 7.6.6 |
| [SO] |
v7.4.1 -> 7.6.6 |
| [ZA] |
v6.0.0 -> 7.6.6 |
| [ES] |
v6.0.0 -> 7.6.6 |
| [LK] |
v6.0.0 -> 7.6.6 |
| [SR] |
v7.0.0 -> 7.6.6 |
| [SZ] |
v7.4.1 -> 7.6.6 |
| [SE] |
v6.0.0 -> 7.6.6 |
| [CH] |
v6.0.0 -> 7.6.6 |
| [TW] |
v6.0.0 -> 7.6.6 |
| [TZ] |
v6.0.0 -> 7.6.6 |
| [TH] |
v6.0.0 -> 7.6.6 |
| [TL] |
v7.6.3 -> 7.6.6 |
| [TG] |
v7.0.0 -> 7.6.6 |
| [TT] |
v6.0.0 -> 7.6.6 |
| [TN] |
v6.0.0 -> 7.6.6 |
| [TR] |
v6.0.0 -> 7.6.6 |
| [TM] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [AE] |
v6.0.0 -> 7.6.6 |
| [TC] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [UG] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [UA] |
v6.0.0 -> 7.6.6 |
| [GB] |
v6.0.0 -> 7.6.6 |
| [US] |
v6.0.0 -> 7.6.6 |
| [PS] |
v6.0.0 -> 7.6.6 |
| [UY] |
v6.0.0 -> 7.6.6 |
| [UZ] |
v6.0.0 -> 7.6.6 |
| [VU] |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [VE] |
v6.0.0 -> 7.6.6 |
| [VN] |
v6.0.0 -> 7.6.6 |
| [VI] |
v7.0.0 -> 7.6.6 |
| [WF] |
v7.0.0 -> 7.6.6 |
| [YE] |
v6.0.0 -> 7.6.6 |
| [ZM] |
v7.0.0 -> 7.6.6 |
| [ZW] |
v6.0.0 -> 7.6.6 |
| [JP] |
v6.0.0 -> 7.6.6 |
| [CA] |
v6.0.0 -> 7.6.6 |
| [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 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
- apcfg_auto_cert - Enable/disable AP local auto cert configuration . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| apcfg_auto_cert |
v7.6.5 -> 7.6.6 |
| [enable] |
v7.6.5 -> 7.6.6 |
| [disable] |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_auto_regen_days - Number of days to wait before expiry of an updated local certificate is requested (0 = disabled) . type: int
more...
|
Supported Version Ranges |
| apcfg_auto_cert_auto_regen_days |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_crypto_algo - Cryptography algorithm: rsa-1024, rsa-1536, rsa-2048, rsa-4096, ec-secp256r1, ec-secp384r1, ec-secp521r1 type: str choices: rsa-1024, rsa-1536, rsa-2048, rsa-4096, ec-secp256r1, ec-secp384r1, ec-secp521r1
more...
|
Supported Version Ranges |
| apcfg_auto_cert_crypto_algo |
v7.6.5 -> 7.6.6 |
| [rsa-1024] |
v7.6.5 -> 7.6.6 |
| [rsa-1536] |
v7.6.5 -> 7.6.6 |
| [rsa-2048] |
v7.6.5 -> 7.6.6 |
| [rsa-4096] |
v7.6.5 -> 7.6.6 |
| [ec-secp256r1] |
v7.6.5 -> 7.6.6 |
| [ec-secp384r1] |
v7.6.5 -> 7.6.6 |
| [ec-secp521r1] |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_enroll_protocol - Certificate enrollment protocol type: str choices: none, est, scep
more...
|
Supported Version Ranges |
| apcfg_auto_cert_enroll_protocol |
v7.6.5 -> 7.6.6 |
| [none] |
v7.6.5 -> 7.6.6 |
| [est] |
v7.6.5 -> 7.6.6 |
| [scep] |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_ca_id - CA identifier of the CA server for signing via EST. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_ca_id |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_http_password - HTTP Authentication password for signing via EST. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_http_password |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_http_username - HTTP Authentication username for signing via EST. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_http_username |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_https_ca - PEM format https CA Certificate. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_https_ca |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_server - Address and port for EST server (e.g. https://example.com:1234). type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_server |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_subject - Subject e.g. "CN=User,DC=example,DC=COM" type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_subject |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_est_subject_alt_name - Subject alternative name (optional, e.g. "DNS:dns1.com,IP:192.168.1.99") type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_est_subject_alt_name |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_ca_id - CA identifier of the CA server for signing via SCEP. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_ca_id |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_ec_name - Elliptic curve name: secp256r1, secp384r1 and secp521r1. . type: str choices: secp256r1, secp384r1, secp521r1
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_ec_name |
v7.6.5 -> 7.6.6 |
| [secp256r1] |
v7.6.5 -> 7.6.6 |
| [secp384r1] |
v7.6.5 -> 7.6.6 |
| [secp521r1] |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_https_ca - PEM format https CA Certificate. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_https_ca |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_keysize - Key size: 1024, 1536, 2048, 4096 . type: str choices: 1024, 1536, 2048, 4096
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_keysize |
v7.6.5 -> 7.6.6 |
| [1024] |
v7.6.5 -> 7.6.6 |
| [1536] |
v7.6.5 -> 7.6.6 |
| [2048] |
v7.6.5 -> 7.6.6 |
| [4096] |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_keytype - Key type type: str choices: rsa, ec
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_keytype |
v7.6.5 -> 7.6.6 |
| [rsa] |
v7.6.5 -> 7.6.6 |
| [ec] |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_password - SCEP server challenge password for auto-regeneration. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_password |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_sub_fully_dn - Full DN of the subject (e.g C=US,ST=CA,L=Sunnyvale,O=Fortinet,OU=Dep1,emailAddress=test@example.com). There should be no space in between the attributes. Supported DN attributes (case-sensitive) are:C,ST,L,O,OU,emailAddress. The CN defaults to the device"s SN and cannot be changed. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_sub_fully_dn |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_subject_alt_name - Subject alternative name (optional, e.g. "DNS:dns1.com,IP:192.168.1.99") type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_subject_alt_name |
v7.6.5 -> 7.6.6 |
- apcfg_auto_cert_scep_url - SCEP server URL. type: str
more...
|
Supported Version Ranges |
| apcfg_auto_cert_scep_url |
v7.6.5 -> 7.6.6 |
- apcfg_mesh - Enable/disable AP local mesh configuration . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| apcfg_mesh |
v7.6.4 -> 7.6.6 |
| [enable] |
v7.6.4 -> 7.6.6 |
| [disable] |
v7.6.4 -> 7.6.6 |
- apcfg_mesh_ap_type - Mesh AP Type . type: str choices: ethernet, mesh, auto
more...
|
Supported Version Ranges |
| apcfg_mesh_ap_type |
v7.6.4 -> 7.6.6 |
| [ethernet] |
v7.6.4 -> 7.6.6 |
| [mesh] |
v7.6.4 -> 7.6.6 |
| [auto] |
v7.6.4 -> 7.6.6 |
- apcfg_mesh_eth_bridge - Enable/disable mesh ethernet bridge . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| apcfg_mesh_eth_bridge |
v7.6.4 -> 7.6.6 |
| [enable] |
v7.6.4 -> 7.6.6 |
| [disable] |
v7.6.4 -> 7.6.6 |
- apcfg_mesh_ssid - Mesh SSID . Source wireless-controller.vap.name. type: str
more...
|
Supported Version Ranges |
| apcfg_mesh_ssid |
v7.6.4 -> 7.6.6 |
- apcfg_profile - AP local configuration profile name. Source wireless-controller.apcfg-profile.name. type: str
more...
|
Supported Version Ranges |
| apcfg_profile |
v6.4.0 -> 7.6.6 |
- ble_profile - Bluetooth Low Energy profile name. Source wireless-controller.ble-profile.name. type: str
more...
|
Supported Version Ranges |
| ble_profile |
v6.0.0 -> 7.6.6 |
- bonjour_profile - Bonjour profile name. Source wireless-controller.bonjour-profile.name. type: str
more...
|
Supported Version Ranges |
| bonjour_profile |
v7.4.2 -> 7.6.6 |
- comment - Comment. type: str
more...
|
Supported Version Ranges |
| comment |
v6.0.0 -> 7.6.6 |
- console_login - Enable/disable FortiAP console login access . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| console_login |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [ebp-frame] |
v6.0.0 -> 7.6.6 |
| [aeroscout-tag] |
v6.0.0 -> 7.6.6 |
| [ap-list] |
v6.0.0 -> 7.6.6 |
| [sta-list] |
v6.0.0 -> 7.6.6 |
| [sta-cap-list] |
v6.0.0 -> 7.6.6 |
| [stats] |
v6.0.0 -> 7.6.6 |
| [aeroscout-mu] |
v6.0.0 -> 7.6.6 |
| [sta-health] |
v6.2.0 -> 7.6.6 |
| [spectral-analysis] |
v6.4.0 -> 7.6.6 |
- default_mesh_root - Configure default mesh root SSID when it is not included by radio"s SSID configuration. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| default_mesh_root |
v7.6.4 -> 7.6.6 |
| [enable] |
v7.6.4 -> 7.6.6 |
| [disable] |
v7.6.4 -> 7.6.6 |
- 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 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [clear-text] |
v6.0.0 -> 7.6.6 |
| [dtls-enabled] |
v6.0.0 -> 7.6.6 |
| [ipsec-vpn] |
v6.0.0 -> 7.6.6 |
| [ipsec-sn-vpn] |
v7.4.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- esl_ses_dongle - ESL SES-imagotag dongle configuration. type: dict
more...
| Supported Version Ranges |
| esl_ses_dongle |
v7.0.1 -> 7.6.6 |
- apc_addr_type - ESL SES-imagotag APC address type . type: str choices: fqdn, ip
more...
|
Supported Version Ranges |
| apc_addr_type |
v7.0.1 -> 7.6.6 |
| [fqdn] |
v7.0.1 -> 7.6.6 |
| [ip] |
v7.0.1 -> 7.6.6 |
- apc_fqdn - FQDN of ESL SES-imagotag Access Point Controller (APC). type: str
more...
|
Supported Version Ranges |
| apc_fqdn |
v7.0.1 -> 7.6.6 |
- apc_ip - IP address of ESL SES-imagotag Access Point Controller (APC). type: str
more...
|
Supported Version Ranges |
| apc_ip |
v7.0.1 -> 7.6.6 |
- apc_port - Port of ESL SES-imagotag Access Point Controller (APC). type: int
more...
|
Supported Version Ranges |
| apc_port |
v7.0.1 -> 7.6.6 |
- coex_level - ESL SES-imagotag dongle coexistence level . type: str choices: none
more...
|
Supported Version Ranges |
| coex_level |
v7.0.1 -> 7.6.6 |
| [none] |
v7.0.1 -> 7.6.6 |
- compliance_level - Compliance levels for the ESL solution integration . type: str choices: compliance-level-2
more...
|
Supported Version Ranges |
| compliance_level |
v7.0.1 -> 7.6.6 |
| [compliance-level-2] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [-1] |
v7.0.1 -> 7.6.6 |
| [0] |
v7.0.1 -> 7.6.6 |
| [1] |
v7.0.1 -> 7.6.6 |
| [2] |
v7.0.1 -> 7.6.6 |
| [3] |
v7.0.1 -> 7.6.6 |
| [4] |
v7.0.1 -> 7.6.6 |
| [5] |
v7.0.1 -> 7.6.6 |
| [6] |
v7.0.1 -> 7.6.6 |
| [7] |
v7.0.1 -> 7.6.6 |
| [8] |
v7.0.1 -> 7.6.6 |
| [9] |
v7.0.1 -> 7.6.6 |
| [10] |
v7.0.1 -> 7.6.6 |
| [127] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [a] |
v7.0.1 -> 7.6.6 |
| [b] |
v7.0.1 -> 7.6.6 |
| [c] |
v7.0.1 -> 7.6.6 |
| [d] |
v7.0.1 -> 7.6.6 |
| [e] |
v7.0.1 -> 7.6.6 |
| [f] |
v7.0.1 -> 7.6.6 |
| [g] |
v7.0.1 -> 7.6.6 |
| [h] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- tls_cert_verification - Enable/disable TLS certificate verification . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tls_cert_verification |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- tls_fqdn_verification - Enable/disable TLS FQDN verification . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tls_fqdn_verification |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- handoff_rssi - Minimum received signal strength indicator (RSSI) value for handoff (20 - 30). type: int
more...
|
Supported Version Ranges |
| handoff_rssi |
v6.0.0 -> 7.6.6 |
- handoff_sta_thresh - Threshold value for AP handoff. type: int
more...
|
Supported Version Ranges |
| handoff_sta_thresh |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [platform-determined] |
v7.0.1 -> 7.6.6 |
| [outdoor] |
v7.0.1 -> 7.6.6 |
| [indoor] |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tcp-mss-adjust] |
v6.0.0 -> 7.6.6 |
| [icmp-unreachable] |
v6.0.0 -> 7.6.6 |
- lan - WTP LAN port mapping. type: dict
more...
| Supported Version Ranges |
| lan |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.4.0 -> v6.4.0 |
| [nat-to-wan] |
v6.4.0 -> v6.4.0 |
| [bridge-to-wan] |
v6.4.0 -> v6.4.0 |
| [bridge-to-ssid] |
v6.4.0 -> v6.4.0 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port_ssid - Bridge LAN port to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port1_ssid - Bridge LAN port 1 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port1_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port2_ssid - Bridge LAN port 2 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port2_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port3_ssid - Bridge LAN port 3 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port3_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port4_ssid - Bridge LAN port 4 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port4_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port5_ssid - Bridge LAN port 5 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port5_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port6_ssid - Bridge LAN port 6 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port6_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port7_ssid - Bridge LAN port 7 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port7_ssid |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [offline] |
v6.0.0 -> 7.6.6 |
| [nat-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-wan] |
v6.0.0 -> 7.6.6 |
| [bridge-to-ssid] |
v6.0.0 -> 7.6.6 |
- port8_ssid - Bridge LAN port 8 to SSID. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| port8_ssid |
v6.0.0 -> 7.6.6 |
- lbs - Set various location based service (LBS) options. type: dict
more...
| Supported Version Ranges |
| lbs |
v6.0.0 -> 7.6.6 |
- aeroscout - Enable/disable AeroScout Real Time Location Service (RTLS) support . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| aeroscout |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [bssid] |
v6.0.0 -> 7.6.6 |
| [board-mac] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- aeroscout_mu - Enable/disable AeroScout Mobile Unit (MU) support . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| aeroscout_mu |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- aeroscout_mu_factor - AeroScout MU mode dilution factor . type: int
more...
|
Supported Version Ranges |
| aeroscout_mu_factor |
v6.0.0 -> 7.6.6 |
- aeroscout_mu_timeout - AeroScout MU mode timeout (0 - 65535 sec). type: int
more...
|
Supported Version Ranges |
| aeroscout_mu_timeout |
v6.0.0 -> 7.6.6 |
- aeroscout_server_ip - IP address of AeroScout server. type: str
more...
|
Supported Version Ranges |
| aeroscout_server_ip |
v6.0.0 -> 7.6.6 |
- aeroscout_server_port - AeroScout server UDP listening port. type: int
more...
|
Supported Version Ranges |
| aeroscout_server_port |
v6.0.0 -> 7.6.6 |
- ble_rtls - Set BLE Real Time Location Service (RTLS) support . type: str choices: none, polestar, evresys
more...
|
Supported Version Ranges |
| ble_rtls |
v7.6.1 -> 7.6.6 |
| [none] |
v7.6.1 -> 7.6.6 |
| [polestar] |
v7.6.1 -> 7.6.6 |
| [evresys] |
v7.6.1 -> 7.6.6 |
- ble_rtls_accumulation_interval - Time that measurements should be accumulated in seconds . type: int
more...
|
Supported Version Ranges |
| ble_rtls_accumulation_interval |
v7.6.1 -> 7.6.6 |
- ble_rtls_asset_addrgrp_list - Tags and asset addrgrp list to be reported. Source firewall.addrgrp.name. type: str
more...
|
Supported Version Ranges |
| ble_rtls_asset_addrgrp_list |
v7.6.1 -> 7.6.6 |
- ble_rtls_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 |
| ble_rtls_asset_uuid_list1 |
v7.6.1 -> 7.6.6 |
- ble_rtls_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 |
| ble_rtls_asset_uuid_list2 |
v7.6.1 -> 7.6.6 |
- ble_rtls_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 |
| ble_rtls_asset_uuid_list3 |
v7.6.1 -> 7.6.6 |
- ble_rtls_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 |
| ble_rtls_asset_uuid_list4 |
v7.6.1 -> 7.6.6 |
- ble_rtls_protocol - Select the protocol to report Measurements, Advertising Data, or Location Data to Cloud Server . type: str choices: WSS
more...
|
Supported Version Ranges |
| ble_rtls_protocol |
v7.6.1 -> 7.6.6 |
| [WSS] |
v7.6.1 -> 7.6.6 |
- ble_rtls_reporting_interval - Time between reporting accumulated measurements in seconds . type: int
more...
|
Supported Version Ranges |
| ble_rtls_reporting_interval |
v7.6.1 -> 7.6.6 |
- ble_rtls_server_fqdn - FQDN of BLE Real Time Location Service (RTLS) Server. type: str
more...
|
Supported Version Ranges |
| ble_rtls_server_fqdn |
v7.6.1 -> 7.6.6 |
- ble_rtls_server_path - Path of BLE Real Time Location Service (RTLS) Server. type: str
more...
|
Supported Version Ranges |
| ble_rtls_server_path |
v7.6.1 -> 7.6.6 |
- ble_rtls_server_port - Port of BLE Real Time Location Service (RTLS) Server . type: int
more...
|
Supported Version Ranges |
| ble_rtls_server_port |
v7.6.1 -> 7.6.6 |
- ble_rtls_server_token - Access Token of BLE Real Time Location Service (RTLS) Server. type: str
more...
|
Supported Version Ranges |
| ble_rtls_server_token |
v7.6.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ekahau_tag - WiFi frame MAC address or WiFi Tag. type: str
more...
|
Supported Version Ranges |
| ekahau_tag |
v6.0.0 -> 7.6.6 |
- erc_server_ip - IP address of Ekahau RTLS Controller (ERC). type: str
more...
|
Supported Version Ranges |
| erc_server_ip |
v6.0.0 -> 7.6.6 |
- erc_server_port - Ekahau RTLS Controller (ERC) UDP listening port. type: int
more...
|
Supported Version Ranges |
| erc_server_port |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [foreign] |
v6.0.0 -> 7.6.6 |
| [both] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- fortipresence_ble - Enable/disable FortiPresence finding and reporting BLE devices. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fortipresence_ble |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- fortipresence_frequency - FortiPresence report transmit frequency (5 - 65535 sec). type: int
more...
|
Supported Version Ranges |
| fortipresence_frequency |
v6.0.0 -> 7.6.6 |
- fortipresence_port - UDP listening port of FortiPresence server . type: int
more...
|
Supported Version Ranges |
| fortipresence_port |
v6.0.0 -> 7.6.6 |
- fortipresence_project - FortiPresence project name (max. 16 characters). type: str
more...
|
Supported Version Ranges |
| fortipresence_project |
v6.0.0 -> 7.6.6 |
- fortipresence_rogue - Enable/disable FortiPresence finding and reporting rogue APs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fortipresence_rogue |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- fortipresence_secret - FortiPresence secret password (max. 16 characters). type: str
more...
|
Supported Version Ranges |
| fortipresence_secret |
v6.0.0 -> 7.6.6 |
- fortipresence_server - IP address of FortiPresence server. type: str
more...
|
Supported Version Ranges |
| fortipresence_server |
v6.0.0 -> 7.6.6 |
- fortipresence_server_addr_type - FortiPresence server address type . type: str choices: ipv4, fqdn
more...
|
Supported Version Ranges |
| fortipresence_server_addr_type |
v7.0.2 -> 7.6.6 |
| [ipv4] |
v7.0.2 -> 7.6.6 |
| [fqdn] |
v7.0.2 -> 7.6.6 |
- fortipresence_server_fqdn - FQDN of FortiPresence server. type: str
more...
|
Supported Version Ranges |
| fortipresence_server_fqdn |
v7.0.2 -> 7.6.6 |
- fortipresence_unassoc - Enable/disable FortiPresence finding and reporting unassociated stations. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fortipresence_unassoc |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> v7.6.0 |
| [enable] |
v7.4.1 -> v7.6.0 |
| [disable] |
v7.4.1 -> v7.6.0 |
- polestar_accumulation_interval - Time that measurements should be accumulated in seconds . type: int
more...
|
Supported Version Ranges |
| polestar_accumulation_interval |
v7.4.1 -> v7.6.0 |
- 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 -> v7.6.0 |
- 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 -> v7.6.0 |
- 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 -> v7.6.0 |
- 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 -> v7.6.0 |
- 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 -> v7.6.0 |
- 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 -> v7.6.0 |
| [WSS] |
v7.4.1 -> v7.6.0 |
- polestar_reporting_interval - Time between reporting accumulated measurements in seconds . type: int
more...
|
Supported Version Ranges |
| polestar_reporting_interval |
v7.4.1 -> v7.6.0 |
- polestar_server_fqdn - FQDN of PoleStar Nao Track Server . type: str
more...
|
Supported Version Ranges |
| polestar_server_fqdn |
v7.4.1 -> v7.6.0 |
- polestar_server_path - Path of PoleStar Nao Track Server . type: str
more...
|
Supported Version Ranges |
| polestar_server_path |
v7.4.1 -> v7.6.0 |
- polestar_server_port - Port of PoleStar Nao Track Server . type: int
more...
|
Supported Version Ranges |
| polestar_server_port |
v7.4.1 -> v7.6.0 |
- polestar_server_token - Access Token of PoleStar Nao Track Server. type: str
more...
|
Supported Version Ranges |
| polestar_server_token |
v7.4.1 -> v7.6.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- led_state - Enable/disable use of LEDs on WTP . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| led_state |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- login_passwd - Set the managed WTP, FortiAP, or AP"s administrator password. type: str
more...
|
Supported Version Ranges |
| login_passwd |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [yes] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [no] |
v6.0.0 -> 7.6.6 |
- lw_profile - LoRaWAN profile name. Source wireless-controller.lw-profile.name. type: str
more...
|
Supported Version Ranges |
| lw_profile |
v7.6.5 -> 7.6.6 |
- max_clients - Maximum number of stations (STAs) supported by the WTP . type: int
more...
|
Supported Version Ranges |
| max_clients |
v6.0.0 -> 7.6.6 |
- name - WTP (or FortiAP or AP) profile name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- platform - WTP, FortiAP, or AP platform. type: dict
more...
| Supported Version Ranges |
| platform |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- mode - Configure operation mode of 5G radios . type: str choices: single-5G, dual-5G
more...
|
Supported Version Ranges |
| mode |
v6.2.0 -> 7.6.6 |
| [single-5G] |
v6.2.0 -> 7.6.6 |
| [dual-5G] |
v6.2.0 -> 7.6.6 |
- 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, 432G, 433G, 231K, 231KD, 23JK, 222KL, 241K, 243K, 244K, 441K, 432K, 443K, U421E, U422EV, U423E, U221EV, U223EV, U24JEV, U321EV, U323EV, U431F, U433F, U231F, U234F, U432F, U231G, MVP, 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 -> 7.6.6 |
| [AP-11N] |
v6.0.0 -> 7.6.6 |
| [C24JE] |
v6.0.0 -> 7.6.6 |
| [421E] |
v6.0.0 -> 7.6.6 |
| [423E] |
v6.0.0 -> 7.6.6 |
| [221E] |
v6.0.0 -> 7.6.6 |
| [222E] |
v6.0.0 -> 7.6.6 |
| [223E] |
v6.0.0 -> 7.6.6 |
| [224E] |
v6.0.0 -> 7.6.6 |
| [231E] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [321E] |
v6.2.0 -> 7.6.6 |
| [431F] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [431FL] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [432F] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [432FR] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [433F] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [433FL] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [231F] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [231FL] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [234F] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [23JF] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [831F] |
v6.4.4 -> 7.6.6 |
| [231G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [233G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [234G] |
v7.4.0 -> 7.6.6 |
| [431G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [432G] |
v7.4.2 -> 7.6.6 |
| [433G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [231K] |
v7.6.1 -> 7.6.6 |
| [231KD] |
v7.6.5 -> 7.6.6 |
| [23JK] |
v7.6.1 -> 7.6.6 |
| [222KL] |
v7.6.4 -> 7.6.6 |
| [241K] |
v7.4.2 -> 7.6.6 |
| [243K] |
v7.4.2 -> 7.6.6 |
| [244K] |
v7.6.4 -> 7.6.6 |
| [441K] |
v7.4.2 -> 7.6.6 |
| [432K] |
v7.6.5 -> 7.6.6 |
| [443K] |
v7.4.2 -> 7.6.6 |
| [U421E] |
v6.0.0 -> 7.6.6 |
| [U422EV] |
v6.0.0 -> 7.6.6 |
| [U423E] |
v6.0.0 -> 7.6.6 |
| [U221EV] |
v6.0.0 -> 7.6.6 |
| [U223EV] |
v6.0.0 -> 7.6.6 |
| [U24JEV] |
v6.0.0 -> 7.6.6 |
| [U321EV] |
v6.0.0 -> 7.6.6 |
| [U323EV] |
v6.0.0 -> 7.6.6 |
| [U431F] |
v6.2.0 -> 7.6.6 |
| [U433F] |
v6.2.0 -> 7.6.6 |
| [U231F] |
v6.4.4 -> 7.6.6 |
| [U234F] |
v6.4.4 -> 7.6.6 |
| [U432F] |
v6.4.4 -> 7.6.6 |
| [U231G] |
v7.0.8 -> v7.0.12 |
v7.2.4 -> 7.6.6 |
| [MVP] |
v7.6.5 -> 7.6.6 |
| [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 -> 7.6.6 |
| [auto] |
v6.0.0 -> 7.6.6 |
| [8023af] |
v6.0.0 -> 7.6.6 |
| [8023at] |
v6.0.0 -> 7.6.6 |
| [power-adapter] |
v6.0.0 -> 7.6.6 |
| [full] |
v6.4.4 -> 7.6.6 |
| [high] |
v6.4.4 -> 7.6.6 |
| [low] |
v6.4.4 -> 7.6.6 |
- radio_1 - Configuration options for radio 1. type: dict
more...
| Supported Version Ranges |
| radio_1 |
v6.0.0 -> 7.6.6 |
- ai_darrp_support - Enable/disable support for FortiAIOps to retrieve Distributed Automatic Radio Resource Provisioning (DARRP) data through REST API calls . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ai_darrp_support |
v7.6.5 -> 7.6.6 |
| [enable] |
v7.6.5 -> 7.6.6 |
| [disable] |
v7.6.5 -> 7.6.6 |
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| airtime_fairness |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- ap_sniffer_addr - MAC address to monitor. type: str
more...
|
Supported Version Ranges |
| ap_sniffer_addr |
v6.0.0 -> 7.6.6 |
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
|
Supported Version Ranges |
| ap_sniffer_bufsize |
v6.0.0 -> 7.6.6 |
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
|
Supported Version Ranges |
| ap_sniffer_chan |
v6.0.0 -> 7.6.6 |
- ap_sniffer_chan_width - Channel bandwidth for sniffer. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| ap_sniffer_chan_width |
v7.6.0 -> 7.6.6 |
| [320MHz] |
v7.6.0 -> 7.6.6 |
| [240MHz] |
v7.6.0 -> 7.6.6 |
| [160MHz] |
v7.6.0 -> 7.6.6 |
| [80MHz] |
v7.6.0 -> 7.6.6 |
| [40MHz] |
v7.6.0 -> 7.6.6 |
| [20MHz] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- band - WiFi band that Radio 1 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 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 -> 7.6.6 |
| [802.11a] |
v6.0.0 -> 7.6.6 |
| [802.11b] |
v6.0.0 -> 7.6.6 |
| [802.11g] |
v6.0.0 -> 7.6.6 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.0.0 -> 7.6.6 |
| [802.11ac-2G] |
v6.4.0 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.0.0 -> v7.4.3 |
| [802.11ac] |
v6.0.0 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v7.4.3 |
| [802.11n,g-only] |
v6.0.0 -> v7.4.3 |
| [802.11g-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-5G-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac,n-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac-only] |
v6.0.0 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v7.4.3 |
- 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 -> 7.6.6 |
| [5g-full] |
v6.2.0 -> v6.2.0 |
| [5g-high] |
v6.2.0 -> v6.2.0 |
| [5g-low] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
|
Supported Version Ranges |
| bandwidth_capacity |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [auto] |
v7.0.2 -> 7.6.6 |
| [static] |
v7.0.2 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_1/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.0.0 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.0.0 -> 7.6.6 |
- channel_bonding - Channel bandwidth: 320, 240, 160, 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| channel_bonding |
v6.0.0 -> 7.6.6 |
| [320MHz] |
v7.4.4 -> 7.6.6 |
| [240MHz] |
v7.4.4 -> 7.6.6 |
| [160MHz] |
v6.2.0 -> 7.6.6 |
| [80MHz] |
v6.0.0 -> 7.6.6 |
| [40MHz] |
v6.0.0 -> 7.6.6 |
| [20MHz] |
v6.0.0 -> 7.6.6 |
- channel_bonding_ext - Channel bandwidth extension: 320 MHz-1 and 320 MHz-2 . type: str choices: 320MHz-1, 320MHz-2
more...
|
Supported Version Ranges |
| channel_bonding_ext |
v7.4.4 -> 7.6.6 |
| [320MHz-1] |
v7.4.4 -> 7.6.6 |
| [320MHz-2] |
v7.4.4 -> 7.6.6 |
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| channel_utilization |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| drma |
v6.4.4 -> 7.6.6 |
| [disable] |
v6.4.4 -> 7.6.6 |
| [enable] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
| [low] |
v6.4.4 -> 7.6.6 |
| [medium] |
v6.4.4 -> 7.6.6 |
| [high] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
|
Supported Version Ranges |
| iperf_protocol |
v7.0.0 -> 7.6.6 |
| [udp] |
v7.0.0 -> 7.6.6 |
| [tcp] |
v7.0.0 -> 7.6.6 |
- iperf_server_port - Iperf service port number. type: int
more...
|
Supported Version Ranges |
| iperf_server_port |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
|
Supported Version Ranges |
| max_distance |
v6.0.0 -> 7.6.6 |
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
|
Supported Version Ranges |
| mimo_mode |
v7.4.1 -> 7.6.6 |
| [default] |
v7.4.1 -> 7.6.6 |
| [1x1] |
v7.4.1 -> 7.6.6 |
| [2x2] |
v7.4.1 -> 7.6.6 |
| [3x3] |
v7.4.1 -> 7.6.6 |
| [4x4] |
v7.4.1 -> 7.6.6 |
| [8x8] |
v7.4.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [disabled] |
v6.0.0 -> 7.6.6 |
| [ap] |
v6.0.0 -> 7.6.6 |
| [monitor] |
v6.0.0 -> 7.6.6 |
| [sniffer] |
v6.0.0 -> 7.6.6 |
| [sam] |
v7.0.0 -> 7.6.6 |
- optional_antenna - Optional antenna used on FAP . type: str choices: none, custom, 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, FANT-04BEAX-0606-P-R
more...
|
Supported Version Ranges |
| optional_antenna |
v7.4.0 -> 7.6.6 |
| [none] |
v7.4.0 -> 7.6.6 |
| [custom] |
v7.4.2 -> 7.6.6 |
| [FANT-04ABGN-0606-O-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-1414-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-8065-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-O-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-P-R] |
v7.4.0 -> 7.6.6 |
| [FANT-10ACAX-1213-D-N] |
v7.4.0 -> 7.6.6 |
| [FANT-08ABGN-1213-D-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04BEAX-0606-P-R] |
v7.6.4 -> 7.6.6 |
- optional_antenna_gain - Optional antenna gain in dBi (0 to 20). type: str
more...
|
Supported Version Ranges |
| optional_antenna_gain |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tim] |
v6.0.0 -> 7.6.6 |
| [ac-vo] |
v6.0.0 -> 7.6.6 |
| [no-obss-scan] |
v6.0.0 -> 7.6.6 |
| [no-11b-rate] |
v6.0.0 -> 7.6.6 |
| [client-rate-follow] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [rtscts] |
v6.0.0 -> 7.6.6 |
| [ctsonly] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_bssid - BSSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_bssid |
v7.0.0 -> 7.6.6 |
- sam_ca_certificate - CA certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| sam_ca_certificate |
v7.4.2 -> 7.6.6 |
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sam_captive_portal |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- sam_client_certificate - Client certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_client_certificate |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_password - Password for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_password |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
|
Supported Version Ranges |
| sam_cwp_test_url |
v7.0.1 -> 7.6.6 |
- sam_cwp_username - Username for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_username |
v7.0.1 -> 7.6.6 |
- sam_eap_method - Select WPA2/WPA3-ENTERPRISE EAP Method . type: str choices: both, tls, peap
more...
|
Supported Version Ranges |
| sam_eap_method |
v7.4.2 -> 7.6.6 |
| [both] |
v7.4.2 -> 7.6.6 |
| [tls] |
v7.4.2 -> 7.6.6 |
| [peap] |
v7.4.2 -> 7.6.6 |
- sam_password - Passphrase for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_password |
v7.0.0 -> 7.6.6 |
- sam_private_key - Private key for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_private_key |
v7.4.2 -> 7.6.6 |
- sam_private_key_password - Password for private key file for WPA2/WPA3-ENTERPRISE. type: str
more...
|
Supported Version Ranges |
| sam_private_key_password |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise, wpa3-sae, owe
more...
|
Supported Version Ranges |
| sam_security_type |
v7.0.0 -> 7.6.6 |
| [open] |
v7.0.0 -> 7.6.6 |
| [wpa-personal] |
v7.0.0 -> 7.6.6 |
| [wpa-enterprise] |
v7.0.0 -> 7.6.6 |
| [wpa3-sae] |
v7.4.2 -> 7.6.6 |
| [owe] |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_server_ip - SAM test server IP address. type: str
more...
|
Supported Version Ranges |
| sam_server_ip |
v7.0.1 -> 7.6.6 |
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
|
Supported Version Ranges |
| sam_server_type |
v7.0.1 -> 7.6.6 |
| [ip] |
v7.0.1 -> 7.6.6 |
| [fqdn] |
v7.0.1 -> 7.6.6 |
- sam_ssid - SSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_ssid |
v7.0.0 -> 7.6.6 |
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
|
Supported Version Ranges |
| sam_test |
v7.0.0 -> 7.6.6 |
| [ping] |
v7.0.0 -> 7.6.6 |
| [iperf] |
v7.0.0 -> 7.6.6 |
- sam_username - Username for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_username |
v7.0.0 -> 7.6.6 |
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211d |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- set_80211mc - Enable/disable 802.11mc responder mode . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211mc |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> v6.2.7 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [power-save] |
v6.0.0 -> 7.6.6 |
| [aggr-limit] |
v6.0.0 -> 7.6.6 |
| [retry-limit] |
v6.0.0 -> 7.6.6 |
| [send-bar] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- radio_2 - Configuration options for radio 2. type: dict
more...
| Supported Version Ranges |
| radio_2 |
v6.0.0 -> 7.6.6 |
- ai_darrp_support - Enable/disable support for FortiAIOps to retrieve Distributed Automatic Radio Resource Provisioning (DARRP) data through REST API calls . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ai_darrp_support |
v7.6.5 -> 7.6.6 |
| [enable] |
v7.6.5 -> 7.6.6 |
| [disable] |
v7.6.5 -> 7.6.6 |
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| airtime_fairness |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- ap_sniffer_addr - MAC address to monitor. type: str
more...
|
Supported Version Ranges |
| ap_sniffer_addr |
v6.0.0 -> 7.6.6 |
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
|
Supported Version Ranges |
| ap_sniffer_bufsize |
v6.0.0 -> 7.6.6 |
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
|
Supported Version Ranges |
| ap_sniffer_chan |
v6.0.0 -> 7.6.6 |
- ap_sniffer_chan_width - Channel bandwidth for sniffer. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| ap_sniffer_chan_width |
v7.6.0 -> 7.6.6 |
| [320MHz] |
v7.6.0 -> 7.6.6 |
| [240MHz] |
v7.6.0 -> 7.6.6 |
| [160MHz] |
v7.6.0 -> 7.6.6 |
| [80MHz] |
v7.6.0 -> 7.6.6 |
| [40MHz] |
v7.6.0 -> 7.6.6 |
| [20MHz] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- band - WiFi band that Radio 2 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 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 -> 7.6.6 |
| [802.11a] |
v6.0.0 -> 7.6.6 |
| [802.11b] |
v6.0.0 -> 7.6.6 |
| [802.11g] |
v6.0.0 -> 7.6.6 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.0.0 -> 7.6.6 |
| [802.11ac-2G] |
v6.4.0 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.0.0 -> v7.4.3 |
| [802.11ac] |
v6.0.0 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v7.4.3 |
| [802.11n,g-only] |
v6.0.0 -> v7.4.3 |
| [802.11g-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-only] |
v6.0.0 -> v7.4.3 |
| [802.11n-5G-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac,n-only] |
v6.0.0 -> v7.4.3 |
| [802.11ac-only] |
v6.0.0 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v7.4.3 |
- 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 -> 7.6.6 |
| [5g-full] |
v6.2.0 -> v6.2.0 |
| [5g-high] |
v6.2.0 -> v6.2.0 |
| [5g-low] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
|
Supported Version Ranges |
| bandwidth_capacity |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [auto] |
v7.0.2 -> 7.6.6 |
| [static] |
v7.0.2 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_2/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.0.0 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.0.0 -> 7.6.6 |
- channel_bonding - Channel bandwidth: 320, 240, 160, 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| channel_bonding |
v6.0.0 -> 7.6.6 |
| [320MHz] |
v7.4.4 -> 7.6.6 |
| [240MHz] |
v7.4.4 -> 7.6.6 |
| [160MHz] |
v6.2.0 -> 7.6.6 |
| [80MHz] |
v6.0.0 -> 7.6.6 |
| [40MHz] |
v6.0.0 -> 7.6.6 |
| [20MHz] |
v6.0.0 -> 7.6.6 |
- channel_bonding_ext - Channel bandwidth extension: 320 MHz-1 and 320 MHz-2 . type: str choices: 320MHz-1, 320MHz-2
more...
|
Supported Version Ranges |
| channel_bonding_ext |
v7.4.4 -> 7.6.6 |
| [320MHz-1] |
v7.4.4 -> 7.6.6 |
| [320MHz-2] |
v7.4.4 -> 7.6.6 |
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| channel_utilization |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| drma |
v6.4.4 -> 7.6.6 |
| [disable] |
v6.4.4 -> 7.6.6 |
| [enable] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
| [low] |
v6.4.4 -> 7.6.6 |
| [medium] |
v6.4.4 -> 7.6.6 |
| [high] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
|
Supported Version Ranges |
| iperf_protocol |
v7.0.0 -> 7.6.6 |
| [udp] |
v7.0.0 -> 7.6.6 |
| [tcp] |
v7.0.0 -> 7.6.6 |
- iperf_server_port - Iperf service port number. type: int
more...
|
Supported Version Ranges |
| iperf_server_port |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
|
Supported Version Ranges |
| max_distance |
v6.0.0 -> 7.6.6 |
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
|
Supported Version Ranges |
| mimo_mode |
v7.4.1 -> 7.6.6 |
| [default] |
v7.4.1 -> 7.6.6 |
| [1x1] |
v7.4.1 -> 7.6.6 |
| [2x2] |
v7.4.1 -> 7.6.6 |
| [3x3] |
v7.4.1 -> 7.6.6 |
| [4x4] |
v7.4.1 -> 7.6.6 |
| [8x8] |
v7.4.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [disabled] |
v6.0.0 -> 7.6.6 |
| [ap] |
v6.0.0 -> 7.6.6 |
| [monitor] |
v6.0.0 -> 7.6.6 |
| [sniffer] |
v6.0.0 -> 7.6.6 |
| [sam] |
v7.0.0 -> 7.6.6 |
- optional_antenna - Optional antenna used on FAP . type: str choices: none, custom, 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, FANT-04BEAX-0606-P-R
more...
|
Supported Version Ranges |
| optional_antenna |
v7.4.0 -> 7.6.6 |
| [none] |
v7.4.0 -> 7.6.6 |
| [custom] |
v7.4.2 -> 7.6.6 |
| [FANT-04ABGN-0606-O-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-1414-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-8065-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-O-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-P-R] |
v7.4.0 -> 7.6.6 |
| [FANT-10ACAX-1213-D-N] |
v7.4.0 -> 7.6.6 |
| [FANT-08ABGN-1213-D-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04BEAX-0606-P-R] |
v7.6.4 -> 7.6.6 |
- optional_antenna_gain - Optional antenna gain in dBi (0 to 20). type: str
more...
|
Supported Version Ranges |
| optional_antenna_gain |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tim] |
v6.0.0 -> 7.6.6 |
| [ac-vo] |
v6.0.0 -> 7.6.6 |
| [no-obss-scan] |
v6.0.0 -> 7.6.6 |
| [no-11b-rate] |
v6.0.0 -> 7.6.6 |
| [client-rate-follow] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [rtscts] |
v6.0.0 -> 7.6.6 |
| [ctsonly] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_bssid - BSSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_bssid |
v7.0.0 -> 7.6.6 |
- sam_ca_certificate - CA certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| sam_ca_certificate |
v7.4.2 -> 7.6.6 |
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sam_captive_portal |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- sam_client_certificate - Client certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_client_certificate |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_password - Password for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_password |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
|
Supported Version Ranges |
| sam_cwp_test_url |
v7.0.1 -> 7.6.6 |
- sam_cwp_username - Username for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_username |
v7.0.1 -> 7.6.6 |
- sam_eap_method - Select WPA2/WPA3-ENTERPRISE EAP Method . type: str choices: both, tls, peap
more...
|
Supported Version Ranges |
| sam_eap_method |
v7.4.2 -> 7.6.6 |
| [both] |
v7.4.2 -> 7.6.6 |
| [tls] |
v7.4.2 -> 7.6.6 |
| [peap] |
v7.4.2 -> 7.6.6 |
- sam_password - Passphrase for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_password |
v7.0.0 -> 7.6.6 |
- sam_private_key - Private key for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_private_key |
v7.4.2 -> 7.6.6 |
- sam_private_key_password - Password for private key file for WPA2/WPA3-ENTERPRISE. type: str
more...
|
Supported Version Ranges |
| sam_private_key_password |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise, wpa3-sae, owe
more...
|
Supported Version Ranges |
| sam_security_type |
v7.0.0 -> 7.6.6 |
| [open] |
v7.0.0 -> 7.6.6 |
| [wpa-personal] |
v7.0.0 -> 7.6.6 |
| [wpa-enterprise] |
v7.0.0 -> 7.6.6 |
| [wpa3-sae] |
v7.4.2 -> 7.6.6 |
| [owe] |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_server_ip - SAM test server IP address. type: str
more...
|
Supported Version Ranges |
| sam_server_ip |
v7.0.1 -> 7.6.6 |
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
|
Supported Version Ranges |
| sam_server_type |
v7.0.1 -> 7.6.6 |
| [ip] |
v7.0.1 -> 7.6.6 |
| [fqdn] |
v7.0.1 -> 7.6.6 |
- sam_ssid - SSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_ssid |
v7.0.0 -> 7.6.6 |
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
|
Supported Version Ranges |
| sam_test |
v7.0.0 -> 7.6.6 |
| [ping] |
v7.0.0 -> 7.6.6 |
| [iperf] |
v7.0.0 -> 7.6.6 |
- sam_username - Username for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_username |
v7.0.0 -> 7.6.6 |
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211d |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- set_80211mc - Enable/disable 802.11mc responder mode . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211mc |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> v6.2.7 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.0.0 -> v6.2.7 |
- 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 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [power-save] |
v6.0.0 -> 7.6.6 |
| [aggr-limit] |
v6.0.0 -> 7.6.6 |
| [retry-limit] |
v6.0.0 -> 7.6.6 |
| [send-bar] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- radio_3 - Configuration options for radio 3. type: dict
more...
| Supported Version Ranges |
| radio_3 |
v6.2.0 -> 7.6.6 |
- ai_darrp_support - Enable/disable support for FortiAIOps to retrieve Distributed Automatic Radio Resource Provisioning (DARRP) data through REST API calls . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ai_darrp_support |
v7.6.5 -> 7.6.6 |
| [enable] |
v7.6.5 -> 7.6.6 |
| [disable] |
v7.6.5 -> 7.6.6 |
- airtime_fairness - Enable/disable airtime fairness . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| airtime_fairness |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- ap_sniffer_addr - MAC address to monitor. type: str
more...
|
Supported Version Ranges |
| ap_sniffer_addr |
v6.2.0 -> 7.6.6 |
- ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
more...
|
Supported Version Ranges |
| ap_sniffer_bufsize |
v6.2.0 -> 7.6.6 |
- ap_sniffer_chan - Channel on which to operate the sniffer . type: int
more...
|
Supported Version Ranges |
| ap_sniffer_chan |
v6.2.0 -> 7.6.6 |
- ap_sniffer_chan_width - Channel bandwidth for sniffer. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| ap_sniffer_chan_width |
v7.6.0 -> 7.6.6 |
| [320MHz] |
v7.6.0 -> 7.6.6 |
| [240MHz] |
v7.6.0 -> 7.6.6 |
| [160MHz] |
v7.6.0 -> 7.6.6 |
| [80MHz] |
v7.6.0 -> 7.6.6 |
| [40MHz] |
v7.6.0 -> 7.6.6 |
| [20MHz] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- band - WiFi band that Radio 3 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 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 -> 7.6.6 |
| [802.11a] |
v6.2.0 -> 7.6.6 |
| [802.11b] |
v6.2.0 -> 7.6.6 |
| [802.11g] |
v6.2.0 -> 7.6.6 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ac-2G] |
v6.4.0 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> 7.6.6 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.2.0 -> v7.4.3 |
| [802.11ac] |
v6.2.0 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v7.4.3 |
| [802.11n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11g-only] |
v6.2.0 -> v7.4.3 |
| [802.11n-only] |
v6.2.0 -> v7.4.3 |
| [802.11n-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v7.4.3 |
- 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 -> 7.6.6 |
| [5g-full] |
v6.2.0 -> v6.2.0 |
| [5g-high] |
v6.2.0 -> v6.2.0 |
| [5g-low] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
more...
|
Supported Version Ranges |
| bandwidth_capacity |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [auto] |
v7.0.2 -> 7.6.6 |
| [static] |
v7.0.2 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- channel - Selected list of wireless radio channels. type: list member_path: radio_3/channel:chan
more...
| Supported Version Ranges |
| channel |
v6.2.0 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.2.0 -> 7.6.6 |
- channel_bonding - Channel bandwidth: 320, 240, 160, 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| channel_bonding |
v6.2.0 -> 7.6.6 |
| [320MHz] |
v7.4.4 -> 7.6.6 |
| [240MHz] |
v7.4.4 -> 7.6.6 |
| [160MHz] |
v6.2.0 -> 7.6.6 |
| [80MHz] |
v6.2.0 -> 7.6.6 |
| [40MHz] |
v6.2.0 -> 7.6.6 |
| [20MHz] |
v6.2.0 -> 7.6.6 |
- channel_bonding_ext - Channel bandwidth extension: 320 MHz-1 and 320 MHz-2 . type: str choices: 320MHz-1, 320MHz-2
more...
|
Supported Version Ranges |
| channel_bonding_ext |
v7.4.4 -> 7.6.6 |
| [320MHz-1] |
v7.4.4 -> 7.6.6 |
| [320MHz-2] |
v7.4.4 -> 7.6.6 |
- channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| channel_utilization |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| drma |
v6.4.4 -> 7.6.6 |
| [disable] |
v6.4.4 -> 7.6.6 |
| [enable] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
| [low] |
v6.4.4 -> 7.6.6 |
| [medium] |
v6.4.4 -> 7.6.6 |
| [high] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
|
Supported Version Ranges |
| iperf_protocol |
v7.0.0 -> 7.6.6 |
| [udp] |
v7.0.0 -> 7.6.6 |
| [tcp] |
v7.0.0 -> 7.6.6 |
- iperf_server_port - Iperf service port number. type: int
more...
|
Supported Version Ranges |
| iperf_server_port |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
more...
|
Supported Version Ranges |
| max_distance |
v6.2.0 -> 7.6.6 |
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
|
Supported Version Ranges |
| mimo_mode |
v7.4.1 -> 7.6.6 |
| [default] |
v7.4.1 -> 7.6.6 |
| [1x1] |
v7.4.1 -> 7.6.6 |
| [2x2] |
v7.4.1 -> 7.6.6 |
| [3x3] |
v7.4.1 -> 7.6.6 |
| [4x4] |
v7.4.1 -> 7.6.6 |
| [8x8] |
v7.4.1 -> 7.6.6 |
- 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 -> 7.6.6 |
| [disabled] |
v6.2.0 -> 7.6.6 |
| [ap] |
v6.2.0 -> 7.6.6 |
| [monitor] |
v6.2.0 -> 7.6.6 |
| [sniffer] |
v6.2.0 -> 7.6.6 |
| [sam] |
v7.0.0 -> 7.6.6 |
- optional_antenna - Optional antenna used on FAP . type: str choices: none, custom, 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, FANT-04BEAX-0606-P-R
more...
|
Supported Version Ranges |
| optional_antenna |
v7.4.0 -> 7.6.6 |
| [none] |
v7.4.0 -> 7.6.6 |
| [custom] |
v7.4.2 -> 7.6.6 |
| [FANT-04ABGN-0606-O-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-1414-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-8065-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-O-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-P-R] |
v7.4.0 -> 7.6.6 |
| [FANT-10ACAX-1213-D-N] |
v7.4.0 -> 7.6.6 |
| [FANT-08ABGN-1213-D-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04BEAX-0606-P-R] |
v7.6.4 -> 7.6.6 |
- optional_antenna_gain - Optional antenna gain in dBi (0 to 20). type: str
more...
|
Supported Version Ranges |
| optional_antenna_gain |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tim] |
v6.2.0 -> 7.6.6 |
| [ac-vo] |
v6.2.0 -> 7.6.6 |
| [no-obss-scan] |
v6.2.0 -> 7.6.6 |
| [no-11b-rate] |
v6.2.0 -> 7.6.6 |
| [client-rate-follow] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [rtscts] |
v6.2.0 -> 7.6.6 |
| [ctsonly] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_bssid - BSSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_bssid |
v7.0.0 -> 7.6.6 |
- sam_ca_certificate - CA certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| sam_ca_certificate |
v7.4.2 -> 7.6.6 |
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sam_captive_portal |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- sam_client_certificate - Client certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_client_certificate |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_password - Password for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_password |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
|
Supported Version Ranges |
| sam_cwp_test_url |
v7.0.1 -> 7.6.6 |
- sam_cwp_username - Username for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_username |
v7.0.1 -> 7.6.6 |
- sam_eap_method - Select WPA2/WPA3-ENTERPRISE EAP Method . type: str choices: both, tls, peap
more...
|
Supported Version Ranges |
| sam_eap_method |
v7.4.2 -> 7.6.6 |
| [both] |
v7.4.2 -> 7.6.6 |
| [tls] |
v7.4.2 -> 7.6.6 |
| [peap] |
v7.4.2 -> 7.6.6 |
- sam_password - Passphrase for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_password |
v7.0.0 -> 7.6.6 |
- sam_private_key - Private key for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_private_key |
v7.4.2 -> 7.6.6 |
- sam_private_key_password - Password for private key file for WPA2/WPA3-ENTERPRISE. type: str
more...
|
Supported Version Ranges |
| sam_private_key_password |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise, wpa3-sae, owe
more...
|
Supported Version Ranges |
| sam_security_type |
v7.0.0 -> 7.6.6 |
| [open] |
v7.0.0 -> 7.6.6 |
| [wpa-personal] |
v7.0.0 -> 7.6.6 |
| [wpa-enterprise] |
v7.0.0 -> 7.6.6 |
| [wpa3-sae] |
v7.4.2 -> 7.6.6 |
| [owe] |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_server_ip - SAM test server IP address. type: str
more...
|
Supported Version Ranges |
| sam_server_ip |
v7.0.1 -> 7.6.6 |
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
|
Supported Version Ranges |
| sam_server_type |
v7.0.1 -> 7.6.6 |
| [ip] |
v7.0.1 -> 7.6.6 |
| [fqdn] |
v7.0.1 -> 7.6.6 |
- sam_ssid - SSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_ssid |
v7.0.0 -> 7.6.6 |
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
|
Supported Version Ranges |
| sam_test |
v7.0.0 -> 7.6.6 |
| [ping] |
v7.0.0 -> 7.6.6 |
| [iperf] |
v7.0.0 -> 7.6.6 |
- sam_username - Username for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_username |
v7.0.0 -> 7.6.6 |
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211d |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- set_80211mc - Enable/disable 802.11mc responder mode . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211mc |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- 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.2.0 -> v6.2.7 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.2.0 -> v6.2.7 |
- 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 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [power-save] |
v6.2.0 -> 7.6.6 |
| [aggr-limit] |
v6.2.0 -> 7.6.6 |
| [retry-limit] |
v6.2.0 -> 7.6.6 |
| [send-bar] |
v6.2.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- radio_4 - Configuration options for radio 4. type: dict
more...
| Supported Version Ranges |
| radio_4 |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- ai_darrp_support - Enable/disable support for FortiAIOps to retrieve Distributed Automatic Radio Resource Provisioning (DARRP) data through REST API calls . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ai_darrp_support |
v7.6.5 -> 7.6.6 |
| [enable] |
v7.6.5 -> 7.6.6 |
| [disable] |
v7.6.5 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- ap_sniffer_chan_width - Channel bandwidth for sniffer. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| ap_sniffer_chan_width |
v7.6.0 -> 7.6.6 |
| [320MHz] |
v7.6.0 -> 7.6.6 |
| [240MHz] |
v7.6.0 -> 7.6.6 |
| [160MHz] |
v7.6.0 -> 7.6.6 |
| [80MHz] |
v7.6.0 -> 7.6.6 |
| [40MHz] |
v7.6.0 -> 7.6.6 |
| [20MHz] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- band - WiFi band that Radio 4 operates on. type: list choices: 802.11a, 802.11b, 802.11g, 802.11n-2G, 802.11n-5G, 802.11ac-2G, 802.11ac-5G, 802.11ax-2G, 802.11ax-5G, 802.11ax-6G, 802.11be-2G, 802.11be-5G, 802.11be-6G, 802.11n, 802.11ac, 802.11ax, 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 -> 7.6.6 |
| [802.11a] |
v6.2.0 -> v6.2.0 |
| [802.11b] |
v6.2.0 -> v6.2.0 |
| [802.11g] |
v6.2.0 -> v6.2.0 |
| [802.11n-2G] |
v7.4.4 -> 7.6.6 |
| [802.11n-5G] |
v6.2.0 -> v6.2.0 |
| [802.11ac-2G] |
v6.4.0 -> 7.6.6 |
| [802.11ac-5G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-2G] |
v7.4.4 -> 7.6.6 |
| [802.11ax-5G] |
v6.2.0 -> v6.2.0 |
| [802.11ax-6G] |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [802.11be-2G] |
v7.4.4 -> 7.6.6 |
| [802.11be-5G] |
v7.4.4 -> 7.6.6 |
| [802.11be-6G] |
v7.4.4 -> 7.6.6 |
| [802.11n] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ac] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11n,g-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11g-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11n-5G-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ac,n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ac-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,ac-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,ac,n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax-5G-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,n-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax,n,g-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
| [802.11ax-only] |
v6.2.0 -> v6.2.0 |
v6.2.5 -> v7.4.3 |
- 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 -> 7.6.6 |
| [5g-full] |
v6.2.0 -> v6.2.0 |
| [5g-high] |
v6.2.0 -> v6.2.0 |
| [5g-low] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [auto] |
v7.0.2 -> 7.6.6 |
| [static] |
v7.0.2 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- chan - Channel number. type: str required: true
more...
|
Supported Version Ranges |
| chan |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- channel_bonding - Channel bandwidth: 320, 240, 160, 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz
more...
|
Supported Version Ranges |
| channel_bonding |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [320MHz] |
v7.4.4 -> 7.6.6 |
| [240MHz] |
v7.4.4 -> 7.6.6 |
| [160MHz] |
v6.2.0 -> v6.2.0 |
| [80MHz] |
v6.2.0 -> v6.2.0 |
| [40MHz] |
v6.2.0 -> v6.2.0 |
| [20MHz] |
v6.2.0 -> v6.2.0 |
- channel_bonding_ext - Channel bandwidth extension: 320 MHz-1 and 320 MHz-2 . type: str choices: 320MHz-1, 320MHz-2
more...
|
Supported Version Ranges |
| channel_bonding_ext |
v7.4.4 -> 7.6.6 |
| [320MHz-1] |
v7.4.4 -> 7.6.6 |
| [320MHz-2] |
v7.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- drma - Enable/disable dynamic radio mode assignment (DRMA) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| drma |
v6.4.4 -> 7.6.6 |
| [disable] |
v6.4.4 -> 7.6.6 |
| [enable] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
| [low] |
v6.4.4 -> 7.6.6 |
| [medium] |
v6.4.4 -> 7.6.6 |
| [high] |
v6.4.4 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- iperf_protocol - Iperf test protocol . type: str choices: udp, tcp
more...
|
Supported Version Ranges |
| iperf_protocol |
v7.0.0 -> 7.6.6 |
| [udp] |
v7.0.0 -> 7.6.6 |
| [tcp] |
v7.0.0 -> 7.6.6 |
- iperf_server_port - Iperf service port number. type: int
more...
|
Supported Version Ranges |
| iperf_server_port |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- mimo_mode - Configure radio MIMO mode . type: str choices: default, 1x1, 2x2, 3x3, 4x4, 8x8
more...
|
Supported Version Ranges |
| mimo_mode |
v7.4.1 -> 7.6.6 |
| [default] |
v7.4.1 -> 7.6.6 |
| [1x1] |
v7.4.1 -> 7.6.6 |
| [2x2] |
v7.4.1 -> 7.6.6 |
| [3x3] |
v7.4.1 -> 7.6.6 |
| [4x4] |
v7.4.1 -> 7.6.6 |
| [8x8] |
v7.4.1 -> 7.6.6 |
- mode - Mode of radio 4. Radio 4 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 -> 7.6.6 |
| [disabled] |
v6.2.0 -> v6.2.0 |
| [ap] |
v6.2.0 -> v6.2.0 |
| [monitor] |
v6.2.0 -> v6.2.0 |
| [sniffer] |
v6.2.0 -> v6.2.0 |
| [sam] |
v7.0.0 -> 7.6.6 |
- optional_antenna - Optional antenna used on FAP . type: str choices: none, custom, 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, FANT-04BEAX-0606-P-R
more...
|
Supported Version Ranges |
| optional_antenna |
v7.4.0 -> 7.6.6 |
| [none] |
v7.4.0 -> 7.6.6 |
| [custom] |
v7.4.2 -> 7.6.6 |
| [FANT-04ABGN-0606-O-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-1414-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-8065-P-N] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-O-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04ABGN-0606-P-R] |
v7.4.0 -> 7.6.6 |
| [FANT-10ACAX-1213-D-N] |
v7.4.0 -> 7.6.6 |
| [FANT-08ABGN-1213-D-R] |
v7.4.0 -> 7.6.6 |
| [FANT-04BEAX-0606-P-R] |
v7.6.4 -> 7.6.6 |
- optional_antenna_gain - Optional antenna gain in dBi (0 to 20). type: str
more...
|
Supported Version Ranges |
| optional_antenna_gain |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [dBm] |
v7.0.0 -> 7.6.6 |
| [percentage] |
v7.0.0 -> 7.6.6 |
- power_value - Radio EIRP power in dBm (1 - 33). type: int
more...
|
Supported Version Ranges |
| power_value |
v7.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tim] |
v6.2.0 -> v6.2.0 |
| [ac-vo] |
v6.2.0 -> v6.2.0 |
| [no-obss-scan] |
v6.2.0 -> v6.2.0 |
| [no-11b-rate] |
v6.2.0 -> v6.2.0 |
| [client-rate-follow] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [rtscts] |
v6.2.0 -> v6.2.0 |
| [ctsonly] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- sam_bssid - BSSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_bssid |
v7.0.0 -> 7.6.6 |
- sam_ca_certificate - CA certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| sam_ca_certificate |
v7.4.2 -> 7.6.6 |
- sam_captive_portal - Enable/disable Captive Portal Authentication . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sam_captive_portal |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- sam_client_certificate - Client certificate for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_client_certificate |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_password - Password for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_password |
v7.0.1 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_cwp_test_url - Website the client is trying to access. type: str
more...
|
Supported Version Ranges |
| sam_cwp_test_url |
v7.0.1 -> 7.6.6 |
- sam_cwp_username - Username for captive portal authentication. type: str
more...
|
Supported Version Ranges |
| sam_cwp_username |
v7.0.1 -> 7.6.6 |
- sam_eap_method - Select WPA2/WPA3-ENTERPRISE EAP Method . type: str choices: both, tls, peap
more...
|
Supported Version Ranges |
| sam_eap_method |
v7.4.2 -> 7.6.6 |
| [both] |
v7.4.2 -> 7.6.6 |
| [tls] |
v7.4.2 -> 7.6.6 |
| [peap] |
v7.4.2 -> 7.6.6 |
- sam_password - Passphrase for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_password |
v7.0.0 -> 7.6.6 |
- sam_private_key - Private key for WPA2/WPA3-ENTERPRISE. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| sam_private_key |
v7.4.2 -> 7.6.6 |
- sam_private_key_password - Password for private key file for WPA2/WPA3-ENTERPRISE. type: str
more...
|
Supported Version Ranges |
| sam_private_key_password |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_security_type - Select WiFi network security type . type: str choices: open, wpa-personal, wpa-enterprise, wpa3-sae, owe
more...
|
Supported Version Ranges |
| sam_security_type |
v7.0.0 -> 7.6.6 |
| [open] |
v7.0.0 -> 7.6.6 |
| [wpa-personal] |
v7.0.0 -> 7.6.6 |
| [wpa-enterprise] |
v7.0.0 -> 7.6.6 |
| [wpa3-sae] |
v7.4.2 -> 7.6.6 |
| [owe] |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- sam_server_ip - SAM test server IP address. type: str
more...
|
Supported Version Ranges |
| sam_server_ip |
v7.0.1 -> 7.6.6 |
- sam_server_type - Select SAM server type . type: str choices: ip, fqdn
more...
|
Supported Version Ranges |
| sam_server_type |
v7.0.1 -> 7.6.6 |
| [ip] |
v7.0.1 -> 7.6.6 |
| [fqdn] |
v7.0.1 -> 7.6.6 |
- sam_ssid - SSID for WiFi network. type: str
more...
|
Supported Version Ranges |
| sam_ssid |
v7.0.0 -> 7.6.6 |
- sam_test - Select SAM test type . type: str choices: ping, iperf
more...
|
Supported Version Ranges |
| sam_test |
v7.0.0 -> 7.6.6 |
| [ping] |
v7.0.0 -> 7.6.6 |
| [iperf] |
v7.0.0 -> 7.6.6 |
- sam_username - Username for WiFi network connection. type: str
more...
|
Supported Version Ranges |
| sam_username |
v7.0.0 -> 7.6.6 |
- set_80211d - Enable/disable 802.11d countryie. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211d |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- set_80211mc - Enable/disable 802.11mc responder mode . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| set_80211mc |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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.2.0 -> v6.2.0 |
| [scan-only] |
v6.4.1 -> v6.4.1 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [disable] |
v6.2.0 -> v6.2.0 |
| [power-save] |
v6.2.0 -> v6.2.0 |
| [aggr-limit] |
v6.2.0 -> v6.2.0 |
| [retry-limit] |
v6.2.0 -> v6.2.0 |
| [send-bar] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
| [tunnel] |
v6.4.0 -> 7.6.6 |
| [bridge] |
v6.4.0 -> 7.6.6 |
| [manual] |
v6.4.0 -> 7.6.6 |
| [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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- 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 -> 7.6.6 |
- dest_ip - Destination IP and mask for the split-tunneling subnet. type: str
more...
|
Supported Version Ranges |
| dest_ip |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
| [tunnel] |
v6.0.0 -> 7.6.6 |
| [local] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
- usb_port - Enable/disable USB port of the WTP . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| usb_port |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
- wan_port_auth - Set WAN port authentication mode . type: str choices: none, 802.1x
more...
|
Supported Version Ranges |
| wan_port_auth |
v7.0.2 -> 7.6.6 |
| [none] |
v7.0.2 -> 7.6.6 |
| [802.1x] |
v7.0.2 -> 7.6.6 |
- wan_port_auth_macsec - Enable/disable WAN port 802.1x supplicant MACsec policy . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| wan_port_auth_macsec |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
- 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 -> 7.6.6 |
| [all] |
v7.0.2 -> 7.6.6 |
| [EAP-FAST] |
v7.0.2 -> 7.6.6 |
| [EAP-TLS] |
v7.0.2 -> 7.6.6 |
| [EAP-PEAP] |
v7.0.2 -> 7.6.6 |
- wan_port_auth_password - Set WAN port 802.1x supplicant password. type: str
more...
|
Supported Version Ranges |
| wan_port_auth_password |
v7.0.2 -> 7.6.6 |
- 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 -> 7.6.6 |
- 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 -> 7.6.6 |
| [wan-lan] |
v6.0.0 -> 7.6.6 |
| [wan-only] |
v6.0.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- 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: ""
wireless_controller_wtp_profile:
admin_auth_tacacs_plus: " (source user.tacacs+.name)"
admin_restrict_local: "enable"
allowaccess: "https"
ap_country: "--"
ap_handoff: "enable"
apcfg_auto_cert: "enable"
apcfg_auto_cert_auto_regen_days: "30"
apcfg_auto_cert_crypto_algo: "rsa-1024"
apcfg_auto_cert_enroll_protocol: "none"
apcfg_auto_cert_est_ca_id: ""
apcfg_auto_cert_est_http_password: ""
apcfg_auto_cert_est_http_username: ""
apcfg_auto_cert_est_https_ca: " (source vpn.certificate.ca.name)"
apcfg_auto_cert_est_server: ""
apcfg_auto_cert_est_subject: ""
apcfg_auto_cert_est_subject_alt_name: ""
apcfg_auto_cert_scep_ca_id: ""
apcfg_auto_cert_scep_ec_name: "secp256r1"
apcfg_auto_cert_scep_https_ca: " (source vpn.certificate.ca.name)"
apcfg_auto_cert_scep_keysize: "1024"
apcfg_auto_cert_scep_keytype: "rsa"
apcfg_auto_cert_scep_password: ""
apcfg_auto_cert_scep_sub_fully_dn: ""
apcfg_auto_cert_scep_subject_alt_name: ""
apcfg_auto_cert_scep_url: ""
apcfg_mesh: "enable"
apcfg_mesh_ap_type: "ethernet"
apcfg_mesh_eth_bridge: "enable"
apcfg_mesh_ssid: " (source wireless-controller.vap.name)"
apcfg_profile: " (source wireless-controller.apcfg-profile.name)"
ble_profile: " (source wireless-controller.ble-profile.name)"
bonjour_profile: " (source wireless-controller.bonjour-profile.name)"
comment: "Comment."
console_login: "enable"
control_message_offload: "ebp-frame"
default_mesh_root: "enable"
deny_mac_list:
-
id: "40"
mac: ""
dtls_in_kernel: "enable"
dtls_policy: "clear-text"
energy_efficient_ethernet: "enable"
esl_ses_dongle:
apc_addr_type: "fqdn"
apc_fqdn: ""
apc_ip: ""
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: " (source system.interface.name)"
port_mode: "offline"
port_ssid: " (source system.interface.name)"
port1_mode: "offline"
port1_ssid: " (source system.interface.name)"
port2_mode: "offline"
port2_ssid: " (source system.interface.name)"
port3_mode: "offline"
port3_ssid: " (source system.interface.name)"
port4_mode: "offline"
port4_ssid: " (source system.interface.name)"
port5_mode: "offline"
port5_ssid: " (source system.interface.name)"
port6_mode: "offline"
port6_ssid: " (source system.interface.name)"
port7_mode: "offline"
port7_ssid: " (source system.interface.name)"
port8_mode: "offline"
port8_ssid: " (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: ""
aeroscout_server_port: "0"
ble_rtls: "none"
ble_rtls_accumulation_interval: "2"
ble_rtls_asset_addrgrp_list: " (source firewall.addrgrp.name)"
ble_rtls_asset_uuid_list1: ""
ble_rtls_asset_uuid_list2: ""
ble_rtls_asset_uuid_list3: ""
ble_rtls_asset_uuid_list4: ""
ble_rtls_protocol: "WSS"
ble_rtls_reporting_interval: "2"
ble_rtls_server_fqdn: ""
ble_rtls_server_path: ""
ble_rtls_server_port: "443"
ble_rtls_server_token: ""
ekahau_blink_mode: "enable"
ekahau_tag: ""
erc_server_ip: ""
erc_server_port: "8569"
fortipresence: "foreign"
fortipresence_ble: "enable"
fortipresence_frequency: "30"
fortipresence_port: "3000"
fortipresence_project: ""
fortipresence_rogue: "enable"
fortipresence_secret: ""
fortipresence_server: ""
fortipresence_server_addr_type: "ipv4"
fortipresence_server_fqdn: ""
fortipresence_unassoc: "enable"
polestar: "enable"
polestar_accumulation_interval: "2"
polestar_asset_addrgrp_list: " (source firewall.addrgrp.name)"
polestar_asset_uuid_list1: ""
polestar_asset_uuid_list2: ""
polestar_asset_uuid_list3: ""
polestar_asset_uuid_list4: ""
polestar_protocol: "WSS"
polestar_reporting_interval: "2"
polestar_server_fqdn: ""
polestar_server_path: ""
polestar_server_port: "443"
polestar_server_token: ""
station_locate: "enable"
led_schedules:
-
name: "default_name_137 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
led_state: "enable"
lldp: "enable"
login_passwd: ""
login_passwd_change: "yes"
lw_profile: " (source wireless-controller.lw-profile.name)"
max_clients: "0"
name: "default_name_144"
platform:
ddscan: "enable"
mode: "single-5G"
type: "AP-11N"
poe_mode: "auto"
radio_1:
ai_darrp_support: "enable"
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: ""
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "36"
ap_sniffer_chan_width: "320MHz"
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: " (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
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: ""
channel_bonding: "320MHz"
channel_bonding_ext: "320MHz-1"
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"
optional_antenna_gain: ""
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "2"
rts_threshold: "2346"
sam_bssid: ""
sam_ca_certificate: " (source vpn.certificate.ca.name)"
sam_captive_portal: "enable"
sam_client_certificate: " (source vpn.certificate.local.name)"
sam_cwp_failure_string: ""
sam_cwp_match_string: ""
sam_cwp_password: ""
sam_cwp_success_string: ""
sam_cwp_test_url: ""
sam_cwp_username: ""
sam_eap_method: "both"
sam_password: ""
sam_private_key: " (source vpn.certificate.local.name)"
sam_private_key_password: ""
sam_report_intv: "0"
sam_security_type: "open"
sam_server: ""
sam_server_fqdn: ""
sam_server_ip: ""
sam_server_type: "ip"
sam_ssid: ""
sam_test: "ping"
sam_username: ""
set_80211d: "enable"
set_80211mc: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_235 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: " (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_2:
ai_darrp_support: "enable"
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: ""
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "6"
ap_sniffer_chan_width: "320MHz"
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: " (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
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: ""
channel_bonding: "320MHz"
channel_bonding_ext: "320MHz-1"
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"
optional_antenna_gain: ""
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "2"
rts_threshold: "2346"
sam_bssid: ""
sam_ca_certificate: " (source vpn.certificate.ca.name)"
sam_captive_portal: "enable"
sam_client_certificate: " (source vpn.certificate.local.name)"
sam_cwp_failure_string: ""
sam_cwp_match_string: ""
sam_cwp_password: ""
sam_cwp_success_string: ""
sam_cwp_test_url: ""
sam_cwp_username: ""
sam_eap_method: "both"
sam_password: ""
sam_private_key: " (source vpn.certificate.local.name)"
sam_private_key_password: ""
sam_report_intv: "0"
sam_security_type: "open"
sam_server: ""
sam_server_fqdn: ""
sam_server_ip: ""
sam_server_type: "ip"
sam_ssid: ""
sam_test: "ping"
sam_username: ""
set_80211d: "enable"
set_80211mc: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_323 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: " (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_3:
ai_darrp_support: "enable"
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: ""
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "37"
ap_sniffer_chan_width: "320MHz"
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: " (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
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: ""
channel_bonding: "320MHz"
channel_bonding_ext: "320MHz-1"
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"
optional_antenna_gain: ""
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
radio_id: "2"
rts_threshold: "2346"
sam_bssid: ""
sam_ca_certificate: " (source vpn.certificate.ca.name)"
sam_captive_portal: "enable"
sam_client_certificate: " (source vpn.certificate.local.name)"
sam_cwp_failure_string: ""
sam_cwp_match_string: ""
sam_cwp_password: ""
sam_cwp_success_string: ""
sam_cwp_test_url: ""
sam_cwp_username: ""
sam_eap_method: "both"
sam_password: ""
sam_private_key: " (source vpn.certificate.local.name)"
sam_private_key_password: ""
sam_report_intv: "0"
sam_security_type: "open"
sam_server: ""
sam_server_fqdn: ""
sam_server_ip: ""
sam_server_type: "ip"
sam_ssid: ""
sam_test: "ping"
sam_username: ""
set_80211d: "enable"
set_80211mc: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_411 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: " (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
radio_4:
ai_darrp_support: "enable"
airtime_fairness: "enable"
amsdu: "enable"
ap_handoff: "enable"
ap_sniffer_addr: ""
ap_sniffer_bufsize: "16"
ap_sniffer_chan: "6"
ap_sniffer_chan_width: "320MHz"
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: " (source wireless-controller.arrp-profile.name)"
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: ""
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: ""
channel_bonding: "320MHz"
channel_bonding_ext: "320MHz-1"
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"
optional_antenna_gain: ""
power_level: "100"
power_mode: "dBm"
power_value: "27"
powersave_optimize: "tim"
protection_mode: "rtscts"
rts_threshold: "2346"
sam_bssid: ""
sam_ca_certificate: " (source vpn.certificate.ca.name)"
sam_captive_portal: "enable"
sam_client_certificate: " (source vpn.certificate.local.name)"
sam_cwp_failure_string: ""
sam_cwp_match_string: ""
sam_cwp_password: ""
sam_cwp_success_string: ""
sam_cwp_test_url: ""
sam_cwp_username: ""
sam_eap_method: "both"
sam_password: ""
sam_private_key: " (source vpn.certificate.local.name)"
sam_private_key_password: ""
sam_report_intv: "0"
sam_security_type: "open"
sam_server: ""
sam_server_fqdn: ""
sam_server_ip: ""
sam_server_type: "ip"
sam_ssid: ""
sam_test: "ping"
sam_username: ""
set_80211d: "enable"
set_80211mc: "enable"
short_guard_interval: "enable"
spectrum_analysis: "enable"
transmit_optimize: "disable"
vap_all: "tunnel"
vaps:
-
name: "default_name_498 (source wireless-controller.vap-group.name system.interface.name)"
wids_profile: " (source wireless-controller.wids-profile.name)"
zero_wait_dfs: "enable"
split_tunneling_acl:
-
dest_ip: ""
id: "503"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
syslog_profile: " (source wireless-controller.syslog-profile.name)"
tun_mtu_downlink: "0"
tun_mtu_uplink: "0"
unii_4_5ghz_band: "enable"
usb_port: "enable"
wan_port_auth: "none"
wan_port_auth_macsec: "enable"
wan_port_auth_methods: "all"
wan_port_auth_password: ""
wan_port_auth_usrname: ""
wan_port_mode: "wan-lan"
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- 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
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- 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.