fmgd_wireless_wtpprofile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

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

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • wireless_wtpprofile - Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. type: dict
    • _is_factory_setting Is factory setting. type: str choices: [disable, enable, ext] default: disable more...
    • allowaccess Control management access to the managed wtp, fortiap, or ap. type: list choices: [https, ssh, snmp, http, telnet] more...
    • ap_country (Alias name: ap-country) Country in which this wtp, fortiap, or ap will operate (default = na, automatically use the country configured for the current vdom). type: str choices: [AL, DZ, AR, AM, AU, AT, AZ, BH, BD, BY, BE, BZ, BO, BA, BR, BN, BG, CA, CL, CN, CO, CR, HR, CY, CZ, DK, DO, EC, EG, SV, EE, FI, FR, GE, DE, GR, GT, HN, HK, HU, IS, IN, ID, IR, IE, IL, IT, JM, JP, JO, KZ, KE, KP, KR, KW, LV, LB, LI, LT, LU, MO, MK, MY, MT, MX, MC, MA, NP, NL, AN, NZ, NO, OM, PK, PA, PG, PE, PH, PL, PT, PR, QA, RO, RU, SA, SG, SK, SI, ZA, ES, LK, SE, CH, SY, TW, TH, TT, TN, TR, AE, UA, GB, US, PS, UY, UZ, VE, VN, YE, ZW, NA, BS, VC, KH, MV, AF, NG, TZ, ZM, SN, CI, GH, SD, CM, MW, AO, GA, ML, BJ, MG, TD, BW, LY, RW, MZ, GM, LS, MU, CG, UG, BF, SL, SO, CD, NE, CF, SZ, TG, LR, MR, DJ, RE, RS, ME, IQ, MD, KY, BB, BM, TC, VI, PM, MF, GD, IM, FO, GI, GL, TM, MN, VU, FJ, LA, GU, WF, MH, BT, FM, PF, NI, PY, HT, GY, AW, KN, GF, AS, MP, PW, MM, LC, GP, ET, SR, ZB, CX, DM, MQ, YT, BL, --, TL] more...
    • ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable] more...
    • apcfg_profile (Alias name: apcfg-profile) Ap local configuration profile name. type: list more...
    • ble_profile (Alias name: ble-profile) Bluetooth low energy profile name. type: list more...
    • bonjour_profile (Alias name: bonjour-profile) Bonjour profile name. type: list more...
    • comment Comment. type: str more...
    • console_login (Alias name: console-login) Enable/disable fortiap console login access (default = enable). type: str choices: [disable, enable] more...
    • control_message_offload (Alias name: 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...
    • deny_mac_list (Alias name: deny-mac-list) Deny mac list. type: list more...
      • id Id. type: int more...
      • mac A wifi device with this mac address is denied access to this wtp, fortiap or ap. type: str more...
    • dtls_in_kernel (Alias name: dtls-in-kernel) Enable/disable data channel dtls in kernel. type: str choices: [disable, enable] more...
    • dtls_policy (Alias name: dtls-policy) Wtp data channel dtls policy (default = clear-text). type: list choices: [clear-text, dtls-enabled, ipsec-vpn, ipsec-sn-vpn] more...
    • energy_efficient_ethernet (Alias name: energy-efficient-ethernet) Enable/disable use of energy efficient ethernet on wtp. type: str choices: [disable, enable] more...
    • esl_ses_dongle (Alias name: esl-ses-dongle) Esl ses dongle. type: dict more...
      • apc_addr_type (Alias name: apc-addr-type) Esl ses-imagotag apc address type (default = fqdn). type: str choices: [fqdn, ip] more...
      • apc_fqdn (Alias name: apc-fqdn) Fqdn of esl ses-imagotag access point controller (apc). type: str more...
      • apc_ip (Alias name: apc-ip) Ip address of esl ses-imagotag access point controller (apc). type: str more...
      • apc_port (Alias name: apc-port) Port of esl ses-imagotag access point controller (apc). type: int more...
      • coex_level (Alias name: coex-level) Esl ses-imagotag dongle coexistence level (default = none). type: str choices: [none] more...
      • compliance_level (Alias name: compliance-level) Compliance levels for the esl solution integration (default = compliance-level-2). type: str choices: [compliance-level-2] more...
      • esl_channel (Alias name: esl-channel) Esl ses-imagotag dongle channel (default = 127). type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 127, -1] more...
      • output_power (Alias name: output-power) Esl ses-imagotag dongle output power (default = a). type: str choices: [a, b, c, d, e, f, g, h] more...
      • scd_enable (Alias name: scd-enable) Enable/disable esl ses-imagotag serial communication daemon (scd) (default = disable). type: str choices: [disable, enable] more...
      • tls_cert_verification (Alias name: tls-cert-verification) Enable/disable tls certificate verification (default = enable). type: str choices: [disable, enable] more...
      • tls_fqdn_verification (Alias name: tls-fqdn-verification) Enable/disable tls certificate verification (default = disable). type: str choices: [disable, enable] more...
    • ext_info_enable (Alias name: ext-info-enable) Enable/disable station/vap/radio extension information. type: str choices: [disable, enable] more...
    • frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
    • handoff_roaming (Alias name: handoff-roaming) Enable/disable client load balancing during roaming to avoid roaming delay (default = disable). type: str choices: [disable, enable] more...
    • handoff_rssi (Alias name: handoff-rssi) Minimum received signal strength indicator (rssi) value for handoff (20 - 30, default = 25). type: int more...
    • handoff_sta_thresh (Alias name: handoff-sta-thresh) Threshold value for ap handoff. type: int more...
    • indoor_outdoor_deployment (Alias name: indoor-outdoor-deployment) Set to allow indoor/outdoor-only channels under regulatory rules (default = platform-determined). type: str choices: [platform-determined, outdoor, indoor] more...
    • ip_fragment_preventing (Alias name: ip-fragment-preventing) Method(s) by which ip fragmentation is prevented for control and data packets through capwap tunnel (default = tcp-mss-adjust). type: list choices: [tcp-mss-adjust, icmp-unreachable] more...
    • lan Lan. type: dict more...
      • port_esl_mode (Alias name: port-esl-mode) Esl port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port_esl_ssid (Alias name: port-esl-ssid) Bridge esl port to ssid. type: list more...
      • port_mode (Alias name: port-mode) Lan port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port_ssid (Alias name: port-ssid) Bridge lan port to ssid. type: list more...
      • port1_mode (Alias name: port1-mode) Lan port 1 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port1_ssid (Alias name: port1-ssid) Bridge lan port 1 to ssid. type: list more...
      • port2_mode (Alias name: port2-mode) Lan port 2 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port2_ssid (Alias name: port2-ssid) Bridge lan port 2 to ssid. type: list more...
      • port3_mode (Alias name: port3-mode) Lan port 3 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port3_ssid (Alias name: port3-ssid) Bridge lan port 3 to ssid. type: list more...
      • port4_mode (Alias name: port4-mode) Lan port 4 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port4_ssid (Alias name: port4-ssid) Bridge lan port 4 to ssid. type: list more...
      • port5_mode (Alias name: port5-mode) Lan port 5 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port5_ssid (Alias name: port5-ssid) Bridge lan port 5 to ssid. type: list more...
      • port6_mode (Alias name: port6-mode) Lan port 6 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port6_ssid (Alias name: port6-ssid) Bridge lan port 6 to ssid. type: list more...
      • port7_mode (Alias name: port7-mode) Lan port 7 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port7_ssid (Alias name: port7-ssid) Bridge lan port 7 to ssid. type: list more...
      • port8_mode (Alias name: port8-mode) Lan port 8 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port8_ssid (Alias name: port8-ssid) Bridge lan port 8 to ssid. type: list more...
    • lbs Lbs. type: dict more...
      • aeroscout Enable/disable aeroscout real time location service (rtls) support (default = disable). type: str choices: [disable, enable] more...
      • aeroscout_ap_mac (Alias name: aeroscout-ap-mac) Use bssid or board mac address as ap mac address in aeroscout ap messages (default = bssid). type: str choices: [bssid, board-mac] more...
      • aeroscout_mmu_report (Alias name: aeroscout-mmu-report) Enable/disable compounded aeroscout tag and mu report (default = enable). type: str choices: [disable, enable] more...
      • aeroscout_mu (Alias name: aeroscout-mu) Enable/disable aeroscout mobile unit (mu) support (default = disable). type: str choices: [disable, enable] more...
      • aeroscout_mu_factor (Alias name: aeroscout-mu-factor) Aeroscout mu mode dilution factor (default = 20). type: int more...
      • aeroscout_mu_timeout (Alias name: aeroscout-mu-timeout) Aeroscout mu mode timeout (0 - 65535 sec, default = 5). type: int more...
      • aeroscout_server_ip (Alias name: aeroscout-server-ip) Ip address of aeroscout server. type: str more...
      • aeroscout_server_port (Alias name: aeroscout-server-port) Aeroscout server udp listening port. type: int more...
      • ekahau_blink_mode (Alias name: ekahau-blink-mode) Enable/disable ekahau blink mode (now known as airista flow) to track and locate wifi tags (default = disable). type: str choices: [disable, enable] more...
      • ekahau_tag (Alias name: ekahau-tag) Wifi frame mac address or wifi tag. type: str more...
      • erc_server_ip (Alias name: erc-server-ip) Ip address of ekahau rtls controller (erc). type: str more...
      • erc_server_port (Alias name: erc-server-port) Ekahau rtls controller (erc) udp listening port. type: int more...
      • fortipresence Enable/disable fortipresence to monitor the location and activity of wifi clients even if they dont connect to this wifi network (default = disable). type: str choices: [disable, enable, enable2, foreign, both] more...
      • fortipresence_ble (Alias name: fortipresence-ble) Enable/disable fortipresence finding and reporting ble devices. type: str choices: [disable, enable] more...
      • fortipresence_frequency (Alias name: fortipresence-frequency) Fortipresence report transmit frequency (5 - 65535 sec, default = 30). type: int more...
      • fortipresence_port (Alias name: fortipresence-port) Udp listening port of fortipresence server (default = 3000). type: int more...
      • fortipresence_project (Alias name: fortipresence-project) Fortipresence project name (max. type: str more...
      • fortipresence_rogue (Alias name: fortipresence-rogue) Enable/disable fortipresence finding and reporting rogue aps. type: str choices: [disable, enable] more...
      • fortipresence_secret (Alias name: fortipresence-secret) Fortipresence secret password (max. type: list more...
      • fortipresence_server (Alias name: fortipresence-server) Ip address of fortipresence server. type: str more...
      • fortipresence_server_addr_type (Alias name: fortipresence-server-addr-type) Fortipresence server address type (default = ipv4). type: str choices: [fqdn, ipv4] more...
      • fortipresence_server_fqdn (Alias name: fortipresence-server-fqdn) Fqdn of fortipresence server. type: str more...
      • fortipresence_unassoc (Alias name: fortipresence-unassoc) Enable/disable fortipresence finding and reporting unassociated stations. type: str choices: [disable, enable] more...
      • polestar Enable/disable polestar ble nao track real time location service (rtls) support (default = disable). type: str choices: [disable, enable] more...
      • polestar_accumulation_interval (Alias name: polestar-accumulation-interval) Time that measurements should be accumulated in seconds (default = 2). type: int more...
      • polestar_asset_addrgrp_list (Alias name: polestar-asset-addrgrp-list) Tags and asset addrgrp list to be reported. type: list more...
      • polestar_asset_uuid_list1 (Alias name: 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...
      • polestar_asset_uuid_list2 (Alias name: 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...
      • polestar_asset_uuid_list3 (Alias name: 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...
      • polestar_asset_uuid_list4 (Alias name: 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...
      • polestar_protocol (Alias name: polestar-protocol) Select the protocol to report measurements, advertising data, or location data to nao cloud. type: str choices: [WSS] more...
      • polestar_reporting_interval (Alias name: polestar-reporting-interval) Time between reporting accumulated measurements in seconds (default = 2). type: int more...
      • polestar_server_fqdn (Alias name: polestar-server-fqdn) Fqdn of polestar nao track server (default = ws. type: str more...
      • polestar_server_path (Alias name: polestar-server-path) Path of polestar nao track server (default = /v1/token//pst-v2). type: str more...
      • polestar_server_port (Alias name: polestar-server-port) Port of polestar nao track server (default = 443). type: int more...
      • polestar_server_token (Alias name: polestar-server-token) Access token of polestar nao track server. type: str more...
      • station_locate (Alias name: station-locate) Enable/disable client station locating services for all clients, whether associated or not (default = disable). type: str choices: [disable, enable] more...
      • ble_rtls (Alias name: ble-rtls) Set ble real time location service (rtls) support (default = none). type: str choices: [none, polestar, evresys] more...
      • ble_rtls_accumulation_interval (Alias name: ble-rtls-accumulation-interval) Time that measurements should be accumulated in seconds (default = 2). type: int more...
      • ble_rtls_asset_addrgrp_list (Alias name: ble-rtls-asset-addrgrp-list) Tags and asset addrgrp list to be reported. type: list more...
      • ble_rtls_asset_uuid_list1 (Alias name: 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...
      • ble_rtls_asset_uuid_list2 (Alias name: 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...
      • ble_rtls_asset_uuid_list3 (Alias name: 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...
      • ble_rtls_asset_uuid_list4 (Alias name: 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...
      • ble_rtls_protocol (Alias name: ble-rtls-protocol) Select the protocol to report measurements, advertising data, or location data to cloud server. type: str choices: [WSS] more...
      • ble_rtls_reporting_interval (Alias name: ble-rtls-reporting-interval) Time between reporting accumulated measurements in seconds (default = 2). type: int more...
      • ble_rtls_server_fqdn (Alias name: ble-rtls-server-fqdn) Fqdn of ble real time location service (rtls) server. type: str more...
      • ble_rtls_server_path (Alias name: ble-rtls-server-path) Path of ble real time location service (rtls) server. type: str more...
      • ble_rtls_server_port (Alias name: ble-rtls-server-port) Port of ble real time location service (rtls) server (default = 443). type: int more...
      • ble_rtls_server_token (Alias name: ble-rtls-server-token) Access token of ble real time location service (rtls) server. type: str more...
    • led_schedules (Alias name: led-schedules) Recurring firewall schedules for illuminating leds on the fortiap. type: list more...
    • led_state (Alias name: led-state) Enable/disable use of leds on wtp (default = disable). type: str choices: [disable, enable] more...
    • lldp Enable/disable link layer discovery protocol (lldp) for the wtp, fortiap, or ap (default = enable). type: str choices: [disable, enable] more...
    • login_passwd (Alias name: login-passwd) Set the managed wtp, fortiap, or aps administrator password. type: list more...
    • login_passwd_change (Alias name: login-passwd-change) Change or reset the administrator password of a managed wtp, fortiap or ap (yes, default, or no, default = no). type: str choices: [no, yes, default] more...
    • max_clients (Alias name: max-clients) Maximum number of stations (stas) supported by the wtp (default = 0, meaning no client limitation). type: int more...
    • name Wtp (or fortiap or ap) profile name. type: str more...
    • platform Platform. type: dict more...
      • _local_platform_str Local platform str. type: str more...
      • ddscan Enable/disable use of one radio for dedicated full-band scanning to detect rf characterization and wireless threat management. type: str choices: [disable, enable] more...
      • mode Configure operation mode of 5g radios (default = single-5g). type: str choices: [dual-5G, single-5G] more...
      • type Wtp, fortiap or ap platform type. type: str choices: [30B-50B, 60B, 80CM-81CM, 220A, 220B, 210B, 60C, 222B, 112B, 320B, 11C, 14C, 223B, 28C, 320C, 221C, 25D, 222C, 224D, 214B, 21D, 24D, 112D, 223C, 321C, C220C, C225C, S321C, S323C, FWF, S311C, S313C, AP-11N, S322C, S321CR, S322CR, S323CR, S421E, S422E, S423E, 421E, 423E, C221E, C226E, C23JD, C24JE, C21D, U421E, U423E, 221E, 222E, 223E, S221E, S223E, U221EV, U223EV, U321EV, U323EV, 224E, U422EV, U24JEV, 321E, U431F, U433F, 231E, 431F, 433F, 231F, 432F, 234F, 23JF, U231F, 831F, U234F, U432F, 431FL, 432FR, 433FL, 231FL, 231G, 233G, 431G, 433G, U231G, U441G, 234G, 432G, 441K, 443K, 241K, 243K, 231K, 23JK, 222KL, 244K, 432K, MVP, 231KD] more...
    • poe_mode (Alias name: poe-mode) Set the wtp, fortiap, or aps poe mode. type: str choices: [auto, 8023af, 8023at, power-adapter, full, high, low] more...
    • radio_1 (Alias name: radio-1) Radio 1. type: dict more...
      • d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable] more...
      • airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...
      • amsdu Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str more...
      • ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int more...
      • ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int more...
      • ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_beacon (Alias name: ap-sniffer-mgmt-beacon) Enable/disable sniffer on wifi management beacon frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_other (Alias name: ap-sniffer-mgmt-other) Enable/disable sniffer on wifi management other frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_probe (Alias name: ap-sniffer-mgmt-probe) Enable/disable sniffer on wifi management probe frames (default = enable). type: str choices: [disable, enable] more...
      • arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: list more...
      • auto_power_high (Alias name: 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...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: 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...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 1 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low] more...
      • bandwidth_admission_control (Alias name: bandwidth-admission-control) Enable/disable wifi multimedia (wmm) bandwidth admission control to optimize wifi bandwidth use. type: str choices: [disable, enable] more...
      • bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int more...
      • beacon_interval (Alias name: beacon-interval) Beacon interval. type: int more...
      • bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, disable = 0, default = 0). type: int more...
      • bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...
      • call_admission_control (Alias name: call-admission-control) Enable/disable wifi multimedia (wmm) call admission control to optimize wifi bandwidth use for voip calls. type: str choices: [disable, enable] more...
      • call_capacity (Alias name: call-capacity) Maximum number of voice over wlan (vowlan) phones supported by the radio (0 - 60, default = 10). type: int more...
      • channel Selected list of wireless radio channels. type: list more...
      • channel_bonding (Alias name: channel-bonding) Channel bandwidth: 320, 240, 160, 80, 40, or 20mhz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz, 160MHz, 320MHz, 240MHz] more...
      • channel_bonding_ext (Alias name: channel-bonding-ext) Channel bandwidth extension: 320 mhz-1 and 320 mhz-2 (default = 320 mhz-2). type: str choices: [320MHz-1, 320MHz-2] more...
      • channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable] more...
      • coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable] more...
      • darrp Enable/disable distributed automatic radio resource provisioning (darrp) to make sure the radio is always using the most optimal channel (default = disable). type: str choices: [disable, enable] more...
      • drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable] more...
      • drma_sensitivity (Alias name: drma-sensitivity) Network coverage factor (ncf) percentage required to consider a radio as redundant (default = low). type: str choices: [low, medium, high] more...
      • dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int more...
      • frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...
      • iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp] more...
      • iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int more...
      • max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int more...
      • max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int more...
      • mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8] more...
      • mode Mode of radio 1. type: str choices: [disabled, ap, monitor, sniffer, sam] more...
      • optional_antenna (Alias name: optional-antenna) Optional antenna used on fap (default = none). type: str choices: [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R, custom, FANT-04BEAX-0606-P-R] more...
      • optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • powersave_optimize (Alias name: 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...
      • protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • rts_threshold (Alias name: rts-threshold) Maximum packet size for rts transmissions, specifying the maximum size of a data packet before rts/cts (256 - 2346 bytes, default = 2346). type: int more...
      • sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str more...
      • sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable] more...
      • sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str more...
      • sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str more...
      • sam_cwp_password (Alias name: sam-cwp-password) Password for captive portal authentication. type: list more...
      • sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str more...
      • sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str more...
      • sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str more...
      • sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both] more...
      • sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list more...
      • sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: list more...
      • sam_private_key_password (Alias name: sam-private-key-password) Password for private key file for wpa2/wpa3-enterprise. type: list more...
      • sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int more...
      • sam_security_type (Alias name: sam-security-type) Select wifi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise, owe, wpa3-sae] more...
      • sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str more...
      • sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str more...
      • sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn] more...
      • sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str more...
      • sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf] more...
      • sam_username (Alias name: sam-username) Username for wifi network connection. type: str more...
      • short_guard_interval (Alias name: 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: [disable, enable] more...
      • transmit_optimize (Alias name: transmit-optimize) Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. type: list choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: list more...
      • zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable] more...
      • sam_server (Alias name: sam-server) Sam server. type: str more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable] more...
      • frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
      • d80211mc (Alias name: 80211mc) Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_chan_width (Alias name: ap-sniffer-chan-width) Channel bandwidth for sniffer. type: str choices: [320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz] more...
      • ai_darrp_support (Alias name: ai-darrp-support) Enable/disable support for fortiaiops to retrieve distributed automatic radio resource provisioning (darrp) data through rest api calls (default = disable). type: str choices: [disable, enable] more...
    • radio_2 (Alias name: radio-2) Radio 2. type: dict more...
      • d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable] more...
      • airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...
      • amsdu Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str more...
      • ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int more...
      • ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int more...
      • ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_beacon (Alias name: ap-sniffer-mgmt-beacon) Enable/disable sniffer on wifi management beacon frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_other (Alias name: ap-sniffer-mgmt-other) Enable/disable sniffer on wifi management other frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_probe (Alias name: ap-sniffer-mgmt-probe) Enable/disable sniffer on wifi management probe frames (default = enable). type: str choices: [disable, enable] more...
      • arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: list more...
      • auto_power_high (Alias name: 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...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: 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...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 2 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low] more...
      • bandwidth_admission_control (Alias name: bandwidth-admission-control) Enable/disable wifi multimedia (wmm) bandwidth admission control to optimize wifi bandwidth use. type: str choices: [disable, enable] more...
      • bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int more...
      • beacon_interval (Alias name: beacon-interval) Beacon interval. type: int more...
      • bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, disable = 0, default = 0). type: int more...
      • bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...
      • call_admission_control (Alias name: call-admission-control) Enable/disable wifi multimedia (wmm) call admission control to optimize wifi bandwidth use for voip calls. type: str choices: [disable, enable] more...
      • call_capacity (Alias name: call-capacity) Maximum number of voice over wlan (vowlan) phones supported by the radio (0 - 60, default = 10). type: int more...
      • channel Selected list of wireless radio channels. type: list more...
      • channel_bonding (Alias name: channel-bonding) Channel bandwidth: 320, 240, 160, 80, 40, or 20mhz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz, 160MHz, 320MHz, 240MHz] more...
      • channel_bonding_ext (Alias name: channel-bonding-ext) Channel bandwidth extension: 320 mhz-1 and 320 mhz-2 (default = 320 mhz-2). type: str choices: [320MHz-1, 320MHz-2] more...
      • channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable] more...
      • coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable] more...
      • darrp Enable/disable distributed automatic radio resource provisioning (darrp) to make sure the radio is always using the most optimal channel (default = disable). type: str choices: [disable, enable] more...
      • drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable] more...
      • drma_sensitivity (Alias name: drma-sensitivity) Network coverage factor (ncf) percentage required to consider a radio as redundant (default = low). type: str choices: [low, medium, high] more...
      • dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int more...
      • frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...
      • iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp] more...
      • iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int more...
      • max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int more...
      • max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int more...
      • mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8] more...
      • mode Mode of radio 2. type: str choices: [disabled, ap, monitor, sniffer, sam] more...
      • optional_antenna (Alias name: optional-antenna) Optional antenna used on fap (default = none). type: str choices: [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R, custom, FANT-04BEAX-0606-P-R] more...
      • optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • powersave_optimize (Alias name: 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...
      • protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • rts_threshold (Alias name: rts-threshold) Maximum packet size for rts transmissions, specifying the maximum size of a data packet before rts/cts (256 - 2346 bytes, default = 2346). type: int more...
      • sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str more...
      • sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable] more...
      • sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str more...
      • sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str more...
      • sam_cwp_password (Alias name: sam-cwp-password) Password for captive portal authentication. type: list more...
      • sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str more...
      • sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str more...
      • sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str more...
      • sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both] more...
      • sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list more...
      • sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: list more...
      • sam_private_key_password (Alias name: sam-private-key-password) Password for private key file for wpa2/wpa3-enterprise. type: list more...
      • sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int more...
      • sam_security_type (Alias name: sam-security-type) Select wifi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise, owe, wpa3-sae] more...
      • sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str more...
      • sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str more...
      • sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn] more...
      • sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str more...
      • sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf] more...
      • sam_username (Alias name: sam-username) Username for wifi network connection. type: str more...
      • short_guard_interval (Alias name: 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: [disable, enable] more...
      • transmit_optimize (Alias name: transmit-optimize) Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. type: list choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: list more...
      • zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable] more...
      • sam_server (Alias name: sam-server) Sam server. type: str more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable] more...
      • frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
      • d80211mc (Alias name: 80211mc) Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_chan_width (Alias name: ap-sniffer-chan-width) Channel bandwidth for sniffer. type: str choices: [320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz] more...
      • ai_darrp_support (Alias name: ai-darrp-support) Enable/disable support for fortiaiops to retrieve distributed automatic radio resource provisioning (darrp) data through rest api calls (default = disable). type: str choices: [disable, enable] more...
    • radio_3 (Alias name: radio-3) Radio 3. type: dict more...
      • d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable] more...
      • airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...
      • amsdu Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str more...
      • ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int more...
      • ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int more...
      • ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_beacon (Alias name: ap-sniffer-mgmt-beacon) Enable/disable sniffer on wifi management beacon frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_other (Alias name: ap-sniffer-mgmt-other) Enable/disable sniffer on wifi management other frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_probe (Alias name: ap-sniffer-mgmt-probe) Enable/disable sniffer on wifi management probe frames (default = enable). type: str choices: [disable, enable] more...
      • arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: list more...
      • auto_power_high (Alias name: 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...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: 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...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 3 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low] more...
      • bandwidth_admission_control (Alias name: bandwidth-admission-control) Enable/disable wifi multimedia (wmm) bandwidth admission control to optimize wifi bandwidth use. type: str choices: [disable, enable] more...
      • bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int more...
      • beacon_interval (Alias name: beacon-interval) Beacon interval. type: int more...
      • bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, disable = 0, default = 0). type: int more...
      • bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...
      • call_admission_control (Alias name: call-admission-control) Enable/disable wifi multimedia (wmm) call admission control to optimize wifi bandwidth use for voip calls. type: str choices: [disable, enable] more...
      • call_capacity (Alias name: call-capacity) Maximum number of voice over wlan (vowlan) phones supported by the radio (0 - 60, default = 10). type: int more...
      • channel Selected list of wireless radio channels. type: list more...
      • channel_bonding (Alias name: channel-bonding) Channel bandwidth: 320, 240, 160, 80, 40, or 20mhz. type: str choices: [80MHz, 40MHz, 20MHz, 160MHz, 320MHz, 240MHz] more...
      • channel_bonding_ext (Alias name: channel-bonding-ext) Channel bandwidth extension: 320 mhz-1 and 320 mhz-2 (default = 320 mhz-2). type: str choices: [320MHz-1, 320MHz-2] more...
      • channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable] more...
      • coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable] more...
      • darrp Enable/disable distributed automatic radio resource provisioning (darrp) to make sure the radio is always using the most optimal channel (default = disable). type: str choices: [disable, enable] more...
      • drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable] more...
      • drma_sensitivity (Alias name: drma-sensitivity) Network coverage factor (ncf) percentage required to consider a radio as redundant (default = low). type: str choices: [low, medium, high] more...
      • dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int more...
      • frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...
      • iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp] more...
      • iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int more...
      • max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int more...
      • max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int more...
      • mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8] more...
      • mode Mode of radio 3. type: str choices: [disabled, ap, monitor, sniffer, sam] more...
      • optional_antenna (Alias name: optional-antenna) Optional antenna used on fap (default = none). type: str choices: [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R, custom, FANT-04BEAX-0606-P-R] more...
      • optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • powersave_optimize (Alias name: 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...
      • protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • rts_threshold (Alias name: rts-threshold) Maximum packet size for rts transmissions, specifying the maximum size of a data packet before rts/cts (256 - 2346 bytes, default = 2346). type: int more...
      • sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str more...
      • sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable] more...
      • sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str more...
      • sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str more...
      • sam_cwp_password (Alias name: sam-cwp-password) Password for captive portal authentication. type: list more...
      • sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str more...
      • sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str more...
      • sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str more...
      • sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both] more...
      • sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list more...
      • sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: list more...
      • sam_private_key_password (Alias name: sam-private-key-password) Password for private key file for wpa2/wpa3-enterprise. type: list more...
      • sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int more...
      • sam_security_type (Alias name: sam-security-type) Select wifi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise, owe, wpa3-sae] more...
      • sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str more...
      • sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str more...
      • sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn] more...
      • sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str more...
      • sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf] more...
      • sam_username (Alias name: sam-username) Username for wifi network connection. type: str more...
      • short_guard_interval (Alias name: 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: [disable, enable] more...
      • transmit_optimize (Alias name: transmit-optimize) Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. type: list choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: list more...
      • zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable] more...
      • sam_server (Alias name: sam-server) Sam server. type: str more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable] more...
      • frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
      • d80211mc (Alias name: 80211mc) Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_chan_width (Alias name: ap-sniffer-chan-width) Channel bandwidth for sniffer. type: str choices: [320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz] more...
      • ai_darrp_support (Alias name: ai-darrp-support) Enable/disable support for fortiaiops to retrieve distributed automatic radio resource provisioning (darrp) data through rest api calls (default = disable). type: str choices: [disable, enable] more...
    • radio_4 (Alias name: radio-4) Radio 4. type: dict more...
      • d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable] more...
      • airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable] more...
      • amsdu Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str more...
      • ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int more...
      • ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int more...
      • ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_beacon (Alias name: ap-sniffer-mgmt-beacon) Enable/disable sniffer on wifi management beacon frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_other (Alias name: ap-sniffer-mgmt-other) Enable/disable sniffer on wifi management other frames (default = enable). type: str choices: [disable, enable] more...
      • ap_sniffer_mgmt_probe (Alias name: ap-sniffer-mgmt-probe) Enable/disable sniffer on wifi management probe frames (default = enable). type: str choices: [disable, enable] more...
      • arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: list more...
      • auto_power_high (Alias name: 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...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: 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...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 4 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low] more...
      • bandwidth_admission_control (Alias name: bandwidth-admission-control) Enable/disable wifi multimedia (wmm) bandwidth admission control to optimize wifi bandwidth use. type: str choices: [disable, enable] more...
      • bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int more...
      • beacon_interval (Alias name: beacon-interval) Beacon interval. type: int more...
      • bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, disable = 0, default = 0). type: int more...
      • bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static] more...
      • call_admission_control (Alias name: call-admission-control) Enable/disable wifi multimedia (wmm) call admission control to optimize wifi bandwidth use for voip calls. type: str choices: [disable, enable] more...
      • call_capacity (Alias name: call-capacity) Maximum number of voice over wlan (vowlan) phones supported by the radio (0 - 60, default = 10). type: int more...
      • channel Selected list of wireless radio channels. type: list more...
      • channel_bonding (Alias name: channel-bonding) Channel bandwidth: 320, 240, 160, 80, 40, or 20mhz. type: str choices: [80MHz, 40MHz, 20MHz, 160MHz, 320MHz, 240MHz] more...
      • channel_bonding_ext (Alias name: channel-bonding-ext) Channel bandwidth extension: 320 mhz-1 and 320 mhz-2 (default = 320 mhz-2). type: str choices: [320MHz-1, 320MHz-2] more...
      • channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable] more...
      • coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable] more...
      • darrp Enable/disable distributed automatic radio resource provisioning (darrp) to make sure the radio is always using the most optimal channel (default = disable). type: str choices: [disable, enable] more...
      • drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable] more...
      • drma_sensitivity (Alias name: drma-sensitivity) Network coverage factor (ncf) percentage required to consider a radio as redundant (default = low). type: str choices: [low, medium, high] more...
      • dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int more...
      • frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int more...
      • iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp] more...
      • iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int more...
      • max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int more...
      • max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int more...
      • mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8] more...
      • mode Mode of radio 4. type: str choices: [disabled, ap, monitor, sniffer, sam] more...
      • optional_antenna (Alias name: optional-antenna) Optional antenna used on fap (default = none). type: str choices: [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, FANT-04ABGN-8065-P-N, FANT-04ABGN-0606-O-R, FANT-04ABGN-0606-P-R, FANT-10ACAX-1213-D-N, FANT-08ABGN-1213-D-R, custom, FANT-04BEAX-0606-P-R] more...
      • optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • powersave_optimize (Alias name: 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...
      • protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable] more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • rts_threshold (Alias name: rts-threshold) Maximum packet size for rts transmissions, specifying the maximum size of a data packet before rts/cts (256 - 2346 bytes, default = 2346). type: int more...
      • sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str more...
      • sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable] more...
      • sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: list more...
      • sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str more...
      • sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str more...
      • sam_cwp_password (Alias name: sam-cwp-password) Password for captive portal authentication. type: list more...
      • sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str more...
      • sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str more...
      • sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str more...
      • sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both] more...
      • sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list more...
      • sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: list more...
      • sam_private_key_password (Alias name: sam-private-key-password) Password for private key file for wpa2/wpa3-enterprise. type: list more...
      • sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int more...
      • sam_security_type (Alias name: sam-security-type) Select wifi network security type (default = wpa-personal). type: str choices: [open, wpa-personal, wpa-enterprise, owe, wpa3-sae] more...
      • sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str more...
      • sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str more...
      • sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn] more...
      • sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str more...
      • sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf] more...
      • sam_username (Alias name: sam-username) Username for wifi network connection. type: str more...
      • short_guard_interval (Alias name: 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: [disable, enable] more...
      • transmit_optimize (Alias name: transmit-optimize) Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. type: list choices: [disable, power-save, aggr-limit, retry-limit, send-bar] more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: list more...
      • zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable] more...
      • sam_server (Alias name: sam-server) Sam server. type: str more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable] more...
      • frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable] more...
      • d80211mc (Alias name: 80211mc) Enable/disable 802. type: str choices: [disable, enable] more...
      • ap_sniffer_chan_width (Alias name: ap-sniffer-chan-width) Channel bandwidth for sniffer. type: str choices: [320MHz, 240MHz, 160MHz, 80MHz, 40MHz, 20MHz] more...
      • ai_darrp_support (Alias name: ai-darrp-support) Enable/disable support for fortiaiops to retrieve distributed automatic radio resource provisioning (darrp) data through rest api calls (default = disable). type: str choices: [disable, enable] more...
    • split_tunneling_acl (Alias name: split-tunneling-acl) Split tunneling acl. type: list more...
      • dest_ip (Alias name: dest-ip) Destination ip and mask for the split-tunneling subnet. type: list more...
      • id Id. type: int more...
    • split_tunneling_acl_local_ap_subnet (Alias name: split-tunneling-acl-local-ap-subnet) Enable/disable automatically adding local subnetwork of fortiap to split-tunneling acl (default = disable). type: str choices: [disable, enable] more...
    • split_tunneling_acl_path (Alias name: split-tunneling-acl-path) Split tunneling acl path is local/tunnel. type: str choices: [tunnel, local] more...
    • syslog_profile (Alias name: syslog-profile) System log server configuration profile name. type: list more...
    • tun_mtu_downlink (Alias name: tun-mtu-downlink) The mtu of downlink capwap tunnel (576 - 1500 bytes or 0; 0 means the local mtu of fortiap; default = 0). type: int more...
    • tun_mtu_uplink (Alias name: tun-mtu-uplink) The maximum transmission unit (mtu) of uplink capwap tunnel (576 - 1500 bytes or 0; 0 means the local mtu of fortiap; default = 0). type: int more...
    • unii_4_5ghz_band (Alias name: unii-4-5ghz-band) Enable/disable unii-4 5ghz band channels (default = disable). type: str choices: [disable, enable] more...
    • usb_port (Alias name: usb-port) Enable/disable usb port of the wtp (default = enable). type: str choices: [disable, enable] more...
    • wan_port_auth (Alias name: wan-port-auth) Set wan port authentication mode (default = none). type: str choices: [none, 802.1x] more...
    • wan_port_auth_macsec (Alias name: wan-port-auth-macsec) Enable/disable wan port 802. type: str choices: [disable, enable] more...
    • wan_port_auth_methods (Alias name: wan-port-auth-methods) Wan port 802. type: str choices: [all, EAP-FAST, EAP-TLS, EAP-PEAP] more...
    • wan_port_auth_password (Alias name: wan-port-auth-password) Set wan port 802. type: list more...
    • wan_port_auth_usrname (Alias name: wan-port-auth-usrname) Set wan port 802. type: str more...
    • wan_port_mode (Alias name: wan-port-mode) Enable/disable using a wan port as a lan port. type: str choices: [wan-lan, wan-only] more...
    • admin_auth_tacacs_ (Alias name: admin-auth-tacacs+) Remote authentication server for admin user. type: list more...
    • admin_restrict_local (Alias name: admin-restrict-local) Enable/disable local admin authentication restriction when remote authenticator is up and running (default = disable). type: str choices: [disable, enable] more...
    • apcfg_mesh (Alias name: apcfg-mesh) Enable/disable ap local mesh configuration (default = disable). type: str choices: [disable, enable] more...
    • apcfg_mesh_ap_type (Alias name: apcfg-mesh-ap-type) Mesh ap type (default = ethernet). type: str choices: [auto, ethernet, mesh] more...
    • apcfg_mesh_eth_bridge (Alias name: apcfg-mesh-eth-bridge) Enable/disable mesh ethernet bridge (default = disable). type: str choices: [disable, enable] more...
    • apcfg_mesh_passwd (Alias name: apcfg-mesh-passwd) Apcfg mesh passwd. type: list more...
    • apcfg_mesh_ssid (Alias name: apcfg-mesh-ssid) Mesh ssid (default = none). type: list more...
    • default_mesh_root (Alias name: default-mesh-root) Configure default mesh root ssid when it is not included by radios ssid configuration. type: str choices: [disable, enable] more...
    • apcfg_auto_cert (Alias name: apcfg-auto-cert) Enable/disable ap local auto cert configuration (default = disable). type: str choices: [disable, enable] more...
    • apcfg_auto_cert_auto_regen_days (Alias name: apcfg-auto-cert-auto-regen-days) Number of days to wait before expiry of an updated local certificate is requested (0 = disabled) (default = 30). type: int more...
    • apcfg_auto_cert_crypto_algo (Alias name: apcfg-auto-cert-crypto-algo) Cryptography algorithm: rsa-1024, rsa-1536, rsa-2048, rsa-4096, ec-secp256r1, ec-secp384r1, ec-secp521r1 (default = ec-secp256r1) type: str choices: [rsa-1024, rsa-1536, rsa-2048, rsa-4096, ec-secp256r1, ec-secp384r1, ec-secp521r1] more...
    • apcfg_auto_cert_enroll_protocol (Alias name: apcfg-auto-cert-enroll-protocol) Certificate enrollment protocol (default = none) type: str choices: [none, scep, est] more...
    • apcfg_auto_cert_est_ca_id (Alias name: apcfg-auto-cert-est-ca-id) Ca identifier of the ca server for signing via est. type: str more...
    • apcfg_auto_cert_est_http_password (Alias name: apcfg-auto-cert-est-http-password) Http authentication password for signing via est. type: list more...
    • apcfg_auto_cert_est_http_username (Alias name: apcfg-auto-cert-est-http-username) Http authentication username for signing via est. type: str more...
    • apcfg_auto_cert_est_https_ca (Alias name: apcfg-auto-cert-est-https-ca) Pem format https ca certificate. type: list more...
    • apcfg_auto_cert_est_server (Alias name: apcfg-auto-cert-est-server) Address and port for est server (e. type: str more...
    • apcfg_auto_cert_est_subject (Alias name: apcfg-auto-cert-est-subject) Subject e. type: str more...
    • apcfg_auto_cert_est_subject_alt_name (Alias name: apcfg-auto-cert-est-subject-alt-name) Subject alternative name (optional, e. type: str more...
    • apcfg_auto_cert_scep_ca_id (Alias name: apcfg-auto-cert-scep-ca-id) Ca identifier of the ca server for signing via scep. type: str more...
    • apcfg_auto_cert_scep_ec_name (Alias name: apcfg-auto-cert-scep-ec-name) Elliptic curve name: secp256r1, secp384r1 and secp521r1. type: str choices: [secp256r1, secp384r1, secp521r1] more...
    • apcfg_auto_cert_scep_https_ca (Alias name: apcfg-auto-cert-scep-https-ca) Pem format https ca certificate. type: list more...
    • apcfg_auto_cert_scep_keysize (Alias name: apcfg-auto-cert-scep-keysize) Key size: 1024, 1536, 2048, 4096 (default 2048). type: str choices: [1024, 1536, 2048, 4096] more...
    • apcfg_auto_cert_scep_keytype (Alias name: apcfg-auto-cert-scep-keytype) Key type (default = rsa) type: str choices: [rsa, ec] more...
    • apcfg_auto_cert_scep_password (Alias name: apcfg-auto-cert-scep-password) Scep server challenge password for auto-regeneration. type: list more...
    • apcfg_auto_cert_scep_sub_fully_dn (Alias name: apcfg-auto-cert-scep-sub-fully-dn) Full dn of the subject (e. type: str more...
    • apcfg_auto_cert_scep_subject_alt_name (Alias name: apcfg-auto-cert-scep-subject-alt-name) Subject alternative name (optional, e. type: str more...
    • apcfg_auto_cert_scep_url (Alias name: apcfg-auto-cert-scep-url) Scep server url. type: str more...
    • lw_profile (Alias name: lw-profile) Lorawan profile name. type: list more...

Notes

Note

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

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

  • To delete an object, use state: absent directive

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

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
      fortinet.fmgdevice.fmgd_wireless_wtpprofile:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        wireless_wtpprofile:
          name: "your value" # Required variable, string
          # _is_factory_setting: <value in [disable, enable, ext]>
          # allowaccess:
          #   - "https"
          #   - "ssh"
          #   - "snmp"
          #   - "http"
          #   - "telnet"
          # ap_country: <value in [AL, DZ, AR, ...]>
          # ap_handoff: <value in [disable, enable]>
          # apcfg_profile: <list or string>
          # ble_profile: <list or string>
          # bonjour_profile: <list or string>
          # comment: <string>
          # console_login: <value in [disable, enable]>
          # control_message_offload:
          #   - "ebp-frame"
          #   - "aeroscout-tag"
          #   - "ap-list"
          #   - "sta-list"
          #   - "sta-cap-list"
          #   - "stats"
          #   - "aeroscout-mu"
          #   - "sta-health"
          #   - "spectral-analysis"
          # deny_mac_list:
          #   - id: <integer>
          #     mac: <string>
          # dtls_in_kernel: <value in [disable, enable]>
          # dtls_policy:
          #   - "clear-text"
          #   - "dtls-enabled"
          #   - "ipsec-vpn"
          #   - "ipsec-sn-vpn"
          # energy_efficient_ethernet: <value in [disable, enable]>
          # esl_ses_dongle:
          #   apc_addr_type: <value in [fqdn, ip]>
          #   apc_fqdn: <string>
          #   apc_ip: <string>
          #   apc_port: <integer>
          #   coex_level: <value in [none]>
          #   compliance_level: <value in [compliance-level-2]>
          #   esl_channel: <value in [0, 1, 2, ...]>
          #   output_power: <value in [a, b, c, ...]>
          #   scd_enable: <value in [disable, enable]>
          #   tls_cert_verification: <value in [disable, enable]>
          #   tls_fqdn_verification: <value in [disable, enable]>
          # ext_info_enable: <value in [disable, enable]>
          # frequency_handoff: <value in [disable, enable]>
          # handoff_roaming: <value in [disable, enable]>
          # handoff_rssi: <integer>
          # handoff_sta_thresh: <integer>
          # indoor_outdoor_deployment: <value in [platform-determined, outdoor, indoor]>
          # ip_fragment_preventing:
          #   - "tcp-mss-adjust"
          #   - "icmp-unreachable"
          # lan:
          #   port_esl_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port_esl_ssid: <list or string>
          #   port_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port_ssid: <list or string>
          #   port1_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port1_ssid: <list or string>
          #   port2_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port2_ssid: <list or string>
          #   port3_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port3_ssid: <list or string>
          #   port4_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port4_ssid: <list or string>
          #   port5_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port5_ssid: <list or string>
          #   port6_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port6_ssid: <list or string>
          #   port7_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port7_ssid: <list or string>
          #   port8_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port8_ssid: <list or string>
          # lbs:
          #   aeroscout: <value in [disable, enable]>
          #   aeroscout_ap_mac: <value in [bssid, board-mac]>
          #   aeroscout_mmu_report: <value in [disable, enable]>
          #   aeroscout_mu: <value in [disable, enable]>
          #   aeroscout_mu_factor: <integer>
          #   aeroscout_mu_timeout: <integer>
          #   aeroscout_server_ip: <string>
          #   aeroscout_server_port: <integer>
          #   ekahau_blink_mode: <value in [disable, enable]>
          #   ekahau_tag: <string>
          #   erc_server_ip: <string>
          #   erc_server_port: <integer>
          #   fortipresence: <value in [disable, enable, enable2, ...]>
          #   fortipresence_ble: <value in [disable, enable]>
          #   fortipresence_frequency: <integer>
          #   fortipresence_port: <integer>
          #   fortipresence_project: <string>
          #   fortipresence_rogue: <value in [disable, enable]>
          #   fortipresence_secret: <list or string>
          #   fortipresence_server: <string>
          #   fortipresence_server_addr_type: <value in [fqdn, ipv4]>
          #   fortipresence_server_fqdn: <string>
          #   fortipresence_unassoc: <value in [disable, enable]>
          #   polestar: <value in [disable, enable]>
          #   polestar_accumulation_interval: <integer>
          #   polestar_asset_addrgrp_list: <list or string>
          #   polestar_asset_uuid_list1: <string>
          #   polestar_asset_uuid_list2: <string>
          #   polestar_asset_uuid_list3: <string>
          #   polestar_asset_uuid_list4: <string>
          #   polestar_protocol: <value in [WSS]>
          #   polestar_reporting_interval: <integer>
          #   polestar_server_fqdn: <string>
          #   polestar_server_path: <string>
          #   polestar_server_port: <integer>
          #   polestar_server_token: <string>
          #   station_locate: <value in [disable, enable]>
          #   ble_rtls: <value in [none, polestar, evresys]>
          #   ble_rtls_accumulation_interval: <integer>
          #   ble_rtls_asset_addrgrp_list: <list or string>
          #   ble_rtls_asset_uuid_list1: <string>
          #   ble_rtls_asset_uuid_list2: <string>
          #   ble_rtls_asset_uuid_list3: <string>
          #   ble_rtls_asset_uuid_list4: <string>
          #   ble_rtls_protocol: <value in [WSS]>
          #   ble_rtls_reporting_interval: <integer>
          #   ble_rtls_server_fqdn: <string>
          #   ble_rtls_server_path: <string>
          #   ble_rtls_server_port: <integer>
          #   ble_rtls_server_token: <string>
          # led_schedules: <list or string>
          # led_state: <value in [disable, enable]>
          # lldp: <value in [disable, enable]>
          # login_passwd: <list or string>
          # login_passwd_change: <value in [no, yes, default]>
          # max_clients: <integer>
          # platform:
          #   _local_platform_str: <string>
          #   ddscan: <value in [disable, enable]>
          #   mode: <value in [dual-5G, single-5G]>
          #   type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
          # poe_mode: <value in [auto, 8023af, 8023at, ...]>
          # radio_1:
          #   d80211d: <value in [disable, enable]>
          #   airtime_fairness: <value in [disable, enable]>
          #   amsdu: <value in [disable, enable]>
          #   ap_sniffer_addr: <string>
          #   ap_sniffer_bufsize: <integer>
          #   ap_sniffer_chan: <integer>
          #   ap_sniffer_ctl: <value in [disable, enable]>
          #   ap_sniffer_data: <value in [disable, enable]>
          #   ap_sniffer_mgmt_beacon: <value in [disable, enable]>
          #   ap_sniffer_mgmt_other: <value in [disable, enable]>
          #   ap_sniffer_mgmt_probe: <value in [disable, enable]>
          #   arrp_profile: <list or string>
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
          #   bandwidth_admission_control: <value in [disable, enable]>
          #   bandwidth_capacity: <integer>
          #   beacon_interval: <integer>
          #   bss_color: <integer>
          #   bss_color_mode: <value in [auto, static]>
          #   call_admission_control: <value in [disable, enable]>
          #   call_capacity: <integer>
          #   channel: <list or string>
          #   channel_bonding: <value in [disable, enable, 80MHz, ...]>
          #   channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
          #   channel_utilization: <value in [disable, enable]>
          #   coexistence: <value in [disable, enable]>
          #   darrp: <value in [disable, enable]>
          #   drma: <value in [disable, enable]>
          #   drma_sensitivity: <value in [low, medium, high]>
          #   dtim: <integer>
          #   frag_threshold: <integer>
          #   iperf_protocol: <value in [udp, tcp]>
          #   iperf_server_port: <integer>
          #   max_clients: <integer>
          #   max_distance: <integer>
          #   mimo_mode: <value in [default, 1x1, 2x2, ...]>
          #   mode: <value in [disabled, ap, monitor, ...]>
          #   optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
          #   optional_antenna_gain: <string>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   powersave_optimize:
          #     - "tim"
          #     - "ac-vo"
          #     - "no-obss-scan"
          #     - "no-11b-rate"
          #     - "client-rate-follow"
          #   protection_mode: <value in [rtscts, ctsonly, disable]>
          #   radio_id: <integer>
          #   rts_threshold: <integer>
          #   sam_bssid: <string>
          #   sam_ca_certificate: <list or string>
          #   sam_captive_portal: <value in [disable, enable]>
          #   sam_client_certificate: <list or string>
          #   sam_cwp_failure_string: <string>
          #   sam_cwp_match_string: <string>
          #   sam_cwp_password: <list or string>
          #   sam_cwp_success_string: <string>
          #   sam_cwp_test_url: <string>
          #   sam_cwp_username: <string>
          #   sam_eap_method: <value in [tls, peap, both]>
          #   sam_password: <list or string>
          #   sam_private_key: <list or string>
          #   sam_private_key_password: <list or string>
          #   sam_report_intv: <integer>
          #   sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
          #   sam_server_fqdn: <string>
          #   sam_server_ip: <string>
          #   sam_server_type: <value in [ip, fqdn]>
          #   sam_ssid: <string>
          #   sam_test: <value in [ping, iperf]>
          #   sam_username: <string>
          #   short_guard_interval: <value in [disable, enable]>
          #   transmit_optimize:
          #     - "disable"
          #     - "power-save"
          #     - "aggr-limit"
          #     - "retry-limit"
          #     - "send-bar"
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   wids_profile: <list or string>
          #   zero_wait_dfs: <value in [disable, enable]>
          #   sam_server: <string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   ap_handoff: <value in [disable, enable]>
          #   frequency_handoff: <value in [disable, enable]>
          #   d80211mc: <value in [disable, enable]>
          #   ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
          #   ai_darrp_support: <value in [disable, enable]>
          # radio_2:
          #   d80211d: <value in [disable, enable]>
          #   airtime_fairness: <value in [disable, enable]>
          #   amsdu: <value in [disable, enable]>
          #   ap_sniffer_addr: <string>
          #   ap_sniffer_bufsize: <integer>
          #   ap_sniffer_chan: <integer>
          #   ap_sniffer_ctl: <value in [disable, enable]>
          #   ap_sniffer_data: <value in [disable, enable]>
          #   ap_sniffer_mgmt_beacon: <value in [disable, enable]>
          #   ap_sniffer_mgmt_other: <value in [disable, enable]>
          #   ap_sniffer_mgmt_probe: <value in [disable, enable]>
          #   arrp_profile: <list or string>
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
          #   bandwidth_admission_control: <value in [disable, enable]>
          #   bandwidth_capacity: <integer>
          #   beacon_interval: <integer>
          #   bss_color: <integer>
          #   bss_color_mode: <value in [auto, static]>
          #   call_admission_control: <value in [disable, enable]>
          #   call_capacity: <integer>
          #   channel: <list or string>
          #   channel_bonding: <value in [disable, enable, 80MHz, ...]>
          #   channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
          #   channel_utilization: <value in [disable, enable]>
          #   coexistence: <value in [disable, enable]>
          #   darrp: <value in [disable, enable]>
          #   drma: <value in [disable, enable]>
          #   drma_sensitivity: <value in [low, medium, high]>
          #   dtim: <integer>
          #   frag_threshold: <integer>
          #   iperf_protocol: <value in [udp, tcp]>
          #   iperf_server_port: <integer>
          #   max_clients: <integer>
          #   max_distance: <integer>
          #   mimo_mode: <value in [default, 1x1, 2x2, ...]>
          #   mode: <value in [disabled, ap, monitor, ...]>
          #   optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
          #   optional_antenna_gain: <string>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   powersave_optimize:
          #     - "tim"
          #     - "ac-vo"
          #     - "no-obss-scan"
          #     - "no-11b-rate"
          #     - "client-rate-follow"
          #   protection_mode: <value in [rtscts, ctsonly, disable]>
          #   radio_id: <integer>
          #   rts_threshold: <integer>
          #   sam_bssid: <string>
          #   sam_ca_certificate: <list or string>
          #   sam_captive_portal: <value in [disable, enable]>
          #   sam_client_certificate: <list or string>
          #   sam_cwp_failure_string: <string>
          #   sam_cwp_match_string: <string>
          #   sam_cwp_password: <list or string>
          #   sam_cwp_success_string: <string>
          #   sam_cwp_test_url: <string>
          #   sam_cwp_username: <string>
          #   sam_eap_method: <value in [tls, peap, both]>
          #   sam_password: <list or string>
          #   sam_private_key: <list or string>
          #   sam_private_key_password: <list or string>
          #   sam_report_intv: <integer>
          #   sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
          #   sam_server_fqdn: <string>
          #   sam_server_ip: <string>
          #   sam_server_type: <value in [ip, fqdn]>
          #   sam_ssid: <string>
          #   sam_test: <value in [ping, iperf]>
          #   sam_username: <string>
          #   short_guard_interval: <value in [disable, enable]>
          #   transmit_optimize:
          #     - "disable"
          #     - "power-save"
          #     - "aggr-limit"
          #     - "retry-limit"
          #     - "send-bar"
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   wids_profile: <list or string>
          #   zero_wait_dfs: <value in [disable, enable]>
          #   sam_server: <string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   ap_handoff: <value in [disable, enable]>
          #   frequency_handoff: <value in [disable, enable]>
          #   d80211mc: <value in [disable, enable]>
          #   ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
          #   ai_darrp_support: <value in [disable, enable]>
          # radio_3:
          #   d80211d: <value in [disable, enable]>
          #   airtime_fairness: <value in [disable, enable]>
          #   amsdu: <value in [disable, enable]>
          #   ap_sniffer_addr: <string>
          #   ap_sniffer_bufsize: <integer>
          #   ap_sniffer_chan: <integer>
          #   ap_sniffer_ctl: <value in [disable, enable]>
          #   ap_sniffer_data: <value in [disable, enable]>
          #   ap_sniffer_mgmt_beacon: <value in [disable, enable]>
          #   ap_sniffer_mgmt_other: <value in [disable, enable]>
          #   ap_sniffer_mgmt_probe: <value in [disable, enable]>
          #   arrp_profile: <list or string>
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
          #   bandwidth_admission_control: <value in [disable, enable]>
          #   bandwidth_capacity: <integer>
          #   beacon_interval: <integer>
          #   bss_color: <integer>
          #   bss_color_mode: <value in [auto, static]>
          #   call_admission_control: <value in [disable, enable]>
          #   call_capacity: <integer>
          #   channel: <list or string>
          #   channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
          #   channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
          #   channel_utilization: <value in [disable, enable]>
          #   coexistence: <value in [disable, enable]>
          #   darrp: <value in [disable, enable]>
          #   drma: <value in [disable, enable]>
          #   drma_sensitivity: <value in [low, medium, high]>
          #   dtim: <integer>
          #   frag_threshold: <integer>
          #   iperf_protocol: <value in [udp, tcp]>
          #   iperf_server_port: <integer>
          #   max_clients: <integer>
          #   max_distance: <integer>
          #   mimo_mode: <value in [default, 1x1, 2x2, ...]>
          #   mode: <value in [disabled, ap, monitor, ...]>
          #   optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
          #   optional_antenna_gain: <string>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   powersave_optimize:
          #     - "tim"
          #     - "ac-vo"
          #     - "no-obss-scan"
          #     - "no-11b-rate"
          #     - "client-rate-follow"
          #   protection_mode: <value in [rtscts, ctsonly, disable]>
          #   radio_id: <integer>
          #   rts_threshold: <integer>
          #   sam_bssid: <string>
          #   sam_ca_certificate: <list or string>
          #   sam_captive_portal: <value in [disable, enable]>
          #   sam_client_certificate: <list or string>
          #   sam_cwp_failure_string: <string>
          #   sam_cwp_match_string: <string>
          #   sam_cwp_password: <list or string>
          #   sam_cwp_success_string: <string>
          #   sam_cwp_test_url: <string>
          #   sam_cwp_username: <string>
          #   sam_eap_method: <value in [tls, peap, both]>
          #   sam_password: <list or string>
          #   sam_private_key: <list or string>
          #   sam_private_key_password: <list or string>
          #   sam_report_intv: <integer>
          #   sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
          #   sam_server_fqdn: <string>
          #   sam_server_ip: <string>
          #   sam_server_type: <value in [ip, fqdn]>
          #   sam_ssid: <string>
          #   sam_test: <value in [ping, iperf]>
          #   sam_username: <string>
          #   short_guard_interval: <value in [disable, enable]>
          #   transmit_optimize:
          #     - "disable"
          #     - "power-save"
          #     - "aggr-limit"
          #     - "retry-limit"
          #     - "send-bar"
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   wids_profile: <list or string>
          #   zero_wait_dfs: <value in [disable, enable]>
          #   sam_server: <string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   ap_handoff: <value in [disable, enable]>
          #   frequency_handoff: <value in [disable, enable]>
          #   d80211mc: <value in [disable, enable]>
          #   ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
          #   ai_darrp_support: <value in [disable, enable]>
          # radio_4:
          #   d80211d: <value in [disable, enable]>
          #   airtime_fairness: <value in [disable, enable]>
          #   amsdu: <value in [disable, enable]>
          #   ap_sniffer_addr: <string>
          #   ap_sniffer_bufsize: <integer>
          #   ap_sniffer_chan: <integer>
          #   ap_sniffer_ctl: <value in [disable, enable]>
          #   ap_sniffer_data: <value in [disable, enable]>
          #   ap_sniffer_mgmt_beacon: <value in [disable, enable]>
          #   ap_sniffer_mgmt_other: <value in [disable, enable]>
          #   ap_sniffer_mgmt_probe: <value in [disable, enable]>
          #   arrp_profile: <list or string>
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
          #   bandwidth_admission_control: <value in [disable, enable]>
          #   bandwidth_capacity: <integer>
          #   beacon_interval: <integer>
          #   bss_color: <integer>
          #   bss_color_mode: <value in [auto, static]>
          #   call_admission_control: <value in [disable, enable]>
          #   call_capacity: <integer>
          #   channel: <list or string>
          #   channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
          #   channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
          #   channel_utilization: <value in [disable, enable]>
          #   coexistence: <value in [disable, enable]>
          #   darrp: <value in [disable, enable]>
          #   drma: <value in [disable, enable]>
          #   drma_sensitivity: <value in [low, medium, high]>
          #   dtim: <integer>
          #   frag_threshold: <integer>
          #   iperf_protocol: <value in [udp, tcp]>
          #   iperf_server_port: <integer>
          #   max_clients: <integer>
          #   max_distance: <integer>
          #   mimo_mode: <value in [default, 1x1, 2x2, ...]>
          #   mode: <value in [disabled, ap, monitor, ...]>
          #   optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
          #   optional_antenna_gain: <string>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   powersave_optimize:
          #     - "tim"
          #     - "ac-vo"
          #     - "no-obss-scan"
          #     - "no-11b-rate"
          #     - "client-rate-follow"
          #   protection_mode: <value in [rtscts, ctsonly, disable]>
          #   radio_id: <integer>
          #   rts_threshold: <integer>
          #   sam_bssid: <string>
          #   sam_ca_certificate: <list or string>
          #   sam_captive_portal: <value in [disable, enable]>
          #   sam_client_certificate: <list or string>
          #   sam_cwp_failure_string: <string>
          #   sam_cwp_match_string: <string>
          #   sam_cwp_password: <list or string>
          #   sam_cwp_success_string: <string>
          #   sam_cwp_test_url: <string>
          #   sam_cwp_username: <string>
          #   sam_eap_method: <value in [tls, peap, both]>
          #   sam_password: <list or string>
          #   sam_private_key: <list or string>
          #   sam_private_key_password: <list or string>
          #   sam_report_intv: <integer>
          #   sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
          #   sam_server_fqdn: <string>
          #   sam_server_ip: <string>
          #   sam_server_type: <value in [ip, fqdn]>
          #   sam_ssid: <string>
          #   sam_test: <value in [ping, iperf]>
          #   sam_username: <string>
          #   short_guard_interval: <value in [disable, enable]>
          #   transmit_optimize:
          #     - "disable"
          #     - "power-save"
          #     - "aggr-limit"
          #     - "retry-limit"
          #     - "send-bar"
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   wids_profile: <list or string>
          #   zero_wait_dfs: <value in [disable, enable]>
          #   sam_server: <string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   ap_handoff: <value in [disable, enable]>
          #   frequency_handoff: <value in [disable, enable]>
          #   d80211mc: <value in [disable, enable]>
          #   ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
          #   ai_darrp_support: <value in [disable, enable]>
          # split_tunneling_acl:
          #   - dest_ip: <list or string>
          #     id: <integer>
          # split_tunneling_acl_local_ap_subnet: <value in [disable, enable]>
          # split_tunneling_acl_path: <value in [tunnel, local]>
          # syslog_profile: <list or string>
          # tun_mtu_downlink: <integer>
          # tun_mtu_uplink: <integer>
          # unii_4_5ghz_band: <value in [disable, enable]>
          # usb_port: <value in [disable, enable]>
          # wan_port_auth: <value in [none, 802.1x]>
          # wan_port_auth_macsec: <value in [disable, enable]>
          # wan_port_auth_methods: <value in [all, EAP-FAST, EAP-TLS, ...]>
          # wan_port_auth_password: <list or string>
          # wan_port_auth_usrname: <string>
          # wan_port_mode: <value in [wan-lan, wan-only]>
          # admin_auth_tacacs_: <list or string>
          # admin_restrict_local: <value in [disable, enable]>
          # apcfg_mesh: <value in [disable, enable]>
          # apcfg_mesh_ap_type: <value in [auto, ethernet, mesh]>
          # apcfg_mesh_eth_bridge: <value in [disable, enable]>
          # apcfg_mesh_passwd: <list or string>
          # apcfg_mesh_ssid: <list or string>
          # default_mesh_root: <value in [disable, enable]>
          # apcfg_auto_cert: <value in [disable, enable]>
          # apcfg_auto_cert_auto_regen_days: <integer>
          # apcfg_auto_cert_crypto_algo: <value in [rsa-1024, rsa-1536, rsa-2048, ...]>
          # apcfg_auto_cert_enroll_protocol: <value in [none, scep, est]>
          # apcfg_auto_cert_est_ca_id: <string>
          # apcfg_auto_cert_est_http_password: <list or string>
          # apcfg_auto_cert_est_http_username: <string>
          # apcfg_auto_cert_est_https_ca: <list or string>
          # apcfg_auto_cert_est_server: <string>
          # apcfg_auto_cert_est_subject: <string>
          # apcfg_auto_cert_est_subject_alt_name: <string>
          # apcfg_auto_cert_scep_ca_id: <string>
          # apcfg_auto_cert_scep_ec_name: <value in [secp256r1, secp384r1, secp521r1]>
          # apcfg_auto_cert_scep_https_ca: <list or string>
          # apcfg_auto_cert_scep_keysize: <value in [1024, 1536, 2048, ...]>
          # apcfg_auto_cert_scep_keytype: <value in [rsa, ec]>
          # apcfg_auto_cert_scep_password: <list or string>
          # apcfg_auto_cert_scep_sub_fully_dn: <string>
          # apcfg_auto_cert_scep_subject_alt_name: <string>
          # apcfg_auto_cert_scep_url: <string>
          # lw_profile: <list or string>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)