fortinet.fortimanager.fmgr_wtpprofile_radio3 module – Configuration options for radio 3.
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_radio3.
New in fortinet.fortimanager 2.1.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 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: |
|
Deprecated, please use “wtp_profile” |
|
The parameter (wtp-profile) in requested url. |
|
The top level parameters set. |
|
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-channel in… 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 OBSS etc. 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 size of a… |
|
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-ENTERPRISE. |
|
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 would negati… Choices:
|
|
Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving, aggreg… Choices:
|
|
Deprecated, please rename it to vap_all. Enable/disable the automatic inheritance of all Virtual Access Points 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:
|
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.
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: Configuration options for radio 3.
fortinet.fortimanager.fmgr_wtpprofile_radio3:
# 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>
wtp_profile: <your own value>
wtpprofile_radio3:
airtime_fairness: <value in [disable, enable]>
amsdu: <value in [disable, enable]>
ap_handoff: <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>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
bandwidth_admission_control: <value in [disable, enable]>
bandwidth_capacity: <integer>
beacon_interval: <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]>
dtim: <integer>
frag_threshold: <integer>
frequency_handoff: <value in [disable, enable]>
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, ...]>
vaps: <list or string>
wids_profile: <string>
band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
zero_wait_dfs: <value in [disable, enable]>
vap1: <string>
vap2: <string>
vap3: <string>
vap4: <string>
vap5: <string>
vap6: <string>
vap7: <string>
vap8: <string>
bss_color: <integer>
auto_power_target: <string>
drma: <value in [disable, enable]>
drma_sensitivity: <value in [low, medium, high]>
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, ...]>
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 |