fortinet.fortimanager.fmgr_wtpprofile module – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
|
The top level parameters set. |
|
Is factory setting. Choices:
|
|
Control management access to the managed WTP, FortiAP, or AP. Choices:
|
|
Deprecated, please rename it to ap_country. Country in which this WTP, FortiAP or AP will operate Choices:
|
|
Deprecated, please rename it to ap_handoff. Enable/disable AP handoff of clients to other APs Choices:
|
|
Deprecated, please rename it to apcfg_profile. AP local configuration profile name. |
|
Deprecated, please rename it to ble_profile. Bluetooth Low Energy profile name. |
|
Deprecated, please rename it to bonjour_profile. Bonjour profile name. |
|
Comment. |
|
Deprecated, please rename it to console_login. Enable/disable FortiAP console login access Choices:
|
|
Deprecated, please rename it to control_message_offload. Enable/disable CAPWAP control message data channel offload. Choices:
|
|
Deprecated, please rename it to deny_mac_list. Deny mac list. |
|
ID. |
|
A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. |
|
Deprecated, please rename it to dtls_in_kernel. Enable/disable data channel DTLS in kernel. Choices:
|
|
Deprecated, please rename it to dtls_policy. WTP data channel DTLS policy Choices:
|
|
Deprecated, please rename it to energy_efficient_ethernet. Enable/disable use of energy efficient Ethernet on WTP. Choices:
|
|
Deprecated, please rename it to esl_ses_dongle. Esl ses dongle. |
|
Deprecated, please rename it to apc_addr_type. ESL SES-imagotag APC address type Choices:
|
|
Deprecated, please rename it to apc_fqdn. FQDN of ESL SES-imagotag Access Point Controller |
|
Deprecated, please rename it to apc_ip. IP address of ESL SES-imagotag Access Point Controller |
|
Deprecated, please rename it to apc_port. Port of ESL SES-imagotag Access Point Controller |
|
Deprecated, please rename it to coex_level. ESL SES-imagotag dongle coexistence level Choices:
|
|
Deprecated, please rename it to compliance_level. Compliance levels for the ESL solution integration Choices:
|
|
Deprecated, please rename it to esl_channel. ESL SES-imagotag dongle channel Choices:
|
|
Deprecated, please rename it to output_power. ESL SES-imagotag dongle output power Choices:
|
|
Deprecated, please rename it to scd_enable. Enable/disable ESL SES-imagotag Serial Communication Daemon Choices:
|
|
Deprecated, please rename it to tls_cert_verification. Enable/disable TLS certificate verification Choices:
|
|
Deprecated, please rename it to tls_fqdn_verification. Enable/disable TLS certificate verification Choices:
|
|
Deprecated, please rename it to ext_info_enable. Enable/disable station/VAP/radio extension information. Choices:
|
|
Deprecated, please rename it to frequency_handoff. Enable/disable frequency handoff of clients to other channels Choices:
|
|
Deprecated, please rename it to handoff_roaming. Enable/disable client load balancing during roaming to avoid roaming delay Choices:
|
|
Deprecated, please rename it to handoff_rssi. Minimum received signal strength indicator |
|
Deprecated, please rename it to handoff_sta_thresh. Threshold value for AP handoff. |
|
Deprecated, please rename it to indoor_outdoor_deployment. Set to allow indoor/outdoor-only channels under regulatory rules Choices:
|
|
Deprecated, please rename it to ip_fragment_preventing. Select how to prevent IP fragmentation for CAPWAP tunneled control… Choices:
|
|
Lan. |
|
Deprecated, please rename it to port_esl_mode. ESL port mode. Choices:
|
|
Deprecated, please rename it to port_esl_ssid. Bridge ESL port to SSID. |
|
Deprecated, please rename it to port_mode. LAN port mode. Choices:
|
|
Deprecated, please rename it to port_ssid. Bridge LAN port to SSID. |
|
Deprecated, please rename it to port1_mode. LAN port 1 mode. Choices:
|
|
Deprecated, please rename it to port1_ssid. Bridge LAN port 1 to SSID. |
|
Deprecated, please rename it to port2_mode. LAN port 2 mode. Choices:
|
|
Deprecated, please rename it to port2_ssid. Bridge LAN port 2 to SSID. |
|
Deprecated, please rename it to port3_mode. LAN port 3 mode. Choices:
|
|
Deprecated, please rename it to port3_ssid. Bridge LAN port 3 to SSID. |
|
Deprecated, please rename it to port4_mode. LAN port 4 mode. Choices:
|
|
Deprecated, please rename it to port4_ssid. Bridge LAN port 4 to SSID. |
|
Deprecated, please rename it to port5_mode. LAN port 5 mode. Choices:
|
|
Deprecated, please rename it to port5_ssid. Bridge LAN port 5 to SSID. |
|
Deprecated, please rename it to port6_mode. LAN port 6 mode. Choices:
|
|
Deprecated, please rename it to port6_ssid. Bridge LAN port 6 to SSID. |
|
Deprecated, please rename it to port7_mode. LAN port 7 mode. Choices:
|
|
Deprecated, please rename it to port7_ssid. Bridge LAN port 7 to SSID. |
|
Deprecated, please rename it to port8_mode. LAN port 8 mode. Choices:
|
|
Deprecated, please rename it to port8_ssid. Bridge LAN port 8 to SSID. |
|
Lbs. |
|
Enable/disable AeroScout Real Time Location Service Choices:
|
|
Deprecated, please rename it to aeroscout_ap_mac. Use BSSID or board MAC address as AP MAC address in AeroScout AP… Choices:
|
|
Deprecated, please rename it to aeroscout_mmu_report. Enable/disable compounded AeroScout tag and MU report Choices:
|
|
Deprecated, please rename it to aeroscout_mu. Enable/disable AeroScout Mobile Unit Choices:
|
|
Deprecated, please rename it to aeroscout_mu_factor. AeroScout MU mode dilution factor |
|
Deprecated, please rename it to aeroscout_mu_timeout. AeroScout MU mode timeout |
|
Deprecated, please rename it to aeroscout_server_ip. IP address of AeroScout server. |
|
Deprecated, please rename it to aeroscout_server_port. AeroScout server UDP listening port. |
|
Deprecated, please rename it to ekahau_blink_mode. Enable/disable Ekahau blink mode Choices:
|
|
Deprecated, please rename it to ekahau_tag. WiFi frame MAC address or WiFi Tag. |
|
Deprecated, please rename it to erc_server_ip. IP address of Ekahau RTLS Controller |
|
Deprecated, please rename it to erc_server_port. Ekahau RTLS Controller |
|
Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to thi… Choices:
|
|
Deprecated, please rename it to fortipresence_ble. Enable/disable FortiPresence finding and reporting BLE devices. Choices:
|
|
Deprecated, please rename it to fortipresence_frequency. FortiPresence report transmit frequency |
|
Deprecated, please rename it to fortipresence_port. FortiPresence server UDP listening port |
|
Deprecated, please rename it to fortipresence_project. FortiPresence project name |
|
Deprecated, please rename it to fortipresence_rogue. Enable/disable FortiPresence finding and reporting rogue APs. Choices:
|
|
(list) Deprecated, please rename it to fortipresence_secret. FortiPresence secret password |
|
Deprecated, please rename it to fortipresence_server. FortiPresence server IP address. |
|
Deprecated, please rename it to fortipresence_server_addr_type. FortiPresence server address type Choices:
|
|
Deprecated, please rename it to fortipresence_server_fqdn. FQDN of FortiPresence server. |
|
Deprecated, please rename it to fortipresence_unassoc. Enable/disable FortiPresence finding and reporting unassoci… Choices:
|
|
Enable/disable PoleStar BLE NAO Track Real Time Location Service Choices:
|
|
Deprecated, please rename it to polestar_accumulation_interval. Time that measurements should be accumulated in se… |
|
Deprecated, please rename it to polestar_asset_addrgrp_list. Tags and asset addrgrp list to be reported. |
|
Deprecated, please rename it to polestar_asset_uuid_list1. Tags and asset UUID list 1 to be reported |
|
Deprecated, please rename it to polestar_asset_uuid_list2. Tags and asset UUID list 2 to be reported |
|
Deprecated, please rename it to polestar_asset_uuid_list3. Tags and asset UUID list 3 to be reported |
|
Deprecated, please rename it to polestar_asset_uuid_list4. Tags and asset UUID list 4 to be reported |
|
Deprecated, please rename it to polestar_protocol. Select the protocol to report Measurements, Advertising Data, o… Choices:
|
|
Deprecated, please rename it to polestar_reporting_interval. Time between reporting accumulated measurements in se… |
|
Deprecated, please rename it to polestar_server_fqdn. FQDN of PoleStar Nao Track Server |
|
Deprecated, please rename it to polestar_server_path. Path of PoleStar Nao Track Server |
|
Deprecated, please rename it to polestar_server_port. Port of PoleStar Nao Track Server |
|
Deprecated, please rename it to polestar_server_token. Access Token of PoleStar Nao Track Server. |
|
Deprecated, please rename it to station_locate. Enable/disable client station locating services for all clients, w… Choices:
|
|
(list or str) Deprecated, please rename it to led_schedules. Recurring firewall schedules for illuminating LEDs on the For… |
|
Deprecated, please rename it to led_state. Enable/disable use of LEDs on WTP Choices:
|
|
Enable/disable Link Layer Discovery Protocol Choices:
|
|
(list) Deprecated, please rename it to login_passwd. Set the managed WTP, FortiAP, or APs administrator password. |
|
Deprecated, please rename it to login_passwd_change. Change or reset the administrator password of a managed WTP, FortiAP … Choices:
|
|
Deprecated, please rename it to max_clients. Maximum number of stations |
|
WTP |
|
Platform. |
|
Local platform str. |
|
Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat… Choices:
|
|
Configure operation mode of 5G radios Choices:
|
|
WTP, FortiAP or AP platform type. Choices:
|
|
Deprecated, please rename it to poe_mode. Set the WTP, FortiAP, or APs PoE mode. Choices:
|
|
Deprecated, please rename it to radio_1. Radio 1. |
|
Deprecated, please rename it to d80211d. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to d80211mc. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to airtime_fairness. Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Deprecated, please rename it to ap_handoff. Enable/disable AP handoff of clients to other APs Choices:
|
|
Deprecated, please rename it to ap_sniffer_addr. MAC address to monitor. |
|
Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size |
|
Deprecated, please rename it to ap_sniffer_chan. Channel on which to operate the sniffer |
|
Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer. Choices:
|
|
Deprecated, please rename it to ap_sniffer_ctl. Enable/disable sniffer on WiFi control frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_data. Enable/disable sniffer on WiFi data frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable sniffer on WiFi management other frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Deprecated, please rename it to arrp_profile. Distributed Automatic Radio Resource Provisioning |
|
Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_level. Enable/disable automatic power-level adjustment to prevent co-ch… Choices:
|
|
Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_target. The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 1 operates on. Choices:
|
|
Deprecated, please rename it to band_5g_type. WiFi 5G band type. Choices:
|
|
Deprecated, please rename it to bandwidth_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth capacity allowed |
|
Deprecated, please rename it to beacon_interval. Beacon interval. |
|
Deprecated, please rename it to bss_color. BSS color value for this 11ax radio |
|
Deprecated, please rename it to bss_color_mode. BSS color mode for this 11ax radio Choices:
|
|
Deprecated, please rename it to call_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to call_capacity. Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Deprecated, please rename it to channel_bonding. Channel bandwidth Choices:
|
|
Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension Choices:
|
|
Deprecated, please rename it to channel_utilization. Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Deprecated, please rename it to drma_sensitivity. Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Deprecated, please rename it to frag_threshold. Maximum packet size that can be sent without fragmentation |
|
Deprecated, please rename it to frequency_handoff. Enable/disable frequency handoff of clients to other channels Choices:
|
|
Deprecated, please rename it to iperf_protocol. Iperf test protocol Choices:
|
|
Deprecated, please rename it to iperf_server_port. Iperf service port number. |
|
Deprecated, please rename it to max_clients. Maximum number of stations |
|
Deprecated, please rename it to max_distance. Maximum expected distance between the AP and clients |
|
Deprecated, please rename it to mimo_mode. Configure radio MIMO mode Choices:
|
|
Mode of radio 1. Choices:
|
|
Deprecated, please rename it to optional_antenna. Optional antenna used on FAP Choices:
|
|
Deprecated, please rename it to optional_antenna_gain. Optional antenna gain in dBi |
|
Deprecated, please rename it to power_level. Radio power level as a percentage of the maximum transmit power |
|
Deprecated, please rename it to power_mode. Set radio effective isotropic radiated power Choices:
|
|
Deprecated, please rename it to power_value. Radio EIRP power in dBm |
|
Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB… Choices:
|
|
Deprecated, please rename it to protection_mode. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to radio_id. Radio id. |
|
Deprecated, please rename it to rts_threshold. Maximum packet size for RTS transmissions, specifying the maximum s… |
|
Deprecated, please rename it to sam_bssid. BSSID for WiFi network. |
|
Deprecated, please rename it to sam_ca_certificate. CA certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_captive_portal. Enable/disable Captive Portal Authentication Choices:
|
|
Deprecated, please rename it to sam_client_certificate. Client certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_cwp_failure_string. Failure identification on the page after an incorrect login. |
|
Deprecated, please rename it to sam_cwp_match_string. Identification string from the captive portal login form. |
|
(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication. |
|
Deprecated, please rename it to sam_cwp_success_string. Success identification on the page after a successful login. |
|
Deprecated, please rename it to sam_cwp_test_url. Website the client is trying to access. |
|
Deprecated, please rename it to sam_cwp_username. Username for captive portal authentication. |
|
Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE EAP Method Choices:
|
|
(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection. |
|
Deprecated, please rename it to sam_private_key. Private key for WPA2/WPA3-ENTERPRISE. |
|
(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER… |
|
Deprecated, please rename it to sam_report_intv. SAM report interval |
|
Deprecated, please rename it to sam_security_type. Select WiFi network security type Choices:
|
|
Deprecated, please rename it to sam_server. SAM test server IP address or domain name. |
|
Deprecated, please rename it to sam_server_fqdn. SAM test server domain name. |
|
Deprecated, please rename it to sam_server_ip. SAM test server IP address. |
|
Deprecated, please rename it to sam_server_type. Select SAM server type Choices:
|
|
Deprecated, please rename it to sam_ssid. SSID for WiFi network. |
|
Deprecated, please rename it to sam_test. Select SAM test type Choices:
|
|
Deprecated, please rename it to sam_username. Username for WiFi network connection. |
|
Deprecated, please rename it to short_guard_interval. Use either the short guard interval Choices:
|
|
Deprecated, please rename it to spectrum_analysis. Enable/disable spectrum analysis to find interference that woul… Choices:
|
|
Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving… Choices:
|
|
Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Deprecated, please rename it to wids_profile. Wireless Intrusion Detection System |
|
Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio Choices:
|
|
Deprecated, please rename it to radio_2. Radio 2. |
|
Deprecated, please rename it to d80211d. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to d80211mc. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to airtime_fairness. Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Deprecated, please rename it to ap_handoff. Enable/disable AP handoff of clients to other APs Choices:
|
|
Deprecated, please rename it to ap_sniffer_addr. MAC address to monitor. |
|
Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size |
|
Deprecated, please rename it to ap_sniffer_chan. Channel on which to operate the sniffer |
|
Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer. Choices:
|
|
Deprecated, please rename it to ap_sniffer_ctl. Enable/disable sniffer on WiFi control frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_data. Enable/disable sniffer on WiFi data frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable sniffer on WiFi management other frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Deprecated, please rename it to arrp_profile. Distributed Automatic Radio Resource Provisioning |
|
Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_level. Enable/disable automatic power-level adjustment to prevent co-ch… Choices:
|
|
Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_target. The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 2 operates on. Choices:
|
|
Deprecated, please rename it to band_5g_type. WiFi 5G band type. Choices:
|
|
Deprecated, please rename it to bandwidth_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth capacity allowed |
|
Deprecated, please rename it to beacon_interval. Beacon interval. |
|
Deprecated, please rename it to bss_color. BSS color value for this 11ax radio |
|
Deprecated, please rename it to bss_color_mode. BSS color mode for this 11ax radio Choices:
|
|
Deprecated, please rename it to call_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to call_capacity. Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Deprecated, please rename it to channel_bonding. Channel bandwidth Choices:
|
|
Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension Choices:
|
|
Deprecated, please rename it to channel_utilization. Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Deprecated, please rename it to drma_sensitivity. Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Deprecated, please rename it to frag_threshold. Maximum packet size that can be sent without fragmentation |
|
Deprecated, please rename it to frequency_handoff. Enable/disable frequency handoff of clients to other channels Choices:
|
|
Deprecated, please rename it to iperf_protocol. Iperf test protocol Choices:
|
|
Deprecated, please rename it to iperf_server_port. Iperf service port number. |
|
Deprecated, please rename it to max_clients. Maximum number of stations |
|
Deprecated, please rename it to max_distance. Maximum expected distance between the AP and clients |
|
Deprecated, please rename it to mimo_mode. Configure radio MIMO mode Choices:
|
|
Mode of radio 2. Choices:
|
|
Deprecated, please rename it to optional_antenna. Optional antenna used on FAP Choices:
|
|
Deprecated, please rename it to optional_antenna_gain. Optional antenna gain in dBi |
|
Deprecated, please rename it to power_level. Radio power level as a percentage of the maximum transmit power |
|
Deprecated, please rename it to power_mode. Set radio effective isotropic radiated power Choices:
|
|
Deprecated, please rename it to power_value. Radio EIRP power in dBm |
|
Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB… Choices:
|
|
Deprecated, please rename it to protection_mode. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to radio_id. Radio id. |
|
Deprecated, please rename it to rts_threshold. Maximum packet size for RTS transmissions, specifying the maximum s… |
|
Deprecated, please rename it to sam_bssid. BSSID for WiFi network. |
|
Deprecated, please rename it to sam_ca_certificate. CA certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_captive_portal. Enable/disable Captive Portal Authentication Choices:
|
|
Deprecated, please rename it to sam_client_certificate. Client certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_cwp_failure_string. Failure identification on the page after an incorrect login. |
|
Deprecated, please rename it to sam_cwp_match_string. Identification string from the captive portal login form. |
|
(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication. |
|
Deprecated, please rename it to sam_cwp_success_string. Success identification on the page after a successful login. |
|
Deprecated, please rename it to sam_cwp_test_url. Website the client is trying to access. |
|
Deprecated, please rename it to sam_cwp_username. Username for captive portal authentication. |
|
Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE EAP Method Choices:
|
|
(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection. |
|
Deprecated, please rename it to sam_private_key. Private key for WPA2/WPA3-ENTERPRISE. |
|
(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER… |
|
Deprecated, please rename it to sam_report_intv. SAM report interval |
|
Deprecated, please rename it to sam_security_type. Select WiFi network security type Choices:
|
|
Deprecated, please rename it to sam_server. SAM test server IP address or domain name. |
|
Deprecated, please rename it to sam_server_fqdn. SAM test server domain name. |
|
Deprecated, please rename it to sam_server_ip. SAM test server IP address. |
|
Deprecated, please rename it to sam_server_type. Select SAM server type Choices:
|
|
Deprecated, please rename it to sam_ssid. SSID for WiFi network. |
|
Deprecated, please rename it to sam_test. Select SAM test type Choices:
|
|
Deprecated, please rename it to sam_username. Username for WiFi network connection. |
|
Deprecated, please rename it to short_guard_interval. Use either the short guard interval Choices:
|
|
Deprecated, please rename it to spectrum_analysis. Enable/disable spectrum analysis to find interference that woul… Choices:
|
|
Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving… Choices:
|
|
Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Deprecated, please rename it to wids_profile. Wireless Intrusion Detection System |
|
Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio Choices:
|
|
Deprecated, please rename it to radio_3. Radio 3. |
|
Deprecated, please rename it to d80211d. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to d80211mc. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to airtime_fairness. Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Deprecated, please rename it to ap_handoff. Enable/disable AP handoff of clients to other APs Choices:
|
|
Deprecated, please rename it to ap_sniffer_addr. MAC address to monitor. |
|
Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size |
|
Deprecated, please rename it to ap_sniffer_chan. Channel on which to operate the sniffer |
|
Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer. Choices:
|
|
Deprecated, please rename it to ap_sniffer_ctl. Enable/disable sniffer on WiFi control frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_data. Enable/disable sniffer on WiFi data frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable sniffer on WiFi management other frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Deprecated, please rename it to arrp_profile. Distributed Automatic Radio Resource Provisioning |
|
Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_level. Enable/disable automatic power-level adjustment to prevent co-ch… Choices:
|
|
Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_target. The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 3 operates on. Choices:
|
|
Deprecated, please rename it to band_5g_type. WiFi 5G band type. Choices:
|
|
Deprecated, please rename it to bandwidth_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth capacity allowed |
|
Deprecated, please rename it to beacon_interval. Beacon interval. |
|
Deprecated, please rename it to bss_color. BSS color value for this 11ax radio |
|
Deprecated, please rename it to bss_color_mode. BSS color mode for this 11ax radio Choices:
|
|
Deprecated, please rename it to call_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to call_capacity. Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Deprecated, please rename it to channel_bonding. Channel bandwidth Choices:
|
|
Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension Choices:
|
|
Deprecated, please rename it to channel_utilization. Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Deprecated, please rename it to drma_sensitivity. Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Deprecated, please rename it to frag_threshold. Maximum packet size that can be sent without fragmentation |
|
Deprecated, please rename it to frequency_handoff. Enable/disable frequency handoff of clients to other channels Choices:
|
|
Deprecated, please rename it to iperf_protocol. Iperf test protocol Choices:
|
|
Deprecated, please rename it to iperf_server_port. Iperf service port number. |
|
Deprecated, please rename it to max_clients. Maximum number of stations |
|
Deprecated, please rename it to max_distance. Maximum expected distance between the AP and clients |
|
Deprecated, please rename it to mimo_mode. Configure radio MIMO mode Choices:
|
|
Mode of radio 3. Choices:
|
|
Deprecated, please rename it to optional_antenna. Optional antenna used on FAP Choices:
|
|
Deprecated, please rename it to optional_antenna_gain. Optional antenna gain in dBi |
|
Deprecated, please rename it to power_level. Radio power level as a percentage of the maximum transmit power |
|
Deprecated, please rename it to power_mode. Set radio effective isotropic radiated power Choices:
|
|
Deprecated, please rename it to power_value. Radio EIRP power in dBm |
|
Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB… Choices:
|
|
Deprecated, please rename it to protection_mode. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to radio_id. Radio id. |
|
Deprecated, please rename it to rts_threshold. Maximum packet size for RTS transmissions, specifying the maximum s… |
|
Deprecated, please rename it to sam_bssid. BSSID for WiFi network. |
|
Deprecated, please rename it to sam_ca_certificate. CA certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_captive_portal. Enable/disable Captive Portal Authentication Choices:
|
|
Deprecated, please rename it to sam_client_certificate. Client certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_cwp_failure_string. Failure identification on the page after an incorrect login. |
|
Deprecated, please rename it to sam_cwp_match_string. Identification string from the captive portal login form. |
|
(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication. |
|
Deprecated, please rename it to sam_cwp_success_string. Success identification on the page after a successful login. |
|
Deprecated, please rename it to sam_cwp_test_url. Website the client is trying to access. |
|
Deprecated, please rename it to sam_cwp_username. Username for captive portal authentication. |
|
Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE EAP Method Choices:
|
|
(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection. |
|
Deprecated, please rename it to sam_private_key. Private key for WPA2/WPA3-ENTERPRISE. |
|
(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER… |
|
Deprecated, please rename it to sam_report_intv. SAM report interval |
|
Deprecated, please rename it to sam_security_type. Select WiFi network security type Choices:
|
|
Deprecated, please rename it to sam_server. SAM test server IP address or domain name. |
|
Deprecated, please rename it to sam_server_fqdn. SAM test server domain name. |
|
Deprecated, please rename it to sam_server_ip. SAM test server IP address. |
|
Deprecated, please rename it to sam_server_type. Select SAM server type Choices:
|
|
Deprecated, please rename it to sam_ssid. SSID for WiFi network. |
|
Deprecated, please rename it to sam_test. Select SAM test type Choices:
|
|
Deprecated, please rename it to sam_username. Username for WiFi network connection. |
|
Deprecated, please rename it to short_guard_interval. Use either the short guard interval Choices:
|
|
Deprecated, please rename it to spectrum_analysis. Enable/disable spectrum analysis to find interference that woul… Choices:
|
|
Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving… Choices:
|
|
Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Deprecated, please rename it to wids_profile. Wireless Intrusion Detection System |
|
Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio Choices:
|
|
Deprecated, please rename it to radio_4. Radio 4. |
|
Deprecated, please rename it to d80211d. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to d80211mc. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to airtime_fairness. Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Deprecated, please rename it to ap_handoff. Enable/disable AP handoff of clients to other APs Choices:
|
|
Deprecated, please rename it to ap_sniffer_addr. MAC address to monitor. |
|
Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size |
|
Deprecated, please rename it to ap_sniffer_chan. Channel on which to operate the sniffer |
|
Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer. Choices:
|
|
Deprecated, please rename it to ap_sniffer_ctl. Enable/disable sniffer on WiFi control frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_data. Enable/disable sniffer on WiFi data frame Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable sniffer on WiFi management other frames Choices:
|
|
Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Deprecated, please rename it to arrp_profile. Distributed Automatic Radio Resource Provisioning |
|
Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_level. Enable/disable automatic power-level adjustment to prevent co-ch… Choices:
|
|
Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm |
|
Deprecated, please rename it to auto_power_target. The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 3 operates on. Choices:
|
|
Deprecated, please rename it to band_5g_type. WiFi 5G band type. Choices:
|
|
Deprecated, please rename it to bandwidth_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth capacity allowed |
|
Deprecated, please rename it to beacon_interval. Beacon interval. |
|
Deprecated, please rename it to bss_color. BSS color value for this 11ax radio |
|
Deprecated, please rename it to bss_color_mode. BSS color mode for this 11ax radio Choices:
|
|
Deprecated, please rename it to call_admission_control. Enable/disable WiFi multimedia Choices:
|
|
Deprecated, please rename it to call_capacity. Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Deprecated, please rename it to channel_bonding. Channel bandwidth Choices:
|
|
Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension Choices:
|
|
Deprecated, please rename it to channel_utilization. Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Deprecated, please rename it to drma_sensitivity. Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Deprecated, please rename it to frag_threshold. Maximum packet size that can be sent without fragmentation |
|
Deprecated, please rename it to frequency_handoff. Enable/disable frequency handoff of clients to other channels Choices:
|
|
Deprecated, please rename it to iperf_protocol. Iperf test protocol Choices:
|
|
Deprecated, please rename it to iperf_server_port. Iperf service port number. |
|
Deprecated, please rename it to max_clients. Maximum number of stations |
|
Deprecated, please rename it to max_distance. Maximum expected distance between the AP and clients |
|
Deprecated, please rename it to mimo_mode. Configure radio MIMO mode Choices:
|
|
Mode of radio 3. Choices:
|
|
Deprecated, please rename it to optional_antenna. Optional antenna used on FAP Choices:
|
|
Deprecated, please rename it to optional_antenna_gain. Optional antenna gain in dBi |
|
Deprecated, please rename it to power_level. Radio power level as a percentage of the maximum transmit power |
|
Deprecated, please rename it to power_mode. Set radio effective isotropic radiated power Choices:
|
|
Deprecated, please rename it to power_value. Radio EIRP power in dBm |
|
Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB… Choices:
|
|
Deprecated, please rename it to protection_mode. Enable/disable 802. Choices:
|
|
Deprecated, please rename it to radio_id. Radio id. |
|
Deprecated, please rename it to rts_threshold. Maximum packet size for RTS transmissions, specifying the maximum s… |
|
Deprecated, please rename it to sam_bssid. BSSID for WiFi network. |
|
Deprecated, please rename it to sam_ca_certificate. CA certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_captive_portal. Enable/disable Captive Portal Authentication Choices:
|
|
Deprecated, please rename it to sam_client_certificate. Client certificate for WPA2/WPA3-ENTERPRISE. |
|
Deprecated, please rename it to sam_cwp_failure_string. Failure identification on the page after an incorrect login. |
|
Deprecated, please rename it to sam_cwp_match_string. Identification string from the captive portal login form. |
|
(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication. |
|
Deprecated, please rename it to sam_cwp_success_string. Success identification on the page after a successful login. |
|
Deprecated, please rename it to sam_cwp_test_url. Website the client is trying to access. |
|
Deprecated, please rename it to sam_cwp_username. Username for captive portal authentication. |
|
Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE EAP Method Choices:
|
|
(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection. |
|
Deprecated, please rename it to sam_private_key. Private key for WPA2/WPA3-ENTERPRISE. |
|
(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER… |
|
Deprecated, please rename it to sam_report_intv. SAM report interval |
|
Deprecated, please rename it to sam_security_type. Select WiFi network security type Choices:
|
|
Deprecated, please rename it to sam_server. SAM test server IP address or domain name. |
|
Deprecated, please rename it to sam_server_fqdn. SAM test server domain name. |
|
Deprecated, please rename it to sam_server_ip. SAM test server IP address. |
|
Deprecated, please rename it to sam_server_type. Select SAM server type Choices:
|
|
Deprecated, please rename it to sam_ssid. SSID for WiFi network. |
|
Deprecated, please rename it to sam_test. Select SAM test type Choices:
|
|
Deprecated, please rename it to sam_username. Username for WiFi network connection. |
|
Deprecated, please rename it to short_guard_interval. Use either the short guard interval Choices:
|
|
Deprecated, please rename it to spectrum_analysis. Enable/disable spectrum analysis to find interference that woul… Choices:
|
|
Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving… Choices:
|
|
Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP Choices:
|
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
Virtual Access Point |
|
(list or str) Manually selected list of Virtual Access Points |
|
Deprecated, please rename it to wids_profile. Wireless Intrusion Detection System |
|
Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio Choices:
|
|
Enable/disable SNMP for the WTP, FortiAP, or AP Choices:
|
|
Deprecated, please rename it to split_tunneling_acl. Split tunneling acl. |
|
Deprecated, please rename it to dest_ip. Destination IP and mask for the split-tunneling subnet. |
|
ID. |
|
Deprecated, please rename it to split_tunneling_acl_local_ap_subnet. Enable/disable automatically adding local subnetwork … Choices:
|
|
Deprecated, please rename it to split_tunneling_acl_path. Split tunneling ACL path is local/tunnel. Choices:
|
|
Deprecated, please rename it to syslog_profile. System log server configuration profile name. |
|
Deprecated, please rename it to tun_mtu_downlink. Downlink CAPWAP tunnel MTU |
|
Deprecated, please rename it to tun_mtu_uplink. Uplink CAPWAP tunnel MTU |
|
Deprecated, please rename it to unii_4_5ghz_band. Enable/disable UNII-4 5Ghz band channels Choices:
|
|
Deprecated, please rename it to usb_port. Enable/disable USB port of the WTP Choices:
|
|
Deprecated, please rename it to wan_port_auth. Set WAN port authentication mode Choices:
|
|
Deprecated, please rename it to wan_port_auth_macsec. Enable/disable WAN port 802. Choices:
|
|
Deprecated, please rename it to wan_port_auth_methods. WAN port 802. Choices:
|
|
(list) Deprecated, please rename it to wan_port_auth_password. Set WAN port 802. |
|
Deprecated, please rename it to wan_port_auth_usrname. Set WAN port 802. |
|
Deprecated, please rename it to wan_port_mode. Enable/disable using a WAN port as a LAN port. Choices:
|
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
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>
channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
d80211mc: <value in [disable, enable]>
ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
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>
channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
d80211mc: <value in [disable, enable]>
ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
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>
channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
d80211mc: <value in [disable, enable]>
ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
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>
channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
d80211mc: <value in [disable, enable]>
ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>
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]>
usb_port: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |