Try SpotterConfiguration options for radio 3.
| "added in version" 2.1.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
wtp-profile:
description: Deprecated, please use "wtp_profile"
type: str
wtp_profile:
description: The parameter (wtp-profile) in requested url.
type: str
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
wtpprofile_radio3:
description: The top level parameters set.
required: false
suboptions:
80211d:
choices:
- disable
- enable
description: Deprecated, please rename it to d80211d. Enable/disable 802.
type: str
airtime-fairness:
choices:
- disable
- enable
description: Deprecated, please rename it to airtime_fairness. Enable/disable
airtime fairness
type: str
amsdu:
choices:
- disable
- enable
description: Enable/disable 802.
type: str
ap-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_handoff. Enable/disable AP handoff
of clients to other APs
type: str
ap-sniffer-addr:
description: Deprecated, please rename it to ap_sniffer_addr. MAC address to monitor.
type: str
ap-sniffer-bufsize:
description: Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer
size
type: int
ap-sniffer-chan:
description: Deprecated, please rename it to ap_sniffer_chan. Channel on which
to operate the sniffer
type: int
ap-sniffer-ctl:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_ctl. Enable/disable sniffer
on WiFi control frame
type: str
ap-sniffer-data:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_data. Enable/disable sniffer
on WiFi data frame
type: str
ap-sniffer-mgmt-beacon:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable
sniffer on WiFi management Beacon frames
type: str
ap-sniffer-mgmt-other:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable
sniffer on WiFi management other frames
type: str
ap-sniffer-mgmt-probe:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable
sniffer on WiFi management probe frames
type: str
arrp-profile:
description: Deprecated, please rename it to arrp_profile. Distributed Automatic
Radio Resource Provisioning
type: str
auto-power-high:
description: Deprecated, please rename it to auto_power_high. The upper bound
of automatic transmit power adjustment in dBm
type: int
auto-power-level:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_power_level. Enable/disable
automatic power-level adjustment to prevent co-channel in...
type: str
auto-power-low:
description: Deprecated, please rename it to auto_power_low. The lower bound of
automatic transmit power adjustment in dBm
type: int
auto-power-target:
description: Deprecated, please rename it to auto_power_target. The target of
automatic transmit power adjustment in dBm.
type: str
band:
choices:
- 802.11b
- 802.11a
- 802.11g
- 802.11n
- 802.11ac
- 802.11n-5G
- 802.11ax-5G
- 802.11ax
- 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.11ac-2G
- 802.11ax-6G
description: WiFi band that Radio 3 operates on.
type: str
band-5g-type:
choices:
- 5g-full
- 5g-high
- 5g-low
description: Deprecated, please rename it to band_5g_type. WiFi 5G band type.
type: str
bandwidth-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to bandwidth_admission_control. Enable/disable
WiFi multimedia
type: str
bandwidth-capacity:
description: Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth
capacity allowed
type: int
beacon-interval:
description: Deprecated, please rename it to beacon_interval. Beacon interval.
type: int
bss-color:
description: Deprecated, please rename it to bss_color. BSS color value for this
11ax radio
type: int
bss-color-mode:
choices:
- auto
- static
description: Deprecated, please rename it to bss_color_mode. BSS color mode for
this 11ax radio
type: str
call-admission-control:
choices:
- disable
- enable
description: Deprecated, please rename it to call_admission_control. Enable/disable
WiFi multimedia
type: str
call-capacity:
description: Deprecated, please rename it to call_capacity. Maximum number of
Voice over WLAN
type: int
channel:
description: (list) No description.
type: raw
channel-bonding:
choices:
- 80MHz
- 40MHz
- 20MHz
- 160MHz
description: Deprecated, please rename it to channel_bonding. Channel bandwidth
type: str
channel-utilization:
choices:
- disable
- enable
description: Deprecated, please rename it to channel_utilization. Enable/disable
measuring channel utilization.
type: str
coexistence:
choices:
- disable
- enable
description: Enable/disable allowing both HT20 and HT40 on the same radio
type: str
darrp:
choices:
- disable
- enable
description: Enable/disable Distributed Automatic Radio Resource Provisioning
type: str
drma:
choices:
- disable
- enable
description: Enable/disable dynamic radio mode assignment
type: str
drma-sensitivity:
choices:
- low
- medium
- high
description: Deprecated, please rename it to drma_sensitivity. Network Coverage
Factor
type: str
dtim:
description: Delivery Traffic Indication Map
type: int
frag-threshold:
description: Deprecated, please rename it to frag_threshold. Maximum packet size
that can be sent without fragmentation
type: int
frequency-handoff:
choices:
- disable
- enable
description: Deprecated, please rename it to frequency_handoff. Enable/disable
frequency handoff of clients to other channels
type: str
iperf-protocol:
choices:
- udp
- tcp
description: Deprecated, please rename it to iperf_protocol. Iperf test protocol
type: str
iperf-server-port:
description: Deprecated, please rename it to iperf_server_port. Iperf service
port number.
type: int
max-clients:
description: Deprecated, please rename it to max_clients. Maximum number of stations
type: int
max-distance:
description: Deprecated, please rename it to max_distance. Maximum expected distance
between the AP and clients
type: int
mimo-mode:
choices:
- default
- 1x1
- 2x2
- 3x3
- 4x4
- 8x8
description: Deprecated, please rename it to mimo_mode. Configure radio MIMO mode
type: str
mode:
choices:
- disabled
- ap
- monitor
- sniffer
- sam
description: Mode of radio 3.
type: str
optional-antenna:
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
description: Deprecated, please rename it to optional_antenna. Optional antenna
used on FAP
type: str
optional-antenna-gain:
description: Deprecated, please rename it to optional_antenna_gain. Optional antenna
gain in dBi
type: str
power-level:
description: Deprecated, please rename it to power_level. Radio power level as
a percentage of the maximum transmit power
type: int
power-mode:
choices:
- dBm
- percentage
description: Deprecated, please rename it to power_mode. Set radio effective isotropic
radiated power
type: str
power-value:
description: Deprecated, please rename it to power_value. Radio EIRP power in
dBm
type: int
powersave-optimize:
choices:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
description: Deprecated, please rename it to powersave_optimize.
elements: str
type: list
protection-mode:
choices:
- rtscts
- ctsonly
- disable
description: Deprecated, please rename it to protection_mode. Enable/disable 802.
type: str
radio-id:
description: Deprecated, please rename it to radio_id.
type: int
rts-threshold:
description: Deprecated, please rename it to rts_threshold. Maximum packet size
for RTS transmissions, specifying the maximum size of a...
type: int
sam-bssid:
description: Deprecated, please rename it to sam_bssid. BSSID for WiFi network.
type: str
sam-ca-certificate:
description: Deprecated, please rename it to sam_ca_certificate. CA certificate
for WPA2/WPA3-ENTERPRISE.
type: str
sam-captive-portal:
choices:
- disable
- enable
description: Deprecated, please rename it to sam_captive_portal. Enable/disable
Captive Portal Authentication
type: str
sam-client-certificate:
description: Deprecated, please rename it to sam_client_certificate. Client certificate
for WPA2/WPA3-ENTERPRISE.
type: str
sam-cwp-failure-string:
description: Deprecated, please rename it to sam_cwp_failure_string. Failure identification
on the page after an incorrect login.
type: str
sam-cwp-match-string:
description: Deprecated, please rename it to sam_cwp_match_string. Identification
string from the captive portal login form.
type: str
sam-cwp-password:
description: (list) Deprecated, please rename it to sam_cwp_password.
type: raw
sam-cwp-success-string:
description: Deprecated, please rename it to sam_cwp_success_string. Success identification
on the page after a successful login.
type: str
sam-cwp-test-url:
description: Deprecated, please rename it to sam_cwp_test_url. Website the client
is trying to access.
type: str
sam-cwp-username:
description: Deprecated, please rename it to sam_cwp_username. Username for captive
portal authentication.
type: str
sam-eap-method:
choices:
- tls
- peap
- both
description: Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE
EAP Method
type: str
sam-password:
description: (list) Deprecated, please rename it to sam_password.
type: raw
sam-private-key:
description: Deprecated, please rename it to sam_private_key. Private key for
WPA2/WPA3-ENTERPRISE.
type: str
sam-private-key-password:
description: (list) Deprecated, please rename it to sam_private_key_password.
type: raw
sam-report-intv:
description: Deprecated, please rename it to sam_report_intv. SAM report interval
type: int
sam-security-type:
choices:
- open
- wpa-personal
- wpa-enterprise
- owe
- wpa3-sae
description: Deprecated, please rename it to sam_security_type. Select WiFi network
security type
type: str
sam-server:
description: Deprecated, please rename it to sam_server. SAM test server IP address
or domain name.
type: str
sam-server-fqdn:
description: Deprecated, please rename it to sam_server_fqdn. SAM test server
domain name.
type: str
sam-server-ip:
description: Deprecated, please rename it to sam_server_ip. SAM test server IP
address.
type: str
sam-server-type:
choices:
- ip
- fqdn
description: Deprecated, please rename it to sam_server_type. Select SAM server
type
type: str
sam-ssid:
description: Deprecated, please rename it to sam_ssid. SSID for WiFi network.
type: str
sam-test:
choices:
- ping
- iperf
description: Deprecated, please rename it to sam_test. Select SAM test type
type: str
sam-username:
description: Deprecated, please rename it to sam_username. Username for WiFi network
connection.
type: str
short-guard-interval:
choices:
- disable
- enable
description: Deprecated, please rename it to short_guard_interval. Use either
the short guard interval
type: str
spectrum-analysis:
choices:
- disable
- enable
- scan-only
description: Deprecated, please rename it to spectrum_analysis. Enable/disable
spectrum analysis to find interference that would negati...
type: str
transmit-optimize:
choices:
- disable
- power-save
- aggr-limit
- retry-limit
- send-bar
description: Deprecated, please rename it to transmit_optimize.
elements: str
type: list
vap-all:
choices:
- disable
- enable
- tunnel
- bridge
- manual
description: Deprecated, please rename it to vap_all. Enable/disable the automatic
inheritance of all Virtual Access Points
type: str
vap1:
description: Virtual Access Point
type: str
vap2:
description: Virtual Access Point
type: str
vap3:
description: Virtual Access Point
type: str
vap4:
description: Virtual Access Point
type: str
vap5:
description: Virtual Access Point
type: str
vap6:
description: Virtual Access Point
type: str
vap7:
description: Virtual Access Point
type: str
vap8:
description: Virtual Access Point
type: str
vaps:
description: (list or str) Manually selected list of Virtual Access Points
type: raw
wids-profile:
description: Deprecated, please rename it to wids_profile. Wireless Intrusion
Detection System
type: str
zero-wait-dfs:
choices:
- disable
- enable
description: Deprecated, please rename it to zero_wait_dfs. Enable/disable zero
wait DFS on radio
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list