fortinet.fortimanager.fmgr_wtpprofile_radio3 module – Configuration options for radio 3.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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. |
|
Enable/disable airtime fairness Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable AP handoff of clients to other APs Choices:
|
|
MAC address to monitor. |
|
Sniffer buffer size |
|
Channel on which to operate the sniffer |
|
Channel bandwidth for sniffer. Choices:
|
|
Enable/disable sniffer on WiFi control frame Choices:
|
|
Enable/disable sniffer on WiFi data frame Choices:
|
|
Enable/disable sniffer on WiFi management Beacon frames Choices:
|
|
Enable/disable sniffer on WiFi management other frames Choices:
|
|
Enable/disable sniffer on WiFi management probe frames Choices:
|
|
Distributed Automatic Radio Resource Provisioning |
|
The upper bound of automatic transmit power adjustment in dBm |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm |
|
The target of automatic transmit power adjustment in dBm. |
|
WiFi band that Radio 3 operates on. Choices:
|
|
WiFi 5G band type. Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum bandwidth capacity allowed |
|
Beacon interval. |
|
BSS color value for this 11ax radio |
|
BSS color mode for this 11ax radio Choices:
|
|
Enable/disable WiFi multimedia Choices:
|
|
Maximum number of Voice over WLAN |
|
(list) Selected list of wireless radio channels. |
|
Channel bandwidth Choices:
|
|
Channel bandwidth extension Choices:
|
|
Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable 802. Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning Choices:
|
|
Enable/disable dynamic radio mode assignment Choices:
|
|
Network Coverage Factor Choices:
|
|
Delivery Traffic Indication Map |
|
Maximum packet size that can be sent without fragmentation |
|
Enable/disable frequency handoff of clients to other channels Choices:
|
|
Iperf test protocol Choices:
|
|
Iperf service port number. |
|
Maximum number of stations |
|
Maximum expected distance between the AP and clients |
|
Configure radio MIMO mode Choices:
|
|
Mode of radio 3. Choices:
|
|
Optional antenna used on FAP Choices:
|
|
Optional antenna gain in dBi |
|
Radio power level as a percentage of the maximum transmit power |
|
Set radio effective isotropic radiated power Choices:
|
|
Radio EIRP power in dBm |
|
Enable client power-saving features such as TIM, AC VO, and OBSS etc. Choices:
|
|
Enable/disable 802. Choices:
|
|
Radio id. |
|
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS |
|
BSSID for WiFi network. |
|
CA certificate for WPA2/WPA3-ENTERPRISE. |
|
Enable/disable Captive Portal Authentication Choices:
|
|
Client certificate for WPA2/WPA3-ENTERPRISE. |
|
Failure identification on the page after an incorrect login. |
|
Identification string from the captive portal login form. |
|
(list) Password for captive portal authentication. |
|
Success identification on the page after a successful login. |
|
Website the client is trying to access. |
|
Username for captive portal authentication. |
|
Select WPA2/WPA3-ENTERPRISE EAP Method Choices:
|
|
(list) Passphrase for WiFi network connection. |
|
Private key for WPA2/WPA3-ENTERPRISE. |
|
(list) Password for private key file for WPA2/WPA3-ENTERPRISE. |
|
SAM report interval |
|
Select WiFi network security type Choices:
|
|
SAM test server IP address or domain name. |
|
SAM test server domain name. |
|
SAM test server IP address. |
|
Select SAM server type Choices:
|
|
SSID for WiFi network. |
|
Select SAM test type Choices:
|
|
Username for WiFi network connection. |
|
Use either the short guard interval Choices:
|
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. 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 |
|
Enable/disable the automatic inheritance of all Virtual Access Points Choices:
|
|
(list or str) Manually selected list of Virtual Access Points |
|
Wireless Intrusion Detection System |
|
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 |