fortinet.fortimanager.fmgr_wtpprofile_radio3 module – Configuration options for radio 3.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

wtp-profile

string

Deprecated, please use “wtp_profile”

wtp_profile

string

The parameter (wtp-profile) in requested url.

wtpprofile_radio3

dictionary

The top level parameters set.

airtime_fairness

aliases: airtime-fairness

string

Enable/disable airtime fairness

Choices:

  • "disable"

  • "enable"

amsdu

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

ap_handoff

aliases: ap-handoff

string

Enable/disable AP handoff of clients to other APs

Choices:

  • "disable"

  • "enable"

ap_sniffer_addr

aliases: ap-sniffer-addr

string

MAC address to monitor.

ap_sniffer_bufsize

aliases: ap-sniffer-bufsize

integer

Sniffer buffer size

ap_sniffer_chan

aliases: ap-sniffer-chan

integer

Channel on which to operate the sniffer

ap_sniffer_chan_width

aliases: ap-sniffer-chan-width

string

Channel bandwidth for sniffer.

Choices:

  • "320MHz"

  • "240MHz"

  • "160MHz"

  • "80MHz"

  • "40MHz"

  • "20MHz"

ap_sniffer_ctl

aliases: ap-sniffer-ctl

string

Enable/disable sniffer on WiFi control frame

Choices:

  • "disable"

  • "enable"

ap_sniffer_data

aliases: ap-sniffer-data

string

Enable/disable sniffer on WiFi data frame

Choices:

  • "disable"

  • "enable"

ap_sniffer_mgmt_beacon

aliases: ap-sniffer-mgmt-beacon

string

Enable/disable sniffer on WiFi management Beacon frames

Choices:

  • "disable"

  • "enable"

ap_sniffer_mgmt_other

aliases: ap-sniffer-mgmt-other

string

Enable/disable sniffer on WiFi management other frames

Choices:

  • "disable"

  • "enable"

ap_sniffer_mgmt_probe

aliases: ap-sniffer-mgmt-probe

string

Enable/disable sniffer on WiFi management probe frames

Choices:

  • "disable"

  • "enable"

arrp_profile

aliases: arrp-profile

string

Distributed Automatic Radio Resource Provisioning

auto_power_high

aliases: auto-power-high

integer

The upper bound of automatic transmit power adjustment in dBm

auto_power_level

aliases: auto-power-level

string

Enable/disable automatic power-level adjustment to prevent co-channel interference

Choices:

  • "disable"

  • "enable"

auto_power_low

aliases: auto-power-low

integer

The lower bound of automatic transmit power adjustment in dBm

auto_power_target

aliases: auto-power-target

string

The target of automatic transmit power adjustment in dBm.

band

string

WiFi band that Radio 3 operates on.

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"

  • "802.11n-2G"

  • "802.11ac-5G"

  • "802.11ax-2G"

  • "802.11be-2G"

  • "802.11be-5G"

  • "802.11be-6G"

band_5g_type

aliases: band-5g-type

string

WiFi 5G band type.

Choices:

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth_admission_control

aliases: bandwidth-admission-control

string

Enable/disable WiFi multimedia

Choices:

  • "disable"

  • "enable"

bandwidth_capacity

aliases: bandwidth-capacity

integer

Maximum bandwidth capacity allowed

beacon_interval

aliases: beacon-interval

integer

Beacon interval.

bss_color

aliases: bss-color

integer

BSS color value for this 11ax radio

bss_color_mode

aliases: bss-color-mode

string

BSS color mode for this 11ax radio

Choices:

  • "auto"

  • "static"

call_admission_control

aliases: call-admission-control

string

Enable/disable WiFi multimedia

Choices:

  • "disable"

  • "enable"

call_capacity

aliases: call-capacity

integer

Maximum number of Voice over WLAN

channel

any

(list) Selected list of wireless radio channels.

channel_bonding

aliases: channel-bonding

string

Channel bandwidth

Choices:

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

  • "320MHz"

  • "240MHz"

channel_bonding_ext

aliases: channel-bonding-ext

string

Channel bandwidth extension

Choices:

  • "320MHz-1"

  • "320MHz-2"

channel_utilization

aliases: channel-utilization

string

Enable/disable measuring channel utilization.

Choices:

  • "disable"

  • "enable"

coexistence

string

Enable/disable allowing both HT20 and HT40 on the same radio

Choices:

  • "disable"

  • "enable"

d80211d

aliases: 80211d

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

d80211mc

aliases: 80211mc

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning

Choices:

  • "disable"

  • "enable"

drma

string

Enable/disable dynamic radio mode assignment

Choices:

  • "disable"

  • "enable"

drma_sensitivity

aliases: drma-sensitivity

string

Network Coverage Factor

Choices:

  • "low"

  • "medium"

  • "high"

dtim

integer

Delivery Traffic Indication Map

frag_threshold

aliases: frag-threshold

integer

Maximum packet size that can be sent without fragmentation

frequency_handoff

aliases: frequency-handoff

string

Enable/disable frequency handoff of clients to other channels

Choices:

  • "disable"

  • "enable"

iperf_protocol

aliases: iperf-protocol

string

Iperf test protocol

Choices:

  • "udp"

  • "tcp"

iperf_server_port

aliases: iperf-server-port

integer

Iperf service port number.

max_clients

aliases: max-clients

integer

Maximum number of stations

max_distance

aliases: max-distance

integer

Maximum expected distance between the AP and clients

mimo_mode

aliases: mimo-mode

string

Configure radio MIMO mode

Choices:

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

string

Mode of radio 3.

Choices:

  • "disabled"

  • "ap"

  • "monitor"

  • "sniffer"

  • "sam"

optional_antenna

aliases: optional-antenna

string

Optional antenna used on FAP

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"

optional_antenna_gain

aliases: optional-antenna-gain

string

Optional antenna gain in dBi

power_level

aliases: power-level

integer

Radio power level as a percentage of the maximum transmit power

power_mode

aliases: power-mode

string

Set radio effective isotropic radiated power

Choices:

  • "dBm"

  • "percentage"

power_value

aliases: power-value

integer

Radio EIRP power in dBm

powersave_optimize

aliases: powersave-optimize

list / elements=string

Enable client power-saving features such as TIM, AC VO, and OBSS etc.

Choices:

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection_mode

aliases: protection-mode

string

Enable/disable 802.

Choices:

  • "rtscts"

  • "ctsonly"

  • "disable"

radio_id

aliases: radio-id

integer

Radio id.

rts_threshold

aliases: rts-threshold

integer

Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS

sam_bssid

aliases: sam-bssid

string

BSSID for WiFi network.

sam_ca_certificate

aliases: sam-ca-certificate

string

CA certificate for WPA2/WPA3-ENTERPRISE.

sam_captive_portal

aliases: sam-captive-portal

string

Enable/disable Captive Portal Authentication

Choices:

  • "disable"

  • "enable"

sam_client_certificate

aliases: sam-client-certificate

string

Client certificate for WPA2/WPA3-ENTERPRISE.

sam_cwp_failure_string

aliases: sam-cwp-failure-string

string

Failure identification on the page after an incorrect login.

sam_cwp_match_string

aliases: sam-cwp-match-string

string

Identification string from the captive portal login form.

sam_cwp_password

aliases: sam-cwp-password

any

(list) Password for captive portal authentication.

sam_cwp_success_string

aliases: sam-cwp-success-string

string

Success identification on the page after a successful login.

sam_cwp_test_url

aliases: sam-cwp-test-url

string

Website the client is trying to access.

sam_cwp_username

aliases: sam-cwp-username

string

Username for captive portal authentication.

sam_eap_method

aliases: sam-eap-method

string

Select WPA2/WPA3-ENTERPRISE EAP Method

Choices:

  • "tls"

  • "peap"

  • "both"

sam_password

aliases: sam-password

any

(list) Passphrase for WiFi network connection.

sam_private_key

aliases: sam-private-key

string

Private key for WPA2/WPA3-ENTERPRISE.

sam_private_key_password

aliases: sam-private-key-password

any

(list) Password for private key file for WPA2/WPA3-ENTERPRISE.

sam_report_intv

aliases: sam-report-intv

integer

SAM report interval

sam_security_type

aliases: sam-security-type

string

Select WiFi network security type

Choices:

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam_server

aliases: sam-server

string

SAM test server IP address or domain name.

sam_server_fqdn

aliases: sam-server-fqdn

string

SAM test server domain name.

sam_server_ip

aliases: sam-server-ip

string

SAM test server IP address.

sam_server_type

aliases: sam-server-type

string

Select SAM server type

Choices:

  • "ip"

  • "fqdn"

sam_ssid

aliases: sam-ssid

string

SSID for WiFi network.

sam_test

aliases: sam-test

string

Select SAM test type

Choices:

  • "ping"

  • "iperf"

sam_username

aliases: sam-username

string

Username for WiFi network connection.

short_guard_interval

aliases: short-guard-interval

string

Use either the short guard interval

Choices:

  • "disable"

  • "enable"

spectrum_analysis

aliases: spectrum-analysis

string

Enable/disable spectrum analysis to find interference that would negatively impact wireless performance.

Choices:

  • "disable"

  • "enable"

  • "scan-only"

transmit_optimize

aliases: transmit-optimize

list / elements=string

Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc.

Choices:

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap1

string

Virtual Access Point

vap2

string

Virtual Access Point

vap3

string

Virtual Access Point

vap4

string

Virtual Access Point

vap5

string

Virtual Access Point

vap6

string

Virtual Access Point

vap7

string

Virtual Access Point

vap8

string

Virtual Access Point

vap_all

aliases: vap-all

string

Enable/disable the automatic inheritance of all Virtual Access Points

Choices:

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

vaps

any

(list or str) Manually selected list of Virtual Access Points

wids_profile

aliases: wids-profile

string

Wireless Intrusion Detection System

zero_wait_dfs

aliases: zero-wait-dfs

string

Enable/disable zero wait DFS on radio

Choices:

  • "disable"

  • "enable"

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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)