fortinet.fortimanager.fmgr_wtpprofile_radio2 module – Configuration options for radio 2.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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_radio2.

New in fortinet.fortimanager 2.0.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_radio2

dictionary

The top level parameters set.

80211d

string

Deprecated, please rename it to d80211d. Enable/disable 802.

Choices:

  • "disable"

  • "enable"

airtime-fairness

string

Deprecated, please rename it to airtime_fairness. Enable/disable airtime fairness

Choices:

  • "disable"

  • "enable"

amsdu

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

ap-handoff

string

Deprecated, please rename it to ap_handoff. Enable/disable AP handoff of clients to other APs

Choices:

  • "disable"

  • "enable"

ap-sniffer-addr

string

Deprecated, please rename it to ap_sniffer_addr. MAC address to monitor.

ap-sniffer-bufsize

integer

Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size

ap-sniffer-chan

integer

Deprecated, please rename it to ap_sniffer_chan. Channel on which to operate the sniffer

ap-sniffer-ctl

string

Deprecated, please rename it to ap_sniffer_ctl. Enable/disable sniffer on WiFi control frame

Choices:

  • "disable"

  • "enable"

ap-sniffer-data

string

Deprecated, please rename it to ap_sniffer_data. Enable/disable sniffer on WiFi data frame

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-beacon

string

Deprecated, please rename it to ap_sniffer_mgmt_beacon. Enable/disable sniffer on WiFi management Beacon frames

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-other

string

Deprecated, please rename it to ap_sniffer_mgmt_other. Enable/disable sniffer on WiFi management other frames

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-probe

string

Deprecated, please rename it to ap_sniffer_mgmt_probe. Enable/disable sniffer on WiFi management probe frames

Choices:

  • "disable"

  • "enable"

arrp-profile

string

Deprecated, please rename it to arrp_profile. Distributed Automatic Radio Resource Provisioning

auto-power-high

integer

Deprecated, please rename it to auto_power_high. Automatic transmit power high limit in dBm

auto-power-level

string

Deprecated, please rename it to auto_power_level. Enable/disable automatic power-level adjustment to prevent co-channel in…

Choices:

  • "disable"

  • "enable"

auto-power-low

integer

Deprecated, please rename it to auto_power_low. Automatic transmission power low limit in dBm

auto-power-target

string

Deprecated, please rename it to auto_power_target. The target of automatic transmit power adjustment in dBm.

band

string

WiFi band that Radio 2 operates on.

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"

band-5g-type

string

Deprecated, please rename it to band_5g_type. WiFi 5G band type.

Choices:

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth-admission-control

string

Deprecated, please rename it to bandwidth_admission_control. Enable/disable WiFi multimedia

Choices:

  • "disable"

  • "enable"

bandwidth-capacity

integer

Deprecated, please rename it to bandwidth_capacity. Maximum bandwidth capacity allowed

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Beacon interval.

bss-color

integer

Deprecated, please rename it to bss_color. BSS color value for this 11ax radio

bss-color-mode

string

Deprecated, please rename it to bss_color_mode. BSS color mode for this 11ax radio

Choices:

  • "auto"

  • "static"

call-admission-control

string

Deprecated, please rename it to call_admission_control. Enable/disable WiFi multimedia

Choices:

  • "disable"

  • "enable"

call-capacity

integer

Deprecated, please rename it to call_capacity. Maximum number of Voice over WLAN

channel

any

(list) No description.

channel-bonding

string

Deprecated, please rename it to channel_bonding. Channel bandwidth

Choices:

  • "disable"

  • "enable"

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

channel-utilization

string

Deprecated, please rename it to channel_utilization. Enable/disable measuring channel utilization.

Choices:

  • "disable"

  • "enable"

coexistence

string

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

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

string

Deprecated, please rename it to drma_sensitivity. Network Coverage Factor

Choices:

  • "low"

  • "medium"

  • "high"

dtim

integer

DTIM interval.

frag-threshold

integer

Deprecated, please rename it to frag_threshold. Maximum packet size that can be sent without fragmentation

frequency-handoff

string

Deprecated, please rename it to frequency_handoff. Enable/disable frequency handoff of clients to other channels

Choices:

  • "disable"

  • "enable"

iperf-protocol

string

Deprecated, please rename it to iperf_protocol. Iperf test protocol

Choices:

  • "udp"

  • "tcp"

iperf-server-port

integer

Deprecated, please rename it to iperf_server_port. Iperf service port number.

max-clients

integer

Deprecated, please rename it to max_clients. Maximum number of stations

max-distance

integer

Deprecated, please rename it to max_distance. Maximum expected distance between the AP and clients

mimo-mode

string

Deprecated, please rename it to mimo_mode. Configure radio MIMO mode

Choices:

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

string

Mode of radio 2.

Choices:

  • "disabled"

  • "ap"

  • "monitor"

  • "sniffer"

  • "sam"

optional-antenna

string

Deprecated, please rename it to optional_antenna. 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

string

Deprecated, please rename it to optional_antenna_gain. Optional antenna gain in dBi

power-level

integer

Deprecated, please rename it to power_level. Radio power level as a percentage of the maximum transmit power

power-mode

string

Deprecated, please rename it to power_mode. Set radio effective isotropic radiated power

Choices:

  • "dBm"

  • "percentage"

power-value

integer

Deprecated, please rename it to power_value. Radio EIRP power in dBm

powersave-optimize

list / elements=string

Deprecated, please rename it to powersave_optimize.

Choices:

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection-mode

string

Deprecated, please rename it to protection_mode. Enable/disable 802.

Choices:

  • "rtscts"

  • "ctsonly"

  • "disable"

radio-id

integer

Deprecated, please rename it to radio_id.

rts-threshold

integer

Deprecated, please rename it to rts_threshold. Maximum packet size for RTS transmissions, specifying the maximum size of a…

sam-bssid

string

Deprecated, please rename it to sam_bssid. BSSID for WiFi network.

sam-ca-certificate

string

Deprecated, please rename it to sam_ca_certificate. CA certificate for WPA2/WPA3-ENTERPRISE.

sam-captive-portal

string

Deprecated, please rename it to sam_captive_portal. Enable/disable Captive Portal Authentication

Choices:

  • "disable"

  • "enable"

sam-client-certificate

string

Deprecated, please rename it to sam_client_certificate. Client certificate for WPA2/WPA3-ENTERPRISE.

sam-cwp-failure-string

string

Deprecated, please rename it to sam_cwp_failure_string. Failure identification on the page after an incorrect login.

sam-cwp-match-string

string

Deprecated, please rename it to sam_cwp_match_string. Identification string from the captive portal login form.

sam-cwp-password

any

(list) Deprecated, please rename it to sam_cwp_password.

sam-cwp-success-string

string

Deprecated, please rename it to sam_cwp_success_string. Success identification on the page after a successful login.

sam-cwp-test-url

string

Deprecated, please rename it to sam_cwp_test_url. Website the client is trying to access.

sam-cwp-username

string

Deprecated, please rename it to sam_cwp_username. Username for captive portal authentication.

sam-eap-method

string

Deprecated, please rename it to sam_eap_method. Select WPA2/WPA3-ENTERPRISE EAP Method

Choices:

  • "tls"

  • "peap"

  • "both"

sam-password

any

(list) Deprecated, please rename it to sam_password.

sam-private-key

string

Deprecated, please rename it to sam_private_key. Private key for WPA2/WPA3-ENTERPRISE.

sam-private-key-password

any

(list) Deprecated, please rename it to sam_private_key_password.

sam-report-intv

integer

Deprecated, please rename it to sam_report_intv. SAM report interval

sam-security-type

string

Deprecated, please rename it to sam_security_type. Select WiFi network security type

Choices:

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam-server

string

Deprecated, please rename it to sam_server. SAM test server IP address or domain name.

sam-server-fqdn

string

Deprecated, please rename it to sam_server_fqdn. SAM test server domain name.

sam-server-ip

string

Deprecated, please rename it to sam_server_ip. SAM test server IP address.

sam-server-type

string

Deprecated, please rename it to sam_server_type. Select SAM server type

Choices:

  • "ip"

  • "fqdn"

sam-ssid

string

Deprecated, please rename it to sam_ssid. SSID for WiFi network.

sam-test

string

Deprecated, please rename it to sam_test. Select SAM test type

Choices:

  • "ping"

  • "iperf"

sam-username

string

Deprecated, please rename it to sam_username. Username for WiFi network connection.

short-guard-interval

string

Deprecated, please rename it to short_guard_interval. Use either the short guard interval

Choices:

  • "disable"

  • "enable"

spectrum-analysis

string

Deprecated, please rename it to spectrum_analysis. Enable/disable spectrum analysis to find interference that would negati…

Choices:

  • "disable"

  • "enable"

  • "scan-only"

transmit-optimize

list / elements=string

Deprecated, please rename it to transmit_optimize.

Choices:

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap-all

string

Deprecated, please rename it to vap_all. Enable/disable the automatic inheritance of all Virtual Access Points

Choices:

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

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

vaps

any

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

wids-profile

string

Deprecated, please rename it to wids_profile. Wireless Intrusion Detection System

zero-wait-dfs

string

Deprecated, please rename it to zero_wait_dfs. 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 2.
      fortinet.fortimanager.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: <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 [disable, enable, 80MHz, ...]>
          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>
          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: <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>

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)