fortinet.fortimanager.fmgr_wtpprofile_radio1 – Configuration options for radio 1.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.4).
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_radio1.
New in version 2.10: of fortinet.fortimanager
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 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:
|
|
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: 300 |
|
the parameter (wtp-profile) in requested url |
|
the top level parameters set |
|
Enable/disable airtime fairness (default = disable). Choices:
|
|
Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients (default = enable). Choices:
|
|
Enable/disable AP handoff of clients to other APs (default = disable). Choices:
|
|
MAC address to monitor. |
|
Sniffer buffer size (1 - 32 MB, default = 16). |
|
Channel on which to operate the sniffer (default = 6). |
|
Enable/disable sniffer on WiFi control frame (default = enable). Choices:
|
|
Enable/disable sniffer on WiFi data frame (default = enable). Choices:
|
|
Enable/disable sniffer on WiFi management Beacon frames (default = enable). Choices:
|
|
Enable/disable sniffer on WiFi management other frames (default = enable). Choices:
|
|
Enable/disable sniffer on WiFi management probe frames (default = enable). Choices:
|
|
Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type). |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference (default = disable). Choices:
|
|
Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). |
|
The target of automatic transmit power adjustment in dBm. (-95 to -20, default = -70). |
|
WiFi band that Radio 1 operates on. Choices:
|
|
WiFi 5G band type. Choices:
|
|
Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireles… Choices:
|
|
Maximum bandwidth capacity allowed (1 - 600000 Kbps, default = 2000). |
|
Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type, … |
|
BSS color value for this 11ax radio (0 - 63, 0 means disable. default = 0). |
|
Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are … Choices:
|
|
Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60, default = 10). |
|
no description |
|
Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. Choices:
|
|
Enable/disable measuring channel utilization. Choices:
|
|
Enable/disable allowing both HT20 and HT40 on the same radio (default = enable). Choices:
|
|
Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optim… Choices:
|
|
Enable/disable dynamic radio mode assignment (DRMA) (default = disable). Choices:
|
|
Network Coverage Factor (NCF) percentage required to consider a radio as redundant (default = low). Choices:
|
|
DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255, default = 1). … |
|
Maximum packet size that can be sent without fragmentation (800 - 2346 bytes, default = 2346). |
|
Enable/disable frequency handoff of clients to other channels (default = disable). Choices:
|
|
Iperf test protocol (default = “UDP”). Choices:
|
|
Iperf service port number. |
|
Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. |
|
Maximum expected distance between the AP and clients (0 - 54000 m, default = 0). |
|
Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. Choices:
|
|
Radio power level as a percentage of the maximum transmit power (0 - 100, default = 100). |
|
Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP (default = percentage). This… Choices:
|
|
Radio EIRP power in dBm (1 - 33, default = 27). |
|
no description Choices:
|
|
Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). Choices:
|
|
no description |
|
Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes, defa… |
|
BSSID for WiFi network. |
|
Enable/disable Captive Portal Authentication (default = disable). Choices:
|
|
no description |
|
SAM report interval (sec), 0 for a one-time report. |
|
Select WiFi network security type (default = “wpa-personal”). Choices:
|
|
SAM test server IP address or domain name. |
|
SSID for WiFi network. |
|
Select SAM test type (default = “PING”). Choices:
|
|
Username for WiFi network connection. |
|
Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. Choices:
|
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
no description Choices:
|
|
Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) (default = enable). Choices:
|
|
Virtual Access Point (VAP) for wlan ID 1 |
|
Virtual Access Point (VAP) for wlan ID 2 |
|
Virtual Access Point (VAP) for wlan ID 3 |
|
Virtual Access Point (VAP) for wlan ID 4 |
|
Virtual Access Point (VAP) for wlan ID 5 |
|
Virtual Access Point (VAP) for wlan ID 6 |
|
Virtual Access Point (VAP) for wlan ID 7 |
|
Virtual Access Point (VAP) for wlan ID 8 |
|
Manually selected list of Virtual Access Points (VAPs). |
|
Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. |
|
Enable/disable zero wait DFS on radio (default = enable). Choices:
|
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configuration options for radio 1.
fmgr_wtpprofile_radio1:
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_radio1:
amsdu: <value in [disable, enable]>
ap-handoff: <value in [disable, enable]>
ap-sniffer-addr: <value of string>
ap-sniffer-bufsize: <value of integer>
ap-sniffer-chan: <value of 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: <value of integer>
auto-power-level: <value in [disable, enable]>
auto-power-low: <value of integer>
band: <value in [802.11b, 802.11a, 802.11g, ...]>
bandwidth-admission-control: <value in [disable, enable]>
bandwidth-capacity: <value of integer>
beacon-interval: <value of integer>
call-admission-control: <value in [disable, enable]>
call-capacity: <value of integer>
channel: <value of string>
channel-bonding: <value in [disable, enable, 80MHz, ...]>
channel-utilization: <value in [disable, enable]>
coexistence: <value in [disable, enable]>
darrp: <value in [disable, enable]>
dtim: <value of integer>
frag-threshold: <value of integer>
frequency-handoff: <value in [disable, enable]>
max-clients: <value of integer>
max-distance: <value of integer>
mode: <value in [disabled, ap, monitor, ...]>
power-level: <value of integer>
powersave-optimize:
- tim
- ac-vo
- no-obss-scan
- no-11b-rate
- client-rate-follow
protection-mode: <value in [rtscts, ctsonly, disable]>
radio-id: <value of integer>
rts-threshold: <value of 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: <value of string>
wids-profile: <value of string>
airtime-fairness: <value in [disable, enable]>
band-5g-type: <value in [5g-full, 5g-high, 5g-low]>
zero-wait-dfs: <value in [disable, enable]>
vap1: <value of string>
vap2: <value of string>
vap3: <value of string>
vap4: <value of string>
vap5: <value of string>
vap6: <value of string>
vap7: <value of string>
vap8: <value of string>
bss-color: <value of integer>
auto-power-target: <value of string>
drma: <value in [disable, enable]>
drma-sensitivity: <value in [low, medium, high]>
iperf-protocol: <value in [udp, tcp]>
iperf-server-port: <value of integer>
power-mode: <value in [dBm, percentage]>
power-value: <value of integer>
sam-bssid: <value of string>
sam-captive-portal: <value in [disable, enable]>
sam-password: <value of string>
sam-report-intv: <value of integer>
sam-security-type: <value in [open, wpa-personal, wpa-enterprise]>
sam-server: <value of string>
sam-ssid: <value of string>
sam-test: <value in [ping, iperf]>
sam-username: <value of string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)