fortinet.fortimanager.fmgr_wtpprofile module – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.

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.

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.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

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

wtpprofile

dictionary

The top level parameters set.

_is_factory_setting

string

Is factory setting.

Choices:

  • "disable"

  • "enable"

  • "ext"

allowaccess

list / elements=string

Control management access to the managed WTP, FortiAP, or AP.

Choices:

  • "https"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

ap_country

aliases: ap-country

string

Country in which this WTP, FortiAP or AP will operate

Choices:

  • "AL"

  • "DZ"

  • "AR"

  • "AM"

  • "AU"

  • "AT"

  • "AZ"

  • "BH"

  • "BD"

  • "BY"

  • "BE"

  • "BZ"

  • "BO"

  • "BA"

  • "BR"

  • "BN"

  • "BG"

  • "CA"

  • "CL"

  • "CN"

  • "CO"

  • "CR"

  • "HR"

  • "CY"

  • "CZ"

  • "DK"

  • "DO"

  • "EC"

  • "EG"

  • "SV"

  • "EE"

  • "FI"

  • "FR"

  • "GE"

  • "DE"

  • "GR"

  • "GT"

  • "HN"

  • "HK"

  • "HU"

  • "IS"

  • "IN"

  • "ID"

  • "IR"

  • "IE"

  • "IL"

  • "IT"

  • "JM"

  • "JP"

  • "JO"

  • "KZ"

  • "KE"

  • "KP"

  • "KR"

  • "KW"

  • "LV"

  • "LB"

  • "LI"

  • "LT"

  • "LU"

  • "MO"

  • "MK"

  • "MY"

  • "MT"

  • "MX"

  • "MC"

  • "MA"

  • "NP"

  • "NL"

  • "AN"

  • "NZ"

  • "NO"

  • "OM"

  • "PK"

  • "PA"

  • "PG"

  • "PE"

  • "PH"

  • "PL"

  • "PT"

  • "PR"

  • "QA"

  • "RO"

  • "RU"

  • "SA"

  • "SG"

  • "SK"

  • "SI"

  • "ZA"

  • "ES"

  • "LK"

  • "SE"

  • "CH"

  • "SY"

  • "TW"

  • "TH"

  • "TT"

  • "TN"

  • "TR"

  • "AE"

  • "UA"

  • "GB"

  • "US"

  • "PS"

  • "UY"

  • "UZ"

  • "VE"

  • "VN"

  • "YE"

  • "ZW"

  • "NA"

  • "KH"

  • "TZ"

  • "SD"

  • "AO"

  • "RW"

  • "MZ"

  • "RS"

  • "ME"

  • "BB"

  • "GD"

  • "GL"

  • "GU"

  • "PY"

  • "HT"

  • "AW"

  • "MM"

  • "ZB"

  • "CF"

  • "BS"

  • "VC"

  • "MV"

  • "SN"

  • "CI"

  • "GH"

  • "MW"

  • "UG"

  • "BF"

  • "KY"

  • "TC"

  • "TM"

  • "VU"

  • "FM"

  • "GY"

  • "KN"

  • "LC"

  • "CX"

  • "AF"

  • "CM"

  • "ML"

  • "BJ"

  • "MG"

  • "TD"

  • "BW"

  • "LY"

  • "LS"

  • "MU"

  • "SL"

  • "NE"

  • "TG"

  • "RE"

  • "MD"

  • "BM"

  • "VI"

  • "PM"

  • "MF"

  • "IM"

  • "FO"

  • "GI"

  • "LA"

  • "WF"

  • "MH"

  • "BT"

  • "PF"

  • "NI"

  • "GF"

  • "AS"

  • "MP"

  • "PW"

  • "GP"

  • "ET"

  • "SR"

  • "DM"

  • "MQ"

  • "YT"

  • "BL"

  • "ZM"

  • "CG"

  • "CD"

  • "MR"

  • "IQ"

  • "FJ"

  • "--"

  • "MN"

  • "NG"

  • "GA"

  • "GM"

  • "SO"

  • "SZ"

  • "LR"

  • "DJ"

ap_handoff

aliases: ap-handoff

string

Enable/disable AP handoff of clients to other APs

Choices:

  • "disable"

  • "enable"

apcfg_profile

aliases: apcfg-profile

string

AP local configuration profile name.

ble_profile

aliases: ble-profile

string

Bluetooth Low Energy profile name.

bonjour_profile

aliases: bonjour-profile

string

Bonjour profile name.

comment

string

Comment.

console_login

aliases: console-login

string

Enable/disable FortiAP console login access

Choices:

  • "disable"

  • "enable"

control_message_offload

aliases: control-message-offload

list / elements=string

Enable/disable CAPWAP control message data channel offload.

Choices:

  • "ebp-frame"

  • "aeroscout-tag"

  • "ap-list"

  • "sta-list"

  • "sta-cap-list"

  • "stats"

  • "aeroscout-mu"

  • "sta-health"

  • "spectral-analysis"

deny_mac_list

aliases: deny-mac-list

list / elements=dictionary

Deny mac list.

id

integer

ID.

mac

string

A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP.

dtls_in_kernel

aliases: dtls-in-kernel

string

Enable/disable data channel DTLS in kernel.

Choices:

  • "disable"

  • "enable"

dtls_policy

aliases: dtls-policy

list / elements=string

WTP data channel DTLS policy

Choices:

  • "clear-text"

  • "dtls-enabled"

  • "ipsec-vpn"

  • "ipsec-sn-vpn"

energy_efficient_ethernet

aliases: energy-efficient-ethernet

string

Enable/disable use of energy efficient Ethernet on WTP.

Choices:

  • "disable"

  • "enable"

esl_ses_dongle

aliases: esl-ses-dongle

dictionary

Esl ses dongle.

apc_addr_type

aliases: apc-addr-type

string

ESL SES-imagotag APC address type

Choices:

  • "fqdn"

  • "ip"

apc_fqdn

aliases: apc-fqdn

string

FQDN of ESL SES-imagotag Access Point Controller

apc_ip

aliases: apc-ip

string

IP address of ESL SES-imagotag Access Point Controller

apc_port

aliases: apc-port

integer

Port of ESL SES-imagotag Access Point Controller

coex_level

aliases: coex-level

string

ESL SES-imagotag dongle coexistence level

Choices:

  • "none"

compliance_level

aliases: compliance-level

string

Compliance levels for the ESL solution integration

Choices:

  • "compliance-level-2"

esl_channel

aliases: esl-channel

string

ESL SES-imagotag dongle channel

Choices:

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

  • "8"

  • "9"

  • "10"

  • "127"

  • "-1"

output_power

aliases: output-power

string

ESL SES-imagotag dongle output power

Choices:

  • "a"

  • "b"

  • "c"

  • "d"

  • "e"

  • "f"

  • "g"

  • "h"

scd_enable

aliases: scd-enable

string

Enable/disable ESL SES-imagotag Serial Communication Daemon

Choices:

  • "disable"

  • "enable"

tls_cert_verification

aliases: tls-cert-verification

string

Enable/disable TLS certificate verification

Choices:

  • "disable"

  • "enable"

tls_fqdn_verification

aliases: tls-fqdn-verification

string

Enable/disable TLS certificate verification

Choices:

  • "disable"

  • "enable"

ext_info_enable

aliases: ext-info-enable

string

Enable/disable station/VAP/radio extension information.

Choices:

  • "disable"

  • "enable"

frequency_handoff

aliases: frequency-handoff

string

Enable/disable frequency handoff of clients to other channels

Choices:

  • "disable"

  • "enable"

handoff_roaming

aliases: handoff-roaming

string

Enable/disable client load balancing during roaming to avoid roaming delay

Choices:

  • "disable"

  • "enable"

handoff_rssi

aliases: handoff-rssi

integer

Minimum received signal strength indicator

handoff_sta_thresh

aliases: handoff-sta-thresh

integer

Threshold value for AP handoff.

indoor_outdoor_deployment

aliases: indoor-outdoor-deployment

string

Set to allow indoor/outdoor-only channels under regulatory rules

Choices:

  • "platform-determined"

  • "outdoor"

  • "indoor"

ip_fragment_preventing

aliases: ip-fragment-preventing

list / elements=string

Select how to prevent IP fragmentation for CAPWAP tunneled control and data packets

Choices:

  • "tcp-mss-adjust"

  • "icmp-unreachable"

lan

dictionary

Lan.

port1_mode

aliases: port1-mode

string

LAN port 1 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port1_ssid

aliases: port1-ssid

string

Bridge LAN port 1 to SSID.

port2_mode

aliases: port2-mode

string

LAN port 2 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port2_ssid

aliases: port2-ssid

string

Bridge LAN port 2 to SSID.

port3_mode

aliases: port3-mode

string

LAN port 3 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port3_ssid

aliases: port3-ssid

string

Bridge LAN port 3 to SSID.

port4_mode

aliases: port4-mode

string

LAN port 4 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port4_ssid

aliases: port4-ssid

string

Bridge LAN port 4 to SSID.

port5_mode

aliases: port5-mode

string

LAN port 5 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port5_ssid

aliases: port5-ssid

string

Bridge LAN port 5 to SSID.

port6_mode

aliases: port6-mode

string

LAN port 6 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port6_ssid

aliases: port6-ssid

string

Bridge LAN port 6 to SSID.

port7_mode

aliases: port7-mode

string

LAN port 7 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port7_ssid

aliases: port7-ssid

string

Bridge LAN port 7 to SSID.

port8_mode

aliases: port8-mode

string

LAN port 8 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port8_ssid

aliases: port8-ssid

string

Bridge LAN port 8 to SSID.

port_esl_mode

aliases: port-esl-mode

string

ESL port mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port_esl_ssid

aliases: port-esl-ssid

string

Bridge ESL port to SSID.

port_mode

aliases: port-mode

string

LAN port mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port_ssid

aliases: port-ssid

string

Bridge LAN port to SSID.

lbs

dictionary

Lbs.

aeroscout

string

Enable/disable AeroScout Real Time Location Service

Choices:

  • "disable"

  • "enable"

aeroscout_ap_mac

aliases: aeroscout-ap-mac

string

Use BSSID or board MAC address as AP MAC address in AeroScout AP messages

Choices:

  • "bssid"

  • "board-mac"

aeroscout_mmu_report

aliases: aeroscout-mmu-report

string

Enable/disable compounded AeroScout tag and MU report

Choices:

  • "disable"

  • "enable"

aeroscout_mu

aliases: aeroscout-mu

string

Enable/disable AeroScout Mobile Unit

Choices:

  • "disable"

  • "enable"

aeroscout_mu_factor

aliases: aeroscout-mu-factor

integer

AeroScout MU mode dilution factor

aeroscout_mu_timeout

aliases: aeroscout-mu-timeout

integer

AeroScout MU mode timeout

aeroscout_server_ip

aliases: aeroscout-server-ip

string

IP address of AeroScout server.

aeroscout_server_port

aliases: aeroscout-server-port

integer

AeroScout server UDP listening port.

ble_rtls

aliases: ble-rtls

string

Set BLE Real Time Location Service

Choices:

  • "none"

  • "polestar"

  • "evresys"

ble_rtls_accumulation_interval

aliases: ble-rtls-accumulation-interval

integer

Time that measurements should be accumulated in seconds

ble_rtls_asset_addrgrp_list

aliases: ble-rtls-asset-addrgrp-list

any

(list) Tags and asset addrgrp list to be reported.

ble_rtls_asset_uuid_list1

aliases: ble-rtls-asset-uuid-list1

string

Tags and asset UUID list 1 to be reported

ble_rtls_asset_uuid_list2

aliases: ble-rtls-asset-uuid-list2

string

Tags and asset UUID list 2 to be reported

ble_rtls_asset_uuid_list3

aliases: ble-rtls-asset-uuid-list3

string

Tags and asset UUID list 3 to be reported

ble_rtls_asset_uuid_list4

aliases: ble-rtls-asset-uuid-list4

string

Tags and asset UUID list 4 to be reported

ble_rtls_protocol

aliases: ble-rtls-protocol

string

Select the protocol to report Measurements, Advertising Data, or Location Data to Cloud Server.

Choices:

  • "WSS"

ble_rtls_reporting_interval

aliases: ble-rtls-reporting-interval

integer

Time between reporting accumulated measurements in seconds

ble_rtls_server_fqdn

aliases: ble-rtls-server-fqdn

string

FQDN of BLE Real Time Location Service

ble_rtls_server_path

aliases: ble-rtls-server-path

string

Path of BLE Real Time Location Service

ble_rtls_server_port

aliases: ble-rtls-server-port

integer

Port of BLE Real Time Location Service

ble_rtls_server_token

aliases: ble-rtls-server-token

string

Access Token of BLE Real Time Location Service

ekahau_blink_mode

aliases: ekahau-blink-mode

string

Enable/disable Ekahau blink mode

Choices:

  • "disable"

  • "enable"

ekahau_tag

aliases: ekahau-tag

string

WiFi frame MAC address or WiFi Tag.

erc_server_ip

aliases: erc-server-ip

string

IP address of Ekahau RTLS Controller

erc_server_port

aliases: erc-server-port

integer

Ekahau RTLS Controller

fortipresence

string

Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to thi…

Choices:

  • "disable"

  • "enable"

  • "enable2"

  • "foreign"

  • "both"

fortipresence_ble

aliases: fortipresence-ble

string

Enable/disable FortiPresence finding and reporting BLE devices.

Choices:

  • "disable"

  • "enable"

fortipresence_frequency

aliases: fortipresence-frequency

integer

FortiPresence report transmit frequency

fortipresence_port

aliases: fortipresence-port

integer

FortiPresence server UDP listening port

fortipresence_project

aliases: fortipresence-project

string

FortiPresence project name

fortipresence_rogue

aliases: fortipresence-rogue

string

Enable/disable FortiPresence finding and reporting rogue APs.

Choices:

  • "disable"

  • "enable"

fortipresence_secret

aliases: fortipresence-secret

any

(list) FortiPresence secret password

fortipresence_server

aliases: fortipresence-server

string

FortiPresence server IP address.

fortipresence_server_addr_type

aliases: fortipresence-server-addr-type

string

FortiPresence server address type

Choices:

  • "fqdn"

  • "ipv4"

fortipresence_server_fqdn

aliases: fortipresence-server-fqdn

string

FQDN of FortiPresence server.

fortipresence_unassoc

aliases: fortipresence-unassoc

string

Enable/disable FortiPresence finding and reporting unassociated stations.

Choices:

  • "disable"

  • "enable"

polestar

string

Enable/disable PoleStar BLE NAO Track Real Time Location Service

Choices:

  • "disable"

  • "enable"

polestar_accumulation_interval

aliases: polestar-accumulation-interval

integer

Time that measurements should be accumulated in seconds

polestar_asset_addrgrp_list

aliases: polestar-asset-addrgrp-list

string

Tags and asset addrgrp list to be reported.

polestar_asset_uuid_list1

aliases: polestar-asset-uuid-list1

string

Tags and asset UUID list 1 to be reported

polestar_asset_uuid_list2

aliases: polestar-asset-uuid-list2

string

Tags and asset UUID list 2 to be reported

polestar_asset_uuid_list3

aliases: polestar-asset-uuid-list3

string

Tags and asset UUID list 3 to be reported

polestar_asset_uuid_list4

aliases: polestar-asset-uuid-list4

string

Tags and asset UUID list 4 to be reported

polestar_protocol

aliases: polestar-protocol

string

Select the protocol to report Measurements, Advertising Data, or Location Data to NAO Cloud.

Choices:

  • "WSS"

polestar_reporting_interval

aliases: polestar-reporting-interval

integer

Time between reporting accumulated measurements in seconds

polestar_server_fqdn

aliases: polestar-server-fqdn

string

FQDN of PoleStar Nao Track Server

polestar_server_path

aliases: polestar-server-path

string

Path of PoleStar Nao Track Server

polestar_server_port

aliases: polestar-server-port

integer

Port of PoleStar Nao Track Server

polestar_server_token

aliases: polestar-server-token

string

Access Token of PoleStar Nao Track Server.

station_locate

aliases: station-locate

string

Enable/disable client station locating services for all clients, whether associated or not

Choices:

  • "disable"

  • "enable"

led_schedules

aliases: led-schedules

any

(list or str) Recurring firewall schedules for illuminating LEDs on the FortiAP.

led_state

aliases: led-state

string

Enable/disable use of LEDs on WTP

Choices:

  • "disable"

  • "enable"

lldp

string

Enable/disable Link Layer Discovery Protocol

Choices:

  • "disable"

  • "enable"

login_passwd

aliases: login-passwd

any

(list) Set the managed WTP, FortiAP, or APs administrator password.

login_passwd_change

aliases: login-passwd-change

string

Change or reset the administrator password of a managed WTP, FortiAP or AP

Choices:

  • "no"

  • "yes"

  • "default"

max_clients

aliases: max-clients

integer

Maximum number of stations

name

string / required

WTP

platform

dictionary

Platform.

_local_platform_str

string

Local platform str.

ddscan

string

Enable/disable use of one radio for dedicated dual-band scanning to detect RF characterization and wireless threat…

Choices:

  • "disable"

  • "enable"

mode

string

Configure operation mode of 5G radios

Choices:

  • "dual-5G"

  • "single-5G"

type

string

WTP, FortiAP or AP platform type.

Choices:

  • "30B-50B"

  • "60B"

  • "80CM-81CM"

  • "220A"

  • "220B"

  • "210B"

  • "60C"

  • "222B"

  • "112B"

  • "320B"

  • "11C"

  • "14C"

  • "223B"

  • "28C"

  • "320C"

  • "221C"

  • "25D"

  • "222C"

  • "224D"

  • "214B"

  • "21D"

  • "24D"

  • "112D"

  • "223C"

  • "321C"

  • "C220C"

  • "C225C"

  • "S321C"

  • "S323C"

  • "FWF"

  • "S311C"

  • "S313C"

  • "AP-11N"

  • "S322C"

  • "S321CR"

  • "S322CR"

  • "S323CR"

  • "S421E"

  • "S422E"

  • "S423E"

  • "421E"

  • "423E"

  • "C221E"

  • "C226E"

  • "C23JD"

  • "C24JE"

  • "C21D"

  • "U421E"

  • "U423E"

  • "221E"

  • "222E"

  • "223E"

  • "S221E"

  • "S223E"

  • "U221EV"

  • "U223EV"

  • "U321EV"

  • "U323EV"

  • "224E"

  • "U422EV"

  • "U24JEV"

  • "321E"

  • "U431F"

  • "U433F"

  • "231E"

  • "431F"

  • "433F"

  • "231F"

  • "432F"

  • "234F"

  • "23JF"

  • "U231F"

  • "831F"

  • "U234F"

  • "U432F"

  • "431FL"

  • "432FR"

  • "433FL"

  • "231FL"

  • "231G"

  • "233G"

  • "431G"

  • "433G"

  • "U231G"

  • "U441G"

  • "234G"

  • "432G"

  • "441K"

  • "443K"

  • "241K"

  • "243K"

  • "231K"

  • "23JK"

poe_mode

aliases: poe-mode

string

Set the WTP, FortiAP, or APs PoE mode.

Choices:

  • "auto"

  • "8023af"

  • "8023at"

  • "power-adapter"

  • "full"

  • "high"

  • "low"

radio_1

aliases: radio-1

dictionary

Radio 1.

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 1 operates on.

Choices:

  • "802.11b"

  • "802.11a"

  • "802.11g"

  • "802.11n"

  • "802.11ac"

  • "802.11n-5G"

  • "802.11ax-5G"

  • "802.11ax"

  • "802.11ac-2G"

  • "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.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:

  • "disable"

  • "enable"

  • "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 1.

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

Configure method for assigning SSIDs to this FortiAP

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"

radio_2

aliases: radio-2

dictionary

Radio 2.

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 2 operates on.

Choices:

  • "802.11b"

  • "802.11a"

  • "802.11g"

  • "802.11n"

  • "802.11ac"

  • "802.11n-5G"

  • "802.11ax-5G"

  • "802.11ax"

  • "802.11ac-2G"

  • "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.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:

  • "disable"

  • "enable"

  • "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 2.

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

Configure method for assigning SSIDs to this FortiAP

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"

radio_3

aliases: radio-3

dictionary

Radio 3.

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.11ac-2G"

  • "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.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

Configure method for assigning SSIDs to this FortiAP

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"

radio_4

aliases: radio-4

dictionary

Radio 4.

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.11ac-2G"

  • "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.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:

  • "ap"

  • "monitor"

  • "sniffer"

  • "disabled"

  • "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

Configure method for assigning SSIDs to this FortiAP

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"

snmp

string

Enable/disable SNMP for the WTP, FortiAP, or AP

Choices:

  • "disable"

  • "enable"

split_tunneling_acl

aliases: split-tunneling-acl

list / elements=dictionary

Split tunneling acl.

dest_ip

aliases: dest-ip

string

Destination IP and mask for the split-tunneling subnet.

id

integer

ID.

split_tunneling_acl_local_ap_subnet

aliases: split-tunneling-acl-local-ap-subnet

string

Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL

Choices:

  • "disable"

  • "enable"

split_tunneling_acl_path

aliases: split-tunneling-acl-path

string

Split tunneling ACL path is local/tunnel.

Choices:

  • "tunnel"

  • "local"

syslog_profile

aliases: syslog-profile

string

System log server configuration profile name.

tun_mtu_downlink

aliases: tun-mtu-downlink

integer

Downlink CAPWAP tunnel MTU

tun_mtu_uplink

aliases: tun-mtu-uplink

integer

Uplink CAPWAP tunnel MTU

unii_4_5ghz_band

aliases: unii-4-5ghz-band

string

Enable/disable UNII-4 5Ghz band channels

Choices:

  • "disable"

  • "enable"

usb_port

aliases: usb-port

string

Enable/disable USB port of the WTP

Choices:

  • "disable"

  • "enable"

wan_port_auth

aliases: wan-port-auth

string

Set WAN port authentication mode

Choices:

  • "none"

  • "802.1x"

wan_port_auth_macsec

aliases: wan-port-auth-macsec

string

Enable/disable WAN port 802.

Choices:

  • "disable"

  • "enable"

wan_port_auth_methods

aliases: wan-port-auth-methods

string

WAN port 802.

Choices:

  • "all"

  • "EAP-FAST"

  • "EAP-TLS"

  • "EAP-PEAP"

wan_port_auth_password

aliases: wan-port-auth-password

any

(list) Set WAN port 802.

wan_port_auth_usrname

aliases: wan-port-auth-usrname

string

Set WAN port 802.

wan_port_mode

aliases: wan-port-mode

string

Enable/disable using a WAN port as a LAN port.

Choices:

  • "wan-lan"

  • "wan-only"

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.

  • 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

- 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: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
      fortinet.fortimanager.fmgr_wtpprofile:
        # 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>
        state: present # <value in [present, absent]>
        wtpprofile:
          allowaccess:
            - "https"
            - "ssh"
            - "snmp"
            - "http"
            - "telnet"
          ap_country: <value in [AL, DZ, AR, ...]>
          ble_profile: <string>
          comment: <string>
          control_message_offload:
            - "ebp-frame"
            - "aeroscout-tag"
            - "ap-list"
            - "sta-list"
            - "sta-cap-list"
            - "stats"
            - "aeroscout-mu"
            - "sta-health"
            - "spectral-analysis"
          deny_mac_list:
            -
              id: <integer>
              mac: <string>
          dtls_in_kernel: <value in [disable, enable]>
          dtls_policy:
            - "clear-text"
            - "dtls-enabled"
            - "ipsec-vpn"
            - "ipsec-sn-vpn"
          energy_efficient_ethernet: <value in [disable, enable]>
          ext_info_enable: <value in [disable, enable]>
          handoff_roaming: <value in [disable, enable]>
          handoff_rssi: <integer>
          handoff_sta_thresh: <integer>
          ip_fragment_preventing:
            - "tcp-mss-adjust"
            - "icmp-unreachable"
          led_schedules: <list or string>
          led_state: <value in [disable, enable]>
          lldp: <value in [disable, enable]>
          login_passwd: <list or string>
          login_passwd_change: <value in [no, yes, default]>
          max_clients: <integer>
          name: <string>
          poe_mode: <value in [auto, 8023af, 8023at, ...]>
          split_tunneling_acl:
            -
              dest_ip: <string>
              id: <integer>
          split_tunneling_acl_local_ap_subnet: <value in [disable, enable]>
          split_tunneling_acl_path: <value in [tunnel, local]>
          tun_mtu_downlink: <integer>
          tun_mtu_uplink: <integer>
          wan_port_mode: <value in [wan-lan, wan-only]>
          snmp: <value in [disable, enable]>
          ap_handoff: <value in [disable, enable]>
          apcfg_profile: <string>
          frequency_handoff: <value in [disable, enable]>
          lan:
            port_esl_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port_esl_ssid: <string>
            port_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port_ssid: <string>
            port1_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port1_ssid: <string>
            port2_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port2_ssid: <string>
            port3_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port3_ssid: <string>
            port4_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port4_ssid: <string>
            port5_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port5_ssid: <string>
            port6_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port6_ssid: <string>
            port7_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port7_ssid: <string>
            port8_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port8_ssid: <string>
          lbs:
            aeroscout: <value in [disable, enable]>
            aeroscout_ap_mac: <value in [bssid, board-mac]>
            aeroscout_mmu_report: <value in [disable, enable]>
            aeroscout_mu: <value in [disable, enable]>
            aeroscout_mu_factor: <integer>
            aeroscout_mu_timeout: <integer>
            aeroscout_server_ip: <string>
            aeroscout_server_port: <integer>
            ekahau_blink_mode: <value in [disable, enable]>
            ekahau_tag: <string>
            erc_server_ip: <string>
            erc_server_port: <integer>
            fortipresence: <value in [disable, enable, enable2, ...]>
            fortipresence_ble: <value in [disable, enable]>
            fortipresence_frequency: <integer>
            fortipresence_port: <integer>
            fortipresence_project: <string>
            fortipresence_rogue: <value in [disable, enable]>
            fortipresence_secret: <list or string>
            fortipresence_server: <string>
            fortipresence_unassoc: <value in [disable, enable]>
            station_locate: <value in [disable, enable]>
            fortipresence_server_addr_type: <value in [fqdn, ipv4]>
            fortipresence_server_fqdn: <string>
            polestar: <value in [disable, enable]>
            polestar_accumulation_interval: <integer>
            polestar_asset_addrgrp_list: <string>
            polestar_asset_uuid_list1: <string>
            polestar_asset_uuid_list2: <string>
            polestar_asset_uuid_list3: <string>
            polestar_asset_uuid_list4: <string>
            polestar_protocol: <value in [WSS]>
            polestar_reporting_interval: <integer>
            polestar_server_fqdn: <string>
            polestar_server_path: <string>
            polestar_server_port: <integer>
            polestar_server_token: <string>
            ble_rtls: <value in [none, polestar, evresys]>
            ble_rtls_accumulation_interval: <integer>
            ble_rtls_asset_addrgrp_list: <list or string>
            ble_rtls_asset_uuid_list1: <string>
            ble_rtls_asset_uuid_list2: <string>
            ble_rtls_asset_uuid_list3: <string>
            ble_rtls_asset_uuid_list4: <string>
            ble_rtls_protocol: <value in [WSS]>
            ble_rtls_reporting_interval: <integer>
            ble_rtls_server_fqdn: <string>
            ble_rtls_server_path: <string>
            ble_rtls_server_port: <integer>
            ble_rtls_server_token: <string>
          platform:
            ddscan: <value in [disable, enable]>
            mode: <value in [dual-5G, single-5G]>
            type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
            _local_platform_str: <string>
          radio_1:
            airtime_fairness: <value in [disable, enable]>
            amsdu: <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>
            auto_power_target: <string>
            band: <value in [802.11b, 802.11a, 802.11g, ...]>
            band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
            bandwidth_admission_control: <value in [disable, enable]>
            bandwidth_capacity: <integer>
            beacon_interval: <integer>
            bss_color: <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]>
            drma: <value in [disable, enable]>
            drma_sensitivity: <value in [low, medium, high]>
            dtim: <integer>
            frag_threshold: <integer>
            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, ...]>
            vap1: <string>
            vap2: <string>
            vap3: <string>
            vap4: <string>
            vap5: <string>
            vap6: <string>
            vap7: <string>
            vap8: <string>
            vaps: <list or string>
            wids_profile: <string>
            zero_wait_dfs: <value in [disable, enable]>
            frequency_handoff: <value in [disable, enable]>
            ap_handoff: <value in [disable, enable]>
            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, ...]>
          radio_2:
            airtime_fairness: <value in [disable, enable]>
            amsdu: <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>
            auto_power_target: <string>
            band: <value in [802.11b, 802.11a, 802.11g, ...]>
            band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
            bandwidth_admission_control: <value in [disable, enable]>
            bandwidth_capacity: <integer>
            beacon_interval: <integer>
            bss_color: <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]>
            drma: <value in [disable, enable]>
            drma_sensitivity: <value in [low, medium, high]>
            dtim: <integer>
            frag_threshold: <integer>
            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, ...]>
            vap1: <string>
            vap2: <string>
            vap3: <string>
            vap4: <string>
            vap5: <string>
            vap6: <string>
            vap7: <string>
            vap8: <string>
            vaps: <list or string>
            wids_profile: <string>
            zero_wait_dfs: <value in [disable, enable]>
            frequency_handoff: <value in [disable, enable]>
            ap_handoff: <value in [disable, enable]>
            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, ...]>
          radio_3:
            airtime_fairness: <value in [disable, enable]>
            amsdu: <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>
            auto_power_target: <string>
            band: <value in [802.11b, 802.11a, 802.11g, ...]>
            band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
            bandwidth_admission_control: <value in [disable, enable]>
            bandwidth_capacity: <integer>
            beacon_interval: <integer>
            bss_color: <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]>
            drma: <value in [disable, enable]>
            drma_sensitivity: <value in [low, medium, high]>
            dtim: <integer>
            frag_threshold: <integer>
            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, ...]>
            vap1: <string>
            vap2: <string>
            vap3: <string>
            vap4: <string>
            vap5: <string>
            vap6: <string>
            vap7: <string>
            vap8: <string>
            vaps: <list or string>
            wids_profile: <string>
            zero_wait_dfs: <value in [disable, enable]>
            frequency_handoff: <value in [disable, enable]>
            ap_handoff: <value in [disable, enable]>
            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, ...]>
          radio_4:
            airtime_fairness: <value in [disable, enable]>
            amsdu: <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>
            auto_power_target: <string>
            band: <value in [802.11b, 802.11a, 802.11g, ...]>
            band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
            bandwidth_admission_control: <value in [disable, enable]>
            bandwidth_capacity: <integer>
            beacon_interval: <integer>
            bss_color: <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]>
            drma: <value in [disable, enable]>
            drma_sensitivity: <value in [low, medium, high]>
            dtim: <integer>
            frag_threshold: <integer>
            max_clients: <integer>
            max_distance: <integer>
            mode: <value in [ap, monitor, sniffer, ...]>
            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, ...]>
            vap1: <string>
            vap2: <string>
            vap3: <string>
            vap4: <string>
            vap5: <string>
            vap6: <string>
            vap7: <string>
            vap8: <string>
            vaps: <list or string>
            wids_profile: <string>
            zero_wait_dfs: <value in [disable, enable]>
            frequency_handoff: <value in [disable, enable]>
            ap_handoff: <value in [disable, enable]>
            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, ...]>
          console_login: <value in [disable, enable]>
          esl_ses_dongle:
            apc_addr_type: <value in [fqdn, ip]>
            apc_fqdn: <string>
            apc_ip: <string>
            apc_port: <integer>
            coex_level: <value in [none]>
            compliance_level: <value in [compliance-level-2]>
            esl_channel: <value in [0, 1, 2, ...]>
            output_power: <value in [a, b, c, ...]>
            scd_enable: <value in [disable, enable]>
            tls_cert_verification: <value in [disable, enable]>
            tls_fqdn_verification: <value in [disable, enable]>
          indoor_outdoor_deployment: <value in [platform-determined, outdoor, indoor]>
          syslog_profile: <string>
          wan_port_auth: <value in [none, 802.1x]>
          wan_port_auth_methods: <value in [all, EAP-FAST, EAP-TLS, ...]>
          wan_port_auth_password: <list or string>
          wan_port_auth_usrname: <string>
          _is_factory_setting: <value in [disable, enable, ext]>
          unii_4_5ghz_band: <value in [disable, enable]>
          bonjour_profile: <string>
          wan_port_auth_macsec: <value in [disable, enable]>
          usb_port: <value in [disable, enable]>

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)