drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_wtpprofile_radio2 Configuration options for radio 2. | "added in version" 2.0.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_wtpprofile_radio2 (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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 2. fmgr_wtpprofile_radio2: 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_radio2: 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> arrp-profile: <value of string> bss-color-mode: <value in [auto, static]> sam-cwp-failure-string: <value of string> sam-cwp-match-string: <value of string> sam-cwp-password: <value of string> sam-cwp-success-string: <value of string> sam-cwp-test-url: <value of string> sam-cwp-username: <value of string> sam-server-fqdn: <value of string> sam-server-ip: <value of string> sam-server-type: <value in [ip, fqdn]> 80211d: <value in [disable, enable]> optional-antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
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 required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool wtp-profile: description: the parameter (wtp-profile) in requested url required: true type: str access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false 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. required: false type: bool wtpprofile_radio2: description: the top level parameters set required: false suboptions: 80211d: choices: - disable - enable description: Enable/disable 802. type: str airtime-fairness: choices: - disable - enable description: Enable/disable airtime fairness type: str amsdu: choices: - disable - enable description: Enable/disable 802. type: str ap-handoff: choices: - disable - enable description: Enable/disable AP handoff of clients to other APs type: str ap-sniffer-addr: description: MAC address to monitor. type: str ap-sniffer-bufsize: description: Sniffer buffer size type: int ap-sniffer-chan: description: Channel on which to operate the sniffer type: int ap-sniffer-ctl: choices: - disable - enable description: Enable/disable sniffer on WiFi control frame type: str ap-sniffer-data: choices: - disable - enable description: Enable/disable sniffer on WiFi data frame type: str ap-sniffer-mgmt-beacon: choices: - disable - enable description: Enable/disable sniffer on WiFi management Beacon frames type: str ap-sniffer-mgmt-other: choices: - disable - enable description: Enable/disable sniffer on WiFi management other frames type: str ap-sniffer-mgmt-probe: choices: - disable - enable description: Enable/disable sniffer on WiFi management probe frames type: str arrp-profile: description: Distributed Automatic Radio Resource Provisioning type: str auto-power-high: description: Automatic transmit power high limit in dBm type: int auto-power-level: choices: - disable - enable description: Enable/disable automatic power-level adjustment to prevent co-channel interference type: str auto-power-low: description: Automatic transmission power low limit in dBm type: int auto-power-target: description: 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.11g-only - 802.11n-only - 802.11n,g-only - 802.11ac-only - 802.11ac,n-only - 802.11n-5G-only - 802.11ax-5G - 802.11ax - 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 2 operates on. type: str band-5g-type: choices: - 5g-full - 5g-high - 5g-low description: WiFi 5G band type. type: str bandwidth-admission-control: choices: - disable - enable description: Enable/disable WiFi multimedia type: str bandwidth-capacity: description: Maximum bandwidth capacity allowed type: int beacon-interval: description: Beacon interval. type: int bss-color: description: BSS color value for this 11ax radio type: int bss-color-mode: choices: - auto - static description: BSS color mode for this 11ax radio type: str call-admission-control: choices: - disable - enable description: Enable/disable WiFi multimedia type: str call-capacity: description: Maximum number of Voice over WLAN type: int channel: description: description type: str channel-bonding: choices: - disable - enable - 80MHz - 40MHz - 20MHz - 160MHz description: Channel bandwidth type: str channel-utilization: choices: - disable - enable description: 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: Network Coverage Factor type: str dtim: description: DTIM interval. type: int frag-threshold: description: Maximum packet size that can be sent without fragmentation type: int frequency-handoff: choices: - disable - enable description: Enable/disable frequency handoff of clients to other channels type: str iperf-protocol: choices: - udp - tcp description: Iperf test protocol type: str iperf-server-port: description: Iperf service port number. type: int max-clients: description: Maximum number of stations type: int max-distance: description: Maximum expected distance between the AP and clients type: int mode: choices: - disabled - ap - monitor - sniffer - sam description: Mode of radio 2. 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 description: Optional antenna used on FAP type: str power-level: description: Radio power level as a percentage of the maximum transmit power type: int power-mode: choices: - dBm - percentage description: Set radio effective isotropic radiated power type: str power-value: description: Radio EIRP power in dBm type: int powersave-optimize: choices: - tim - ac-vo - no-obss-scan - no-11b-rate - client-rate-follow description: description elements: str type: list protection-mode: choices: - rtscts - ctsonly - disable description: Enable/disable 802. type: str radio-id: description: no description type: int rts-threshold: description: Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS type: int sam-bssid: description: BSSID for WiFi network. type: str sam-captive-portal: choices: - disable - enable description: Enable/disable Captive Portal Authentication type: str sam-cwp-failure-string: description: Failure identification on the page after an incorrect login. type: str sam-cwp-match-string: description: Identification string from the captive portal login form. type: str sam-cwp-password: description: description type: str sam-cwp-success-string: description: Success identification on the page after a successful login. type: str sam-cwp-test-url: description: Website the client is trying to access. type: str sam-cwp-username: description: Username for captive portal authentication. type: str sam-password: description: description type: str sam-report-intv: description: SAM report interval type: int sam-security-type: choices: - open - wpa-personal - wpa-enterprise description: Select WiFi network security type type: str sam-server: description: SAM test server IP address or domain name. type: str sam-server-fqdn: description: SAM test server domain name. type: str sam-server-ip: description: SAM test server IP address. type: str sam-server-type: choices: - ip - fqdn description: Select SAM server type type: str sam-ssid: description: SSID for WiFi network. type: str sam-test: choices: - ping - iperf description: Select SAM test type type: str sam-username: description: Username for WiFi network connection. type: str short-guard-interval: choices: - disable - enable description: Use either the short guard interval type: str spectrum-analysis: choices: - disable - enable - scan-only description: Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str transmit-optimize: choices: - disable - power-save - aggr-limit - retry-limit - send-bar description: description elements: str type: list vap-all: choices: - disable - enable - tunnel - bridge - manual description: 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: Manually selected list of Virtual Access Points type: str wids-profile: description: Wireless Intrusion Detection System type: str zero-wait-dfs: choices: - disable - enable description: 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. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false 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