- source
fmgr_wtpprofile.py
- orphan
fmgr_wtpprofile -- Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name,var name,var.name - New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- 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
- adom - The parameter in requested url type: str required: true
- wtpprofile - Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. type: dict
- allowaccess Control management access to the managed wtp, fortiap, or ap. type: list choices: [https, ssh, snmp, http, telnet]
more...
Supported Version Ranges:
v6.0.0 -> latest - 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, KH, TZ, SD, AO, RW, MZ, RS, ME, BB, GD, GL, GU, PY, HT, AW, MM, ZB, CF, BS, VC, MV, SN, CI, GH, MW, UG, BF, KY, TC, TM, VU, FM, GY, KN, LC, CX, AF, CM, ML, BJ, MG, TD, BW, LY, LS, MU, SL, NE, TG, RE, MD, BM, VI, PM, MF, IM, FO, GI, LA, WF, MH, BT, PF, NI, GF, AS, MP, PW, GP, ET, SR, DM, MQ, YT, BL, ZM, CG, CD, MR, IQ, FJ, --, MN, NG, GA, GM, SO, SZ, LR, DJ]
more...
Supported Version Ranges:
v6.0.0 -> latest - ble_profile (Alias name: ble-profile) Bluetooth low energy profile name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - comment Comment. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - deny_mac_list (Alias name: deny-mac-list) Deny-mac-list. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - dtls_in_kernel (Alias name: dtls-in-kernel) Enable/disable data channel dtls in kernel. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - energy_efficient_ethernet (Alias name: energy-efficient-ethernet) Enable/disable use of energy efficient ethernet on wtp. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - ext_info_enable (Alias name: ext-info-enable) Enable/disable station/vap/radio extension information. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - handoff_rssi (Alias name: handoff-rssi) Minimum received signal strength indicator (rssi) value for handoff (20 - 30, default = 25). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - handoff_sta_thresh (Alias name: handoff-sta-thresh) Threshold value for ap handoff. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - led_schedules (Alias name: led-schedules) Recurring firewall schedules for illuminating leds on the fortiap. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest - led_state (Alias name: led-state) Enable/disable use of leds on wtp (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - lldp Enable/disable link layer discovery protocol (lldp) for the wtp, fortiap, or ap (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - login_passwd (Alias name: login-passwd) Set the managed wtp, fortiap, or aps administrator password. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - max_clients (Alias name: max-clients) Maximum number of stations (stas) supported by the wtp (default = 0, meaning no client limitation). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - name Wtp (or fortiap or ap) profile name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - split_tunneling_acl (Alias name: split-tunneling-acl) Split-tunneling-acl. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - split_tunneling_acl_path (Alias name: split-tunneling-acl-path) Split tunneling acl path is local/tunnel. type: str choices: [tunnel, local]
more...
Supported Version Ranges:
v6.0.0 -> latest - tun_mtu_downlink (Alias name: tun-mtu-downlink) Downlink capwap tunnel mtu (0, 576, or 1500 bytes, default = 0). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - tun_mtu_uplink (Alias name: tun-mtu-uplink) Uplink capwap tunnel mtu (0, 576, or 1500 bytes, default = 0). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - snmp Enable/disable snmp for the wtp, fortiap, or ap (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v7.2.0 - ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> latest - apcfg_profile (Alias name: apcfg-profile) Ap local configuration profile name. type: str
more...
Supported Version Ranges:
v6.4.0 -> latest - frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> latest - lan type: dict
- 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...
Supported Version Ranges:
v6.4.5 -> latest - port_esl_ssid (Alias name: port-esl-ssid) Bridge esl port to ssid. type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - port_mode (Alias name: port-mode) Lan port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port_ssid (Alias name: port-ssid) Bridge lan port to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port1_mode (Alias name: port1-mode) Lan port 1 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port1_ssid (Alias name: port1-ssid) Bridge lan port 1 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port2_mode (Alias name: port2-mode) Lan port 2 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port2_ssid (Alias name: port2-ssid) Bridge lan port 2 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port3_mode (Alias name: port3-mode) Lan port 3 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port3_ssid (Alias name: port3-ssid) Bridge lan port 3 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port4_mode (Alias name: port4-mode) Lan port 4 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port4_ssid (Alias name: port4-ssid) Bridge lan port 4 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port5_mode (Alias name: port5-mode) Lan port 5 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port5_ssid (Alias name: port5-ssid) Bridge lan port 5 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port6_mode (Alias name: port6-mode) Lan port 6 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port6_ssid (Alias name: port6-ssid) Bridge lan port 6 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port7_mode (Alias name: port7-mode) Lan port 7 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port7_ssid (Alias name: port7-ssid) Bridge lan port 7 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port8_mode (Alias name: port8-mode) Lan port 8 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - port8_ssid (Alias name: port8-ssid) Bridge lan port 8 to ssid. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest
- 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...
- lbs type: dict
- aeroscout Enable/disable aeroscout real time location service (rtls) support (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - aeroscout_mmu_report (Alias name: aeroscout-mmu-report) Enable/disable compounded aeroscout tag and mu report (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - aeroscout_mu (Alias name: aeroscout-mu) Enable/disable aeroscout mobile unit (mu) support (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - aeroscout_mu_factor (Alias name: aeroscout-mu-factor) Aeroscout mu mode dilution factor (default = 20). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - aeroscout_mu_timeout (Alias name: aeroscout-mu-timeout) Aeroscout mu mode timeout (0 - 65535 sec, default = 5). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - aeroscout_server_ip (Alias name: aeroscout-server-ip) Ip address of aeroscout server. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - aeroscout_server_port (Alias name: aeroscout-server-port) Aeroscout server udp listening port. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ekahau_tag (Alias name: ekahau-tag) Wifi frame mac address or wifi tag. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - erc_server_ip (Alias name: erc-server-ip) Ip address of ekahau rtls controller (erc). type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - erc_server_port (Alias name: erc-server-port) Ekahau rtls controller (erc) udp listening port. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_ble (Alias name: fortipresence-ble) Enable/disable fortipresence finding and reporting ble devices. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_frequency (Alias name: fortipresence-frequency) Fortipresence report transmit frequency (5 - 65535 sec, default = 30). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_port (Alias name: fortipresence-port) Fortipresence server udp listening port (default = 3000). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_project (Alias name: fortipresence-project) Fortipresence project name (max. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_rogue (Alias name: fortipresence-rogue) Enable/disable fortipresence finding and reporting rogue aps. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_secret (Alias name: fortipresence-secret) Fortipresence secret password (max. type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_server (Alias name: fortipresence-server) Fortipresence server ip address. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_unassoc (Alias name: fortipresence-unassoc) Enable/disable fortipresence finding and reporting unassociated stations. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - fortipresence_server_addr_type (Alias name: fortipresence-server-addr-type) Fortipresence server address type (default = ipv4). type: str choices: [fqdn, ipv4]
more...
Supported Version Ranges:
v7.0.2 -> latest - fortipresence_server_fqdn (Alias name: fortipresence-server-fqdn) Fqdn of fortipresence server. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest - polestar Enable/disable polestar ble nao track real time location service (rtls) support (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.1 -> latest - polestar_accumulation_interval (Alias name: polestar-accumulation-interval) Time that measurements should be accumulated in seconds (default = 2). type: int
more...
Supported Version Ranges:
v7.4.1 -> latest - polestar_asset_addrgrp_list (Alias name: polestar-asset-addrgrp-list) Tags and asset addrgrp list to be reported. type: str
more...
Supported Version Ranges:
v7.4.1 -> latest - 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...
Supported Version Ranges:
v7.4.1 -> latest - 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...
Supported Version Ranges:
v7.4.1 -> latest - 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...
Supported Version Ranges:
v7.4.1 -> latest - 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...
Supported Version Ranges:
v7.4.1 -> latest - 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...
Supported Version Ranges:
v7.4.1 -> latest - polestar_reporting_interval (Alias name: polestar-reporting-interval) Time between reporting accumulated measurements in seconds (default = 2). type: int
more...
Supported Version Ranges:
v7.4.1 -> latest - polestar_server_fqdn (Alias name: polestar-server-fqdn) Fqdn of polestar nao track server (default = ws. type: str
more...
Supported Version Ranges:
v7.4.1 -> latest - polestar_server_path (Alias name: polestar-server-path) Path of polestar nao track server (default = /v1/token//pst-v2). type: str
more...
Supported Version Ranges:
v7.4.1 -> latest - polestar_server_port (Alias name: polestar-server-port) Port of polestar nao track server (default = 443). type: int
more...
Supported Version Ranges:
v7.4.1 -> latest - polestar_server_token (Alias name: polestar-server-token) Access token of polestar nao track server. type: str
more...
Supported Version Ranges:
v7.4.1 -> latest
- aeroscout Enable/disable aeroscout real time location service (rtls) support (default = disable). type: str choices: [disable, enable]
more...
- platform type: dict
- ddscan Enable/disable use of one radio for dedicated dual-band scanning to detect rf characterization and wireless threat management. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - mode Configure operation mode of 5g radios (default = single-5g). type: str choices: [dual-5G, single-5G]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - _local_platform_str _local_platform_str. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.6 -> latest
- ddscan Enable/disable use of one radio for dedicated dual-band scanning to detect rf characterization and wireless threat management. type: str choices: [disable, enable]
more...
- radio_1 (Alias name: radio-1) type: dict
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - amsdu Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - auto_power_target (Alias name: auto-power-target) The target of automatic transmit power adjustment in dbm. type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - band Wifi band that radio 1 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only, 802.11ax-5G-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-6G]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - beacon_interval (Alias name: beacon-interval) Beacon interval. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, 0 means disable. type: int
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_bonding (Alias name: channel-bonding) Channel bandwidth: 160,80, 40, or 20mhz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz, 160MHz]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.4.5 -> latest - dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - mode Mode of radio 1. type: str choices: [disabled, ap, monitor, sniffer, sam]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - power_level (Alias name: power-level) Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - radio_id (Alias name: radio-id) Radio-id. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vaps Manually selected list of virtual access points (vaps). type: list or str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp]
more...
Supported Version Ranges:
v7.0.0 -> latest - iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - sam_server (Alias name: sam-server) Sam test server ip address or domain name. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_username (Alias name: sam-username) Username for wifi network connection. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest - bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static]
more...
Supported Version Ranges:
v7.0.2 -> latest - sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_password (Alias name: sam-cwp-password) type: list
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn]
more...
Supported Version Ranges:
v7.0.1 -> latest - d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> latest - 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]
more...
Supported Version Ranges:
v7.2.3 -> latest - mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8]
more...
Supported Version Ranges:
v7.4.1 -> latest - optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both]
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key_password (Alias name: sam-private-key-password) type: list
more...
Supported Version Ranges:
v7.4.2 -> latest
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
- radio_2 (Alias name: radio-2) type: dict
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - amsdu Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - auto_power_target (Alias name: auto-power-target) The target of automatic transmit power adjustment in dbm. type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - band Wifi band that radio 2 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only, 802.11ax-5G-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-6G]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - beacon_interval (Alias name: beacon-interval) Beacon interval. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, 0 means disable. type: int
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_bonding (Alias name: channel-bonding) Channel bandwidth: 160,80, 40, or 20mhz. type: str choices: [disable, enable, 80MHz, 40MHz, 20MHz, 160MHz]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.4.5 -> latest - dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - mode Mode of radio 2. type: str choices: [disabled, ap, monitor, sniffer, sam]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - power_level (Alias name: power-level) Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - radio_id (Alias name: radio-id) Radio-id. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vaps Manually selected list of virtual access points (vaps). type: list or str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp]
more...
Supported Version Ranges:
v7.0.0 -> latest - iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - sam_server (Alias name: sam-server) Sam test server ip address or domain name. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_username (Alias name: sam-username) Username for wifi network connection. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest - bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static]
more...
Supported Version Ranges:
v7.0.2 -> latest - sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_password (Alias name: sam-cwp-password) type: list
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn]
more...
Supported Version Ranges:
v7.0.1 -> latest - d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> latest - 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]
more...
Supported Version Ranges:
v7.2.3 -> latest - mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8]
more...
Supported Version Ranges:
v7.4.1 -> latest - optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both]
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key_password (Alias name: sam-private-key-password) type: list
more...
Supported Version Ranges:
v7.4.2 -> latest
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
- radio_3 (Alias name: radio-3) type: dict
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - amsdu Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - auto_power_target (Alias name: auto-power-target) The target of automatic transmit power adjustment in dbm. type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - band Wifi band that radio 3 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only, 802.11ax-5G-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-6G]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - beacon_interval (Alias name: beacon-interval) Beacon interval. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, 0 means disable. type: int
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_bonding (Alias name: channel-bonding) Channel bandwidth: 160,80, 40, or 20mhz. type: str choices: [80MHz, 40MHz, 20MHz, 160MHz]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.4.5 -> latest - dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - mode Mode of radio 3. type: str choices: [disabled, ap, monitor, sniffer, sam]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - power_level (Alias name: power-level) Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - radio_id (Alias name: radio-id) Radio-id. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vaps Manually selected list of virtual access points (vaps). type: list or str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp]
more...
Supported Version Ranges:
v7.0.0 -> latest - iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - sam_server (Alias name: sam-server) Sam test server ip address or domain name. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_username (Alias name: sam-username) Username for wifi network connection. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest - bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static]
more...
Supported Version Ranges:
v7.0.2 -> latest - sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_password (Alias name: sam-cwp-password) type: list
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn]
more...
Supported Version Ranges:
v7.0.1 -> latest - d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> latest - 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]
more...
Supported Version Ranges:
v7.2.3 -> latest - mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8]
more...
Supported Version Ranges:
v7.4.1 -> latest - optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both]
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key_password (Alias name: sam-private-key-password) type: list
more...
Supported Version Ranges:
v7.4.2 -> latest
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
- radio_4 (Alias name: radio-4) type: dict
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - amsdu Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_addr (Alias name: ap-sniffer-addr) Mac address to monitor. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_bufsize (Alias name: ap-sniffer-bufsize) Sniffer buffer size (1 - 32 mb, default = 16). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_chan (Alias name: ap-sniffer-chan) Channel on which to operate the sniffer (default = 6). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_ctl (Alias name: ap-sniffer-ctl) Enable/disable sniffer on wifi control frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_sniffer_data (Alias name: ap-sniffer-data) Enable/disable sniffer on wifi data frame (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - auto_power_target (Alias name: auto-power-target) The target of automatic transmit power adjustment in dbm. type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - band Wifi band that radio 3 operates on. type: str choices: [802.11b, 802.11a, 802.11g, 802.11n, 802.11ac, 802.11n-5G, 802.11ax-5G, 802.11ax, 802.11ac-2G, 802.11g-only, 802.11n-only, 802.11n,g-only, 802.11ac-only, 802.11ac,n-only, 802.11n-5G-only, 802.11ax-5G-only, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-only, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-6G]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - band_5g_type (Alias name: band-5g-type) Wifi 5g band type. type: str choices: [5g-full, 5g-high, 5g-low]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bandwidth_capacity (Alias name: bandwidth-capacity) Maximum bandwidth capacity allowed (1 - 600000 kbps, default = 2000). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - beacon_interval (Alias name: beacon-interval) Beacon interval. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - bss_color (Alias name: bss-color) Bss color value for this 11ax radio (0 - 63, 0 means disable. type: int
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_bonding (Alias name: channel-bonding) Channel bandwidth: 160,80, 40, or 20mhz. type: str choices: [80MHz, 40MHz, 20MHz, 160MHz]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - channel_utilization (Alias name: channel-utilization) Enable/disable measuring channel utilization. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - coexistence Enable/disable allowing both ht20 and ht40 on the same radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - drma Enable/disable dynamic radio mode assignment (drma) (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.4.5 -> latest - dtim Delivery traffic indication map (dtim) period (1 - 255, default = 1). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frag_threshold (Alias name: frag-threshold) Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_clients (Alias name: max-clients) Maximum number of stations (stas) or wifi clients supported by the radio. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - max_distance (Alias name: max-distance) Maximum expected distance between the ap and clients (0 - 54000 m, default = 0). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - mode Mode of radio 3. type: str choices: [ap, monitor, sniffer, disabled, sam]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - power_level (Alias name: power-level) Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - protection_mode (Alias name: protection-mode) Enable/disable 802. type: str choices: [rtscts, ctsonly, disable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - radio_id (Alias name: radio-id) Radio-id. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - 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...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges:
v6.4.5 -> latest - vaps Manually selected list of virtual access points (vaps). type: list or str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - wids_profile (Alias name: wids-profile) Wireless intrusion detection system (wids) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - zero_wait_dfs (Alias name: zero-wait-dfs) Enable/disable zero wait dfs on radio (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - frequency_handoff (Alias name: frequency-handoff) Enable/disable frequency handoff of clients to other channels (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - ap_handoff (Alias name: ap-handoff) Enable/disable ap handoff of clients to other aps (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12,v6.4.5 -> latest - iperf_protocol (Alias name: iperf-protocol) Iperf test protocol (default = udp). type: str choices: [udp, tcp]
more...
Supported Version Ranges:
v7.0.0 -> latest - iperf_server_port (Alias name: iperf-server-port) Iperf service port number. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_bssid (Alias name: sam-bssid) Bssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_captive_portal (Alias name: sam-captive-portal) Enable/disable captive portal authentication (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_password (Alias name: sam-password) Passphrase for wifi network connection. type: list
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_report_intv (Alias name: sam-report-intv) Sam report interval (sec), 0 for a one-time report. type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - 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...
Supported Version Ranges:
v7.0.0 -> latest - sam_server (Alias name: sam-server) Sam test server ip address or domain name. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_ssid (Alias name: sam-ssid) Ssid for wifi network. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_test (Alias name: sam-test) Select sam test type (default = ping). type: str choices: [ping, iperf]
more...
Supported Version Ranges:
v7.0.0 -> latest - sam_username (Alias name: sam-username) Username for wifi network connection. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest - arrp_profile (Alias name: arrp-profile) Distributed automatic radio resource provisioning (darrp) profile name to assign to the radio. type: str
more...
Supported Version Ranges:
v7.0.3 -> latest - bss_color_mode (Alias name: bss-color-mode) Bss color mode for this 11ax radio (default = auto). type: str choices: [auto, static]
more...
Supported Version Ranges:
v7.0.2 -> latest - sam_cwp_failure_string (Alias name: sam-cwp-failure-string) Failure identification on the page after an incorrect login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_match_string (Alias name: sam-cwp-match-string) Identification string from the captive portal login form. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_password (Alias name: sam-cwp-password) type: list
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_success_string (Alias name: sam-cwp-success-string) Success identification on the page after a successful login. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_test_url (Alias name: sam-cwp-test-url) Website the client is trying to access. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_cwp_username (Alias name: sam-cwp-username) Username for captive portal authentication. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_fqdn (Alias name: sam-server-fqdn) Sam test server domain name. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_ip (Alias name: sam-server-ip) Sam test server ip address. type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - sam_server_type (Alias name: sam-server-type) Select sam server type (default = ip). type: str choices: [ip, fqdn]
more...
Supported Version Ranges:
v7.0.1 -> latest - d80211d (Alias name: 80211d) Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> latest - 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]
more...
Supported Version Ranges:
v7.2.3 -> latest - mimo_mode (Alias name: mimo-mode) Configure radio mimo mode (default = default). type: str choices: [default, 1x1, 2x2, 3x3, 4x4, 8x8]
more...
Supported Version Ranges:
v7.4.1 -> latest - optional_antenna_gain (Alias name: optional-antenna-gain) Optional antenna gain in dbi (0 to 20, default = 0). type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_ca_certificate (Alias name: sam-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_client_certificate (Alias name: sam-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_eap_method (Alias name: sam-eap-method) Select wpa2/wpa3-enterprise eap method (default = peap). type: str choices: [tls, peap, both]
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key (Alias name: sam-private-key) Private key for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - sam_private_key_password (Alias name: sam-private-key-password) type: list
more...
Supported Version Ranges:
v7.4.2 -> latest
- airtime_fairness (Alias name: airtime-fairness) Enable/disable airtime fairness (default = disable). type: str choices: [disable, enable]
more...
- console_login (Alias name: console-login) Enable/disable fortiap console login access (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.9 -> v6.2.12,v6.4.8 -> v6.4.14,v7.0.1 -> latest - esl_ses_dongle (Alias name: esl-ses-dongle) type: dict
- apc_addr_type (Alias name: apc-addr-type) Esl ses-imagotag apc address type (default = fqdn). type: str choices: [fqdn, ip]
more...
Supported Version Ranges:
v7.0.1 -> latest - apc_fqdn (Alias name: apc-fqdn) Fqdn of esl ses-imagotag access point controller (apc). type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - apc_ip (Alias name: apc-ip) Ip address of esl ses-imagotag access point controller (apc). type: str
more...
Supported Version Ranges:
v7.0.1 -> latest - apc_port (Alias name: apc-port) Port of esl ses-imagotag access point controller (apc). type: int
more...
Supported Version Ranges:
v7.0.1 -> latest - coex_level (Alias name: coex-level) Esl ses-imagotag dongle coexistence level (default = none). type: str choices: [none]
more...
Supported Version Ranges:
v7.0.1 -> latest - compliance_level (Alias name: compliance-level) Compliance levels for the esl solution integration (default = compliance-level-2). type: str choices: [compliance-level-2]
more...
Supported Version Ranges:
v7.0.1 -> latest - 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...
Supported Version Ranges:
v7.0.1 -> latest - 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...
Supported Version Ranges:
v7.0.1 -> latest - scd_enable (Alias name: scd-enable) Enable/disable esl ses-imagotag serial communication daemon (scd) (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.1 -> latest - tls_cert_verification (Alias name: tls-cert-verification) Enable/disable tls certificate verification (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.1 -> latest - tls_fqdn_verification (Alias name: tls-fqdn-verification) Enable/disable tls certificate verification (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.1 -> latest
- apc_addr_type (Alias name: apc-addr-type) Esl ses-imagotag apc address type (default = fqdn). type: str choices: [fqdn, ip]
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...
Supported Version Ranges:
v7.0.1 -> latest - syslog_profile (Alias name: syslog-profile) System log server configuration profile name. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest - wan_port_auth (Alias name: wan-port-auth) Set wan port authentication mode (default = none). type: str choices: [none, 802.1x]
more...
Supported Version Ranges:
v7.0.2 -> latest - wan_port_auth_methods (Alias name: wan-port-auth-methods) Wan port 802. type: str choices: [all, EAP-FAST, EAP-TLS, EAP-PEAP]
more...
Supported Version Ranges:
v7.0.2 -> latest - wan_port_auth_password (Alias name: wan-port-auth-password) type: list
more...
Supported Version Ranges:
v7.0.2 -> latest - wan_port_auth_usrname (Alias name: wan-port-auth-usrname) Set wan port 802. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest - _is_factory_setting type: str choices: [disable, enable, ext] default: disable
more...
Supported Version Ranges:
v7.4.0 -> latest - 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...
Supported Version Ranges:
v7.4.0 -> latest - bonjour_profile (Alias name: bonjour-profile) Bonjour profile name. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - wan_port_auth_macsec (Alias name: wan-port-auth-macsec) Enable/disable wan port 802. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
fortinet.fortimanager.fmgr_wtpprofile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
wtpprofile:
allowaccess:
- https
- ssh
- snmp
- http
- telnet
ap_country: <value in [AL, DZ, AR, ...]>
ble_profile: <string>
comment: <string>
control_message_offload:
- ebp-frame
- aeroscout-tag
- ap-list
- sta-list
- sta-cap-list
- stats
- aeroscout-mu
- sta-health
- spectral-analysis
deny_mac_list:
-
id: <integer>
mac: <string>
dtls_in_kernel: <value in [disable, enable]>
dtls_policy:
- clear-text
- dtls-enabled
- ipsec-vpn
- ipsec-sn-vpn
energy_efficient_ethernet: <value in [disable, enable]>
ext_info_enable: <value in [disable, enable]>
handoff_roaming: <value in [disable, enable]>
handoff_rssi: <integer>
handoff_sta_thresh: <integer>
ip_fragment_preventing:
- tcp-mss-adjust
- icmp-unreachable
led_schedules: <list or string>
led_state: <value in [disable, enable]>
lldp: <value in [disable, enable]>
login_passwd: <list or string>
login_passwd_change: <value in [no, yes, default]>
max_clients: <integer>
name: <string>
poe_mode: <value in [auto, 8023af, 8023at, ...]>
split_tunneling_acl:
-
dest_ip: <string>
id: <integer>
split_tunneling_acl_local_ap_subnet: <value in [disable, enable]>
split_tunneling_acl_path: <value in [tunnel, local]>
tun_mtu_downlink: <integer>
tun_mtu_uplink: <integer>
wan_port_mode: <value in [wan-lan, wan-only]>
snmp: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
apcfg_profile: <string>
frequency_handoff: <value in [disable, enable]>
lan:
port_esl_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port_esl_ssid: <string>
port_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port_ssid: <string>
port1_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port1_ssid: <string>
port2_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port2_ssid: <string>
port3_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port3_ssid: <string>
port4_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port4_ssid: <string>
port5_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port5_ssid: <string>
port6_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port6_ssid: <string>
port7_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port7_ssid: <string>
port8_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port8_ssid: <string>
lbs:
aeroscout: <value in [disable, enable]>
aeroscout_ap_mac: <value in [bssid, board-mac]>
aeroscout_mmu_report: <value in [disable, enable]>
aeroscout_mu: <value in [disable, enable]>
aeroscout_mu_factor: <integer>
aeroscout_mu_timeout: <integer>
aeroscout_server_ip: <string>
aeroscout_server_port: <integer>
ekahau_blink_mode: <value in [disable, enable]>
ekahau_tag: <string>
erc_server_ip: <string>
erc_server_port: <integer>
fortipresence: <value in [disable, enable, enable2, ...]>
fortipresence_ble: <value in [disable, enable]>
fortipresence_frequency: <integer>
fortipresence_port: <integer>
fortipresence_project: <string>
fortipresence_rogue: <value in [disable, enable]>
fortipresence_secret: <list or string>
fortipresence_server: <string>
fortipresence_unassoc: <value in [disable, enable]>
station_locate: <value in [disable, enable]>
fortipresence_server_addr_type: <value in [fqdn, ipv4]>
fortipresence_server_fqdn: <string>
polestar: <value in [disable, enable]>
polestar_accumulation_interval: <integer>
polestar_asset_addrgrp_list: <string>
polestar_asset_uuid_list1: <string>
polestar_asset_uuid_list2: <string>
polestar_asset_uuid_list3: <string>
polestar_asset_uuid_list4: <string>
polestar_protocol: <value in [WSS]>
polestar_reporting_interval: <integer>
polestar_server_fqdn: <string>
polestar_server_path: <string>
polestar_server_port: <integer>
polestar_server_token: <string>
platform:
ddscan: <value in [disable, enable]>
mode: <value in [dual-5G, single-5G]>
type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
_local_platform_str: <string>
radio_1:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [disable, enable, 80MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
radio_2:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [disable, enable, 80MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
radio_3:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [disabled, ap, monitor, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
radio_4:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_sniffer_addr: <string>
ap_sniffer_bufsize: <integer>
ap_sniffer_chan: <integer>
ap_sniffer_ctl: <value in [disable, enable]>
ap_sniffer_data: <value in [disable, enable]>
ap_sniffer_mgmt_beacon: <value in [disable, enable]>
ap_sniffer_mgmt_other: <value in [disable, enable]>
ap_sniffer_mgmt_probe: <value in [disable, enable]>
auto_power_high: <integer>
auto_power_level: <value in [disable, enable]>
auto_power_low: <integer>
auto_power_target: <string>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <integer>
bss_color: <integer>
call_admission_control: <value in [disable, enable]>
call_capacity: <integer>
channel: <list or string>
channel_bonding: <value in [80MHz, 40MHz, 20MHz, ...]>
channel_utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
dtim: <integer>
frag_threshold: <integer>
max_clients: <integer>
max_distance: <integer>
mode: <value in [ap, monitor, sniffer, ...]>
power_level: <integer>
powersave_optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection_mode: <value in [rtscts, ctsonly, disable]>
radio_id: <integer>
rts_threshold: <integer>
short_guard_interval: <value in [disable, enable]>
spectrum_analysis: <value in [disable, enable, scan-only]>
transmit_optimize:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
vap_all: <value in [disable, enable, tunnel, ...]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
vaps: <list or string>
wids_profile: <string>
zero_wait_dfs: <value in [disable, enable]>
frequency_handoff: <value in [disable, enable]>
ap_handoff: <value in [disable, enable]>
iperf_protocol: <value in [udp, tcp]>
iperf_server_port: <integer>
power_mode: <value in [dBm, percentage]>
power_value: <integer>
sam_bssid: <string>
sam_captive_portal: <value in [disable, enable]>
sam_password: <list or string>
sam_report_intv: <integer>
sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
sam_server: <string>
sam_ssid: <string>
sam_test: <value in [ping, iperf]>
sam_username: <string>
arrp_profile: <string>
bss_color_mode: <value in [auto, static]>
sam_cwp_failure_string: <string>
sam_cwp_match_string: <string>
sam_cwp_password: <list or string>
sam_cwp_success_string: <string>
sam_cwp_test_url: <string>
sam_cwp_username: <string>
sam_server_fqdn: <string>
sam_server_ip: <string>
sam_server_type: <value in [ip, fqdn]>
d80211d: <value in [disable, enable]>
optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
mimo_mode: <value in [default, 1x1, 2x2, ...]>
optional_antenna_gain: <string>
sam_ca_certificate: <string>
sam_client_certificate: <string>
sam_eap_method: <value in [tls, peap, both]>
sam_private_key: <string>
sam_private_key_password: <list or string>
console_login: <value in [disable, enable]>
esl_ses_dongle:
apc_addr_type: <value in [fqdn, ip]>
apc_fqdn: <string>
apc_ip: <string>
apc_port: <integer>
coex_level: <value in [none]>
compliance_level: <value in [compliance-level-2]>
esl_channel: <value in [0, 1, 2, ...]>
output_power: <value in [a, b, c, ...]>
scd_enable: <value in [disable, enable]>
tls_cert_verification: <value in [disable, enable]>
tls_fqdn_verification: <value in [disable, enable]>
indoor_outdoor_deployment: <value in [platform-determined, outdoor, indoor]>
syslog_profile: <string>
wan_port_auth: <value in [none, 802.1x]>
wan_port_auth_methods: <value in [all, EAP-FAST, EAP-TLS, ...]>
wan_port_auth_password: <list or string>
wan_port_auth_usrname: <string>
_is_factory_setting: <value in [disable, enable, ext]>
unii_4_5ghz_band: <value in [disable, enable]>
bonjour_profile: <string>
wan_port_auth_macsec: <value in [disable, enable]>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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)