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.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile.

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

string

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

string

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

Choices:

  • "disable"

  • "enable"

apcfg-profile

string

Deprecated, please rename it to apcfg_profile. AP local configuration profile name.

ble-profile

string

Deprecated, please rename it to ble_profile. Bluetooth Low Energy profile name.

bonjour-profile

string

Deprecated, please rename it to bonjour_profile. Bonjour profile name.

comment

string

Comment.

console-login

string

Deprecated, please rename it to console_login. Enable/disable FortiAP console login access

Choices:

  • "disable"

  • "enable"

control-message-offload

list / elements=string

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

list / elements=dictionary

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

string

Deprecated, please rename it to dtls_in_kernel. Enable/disable data channel DTLS in kernel.

Choices:

  • "disable"

  • "enable"

dtls-policy

list / elements=string

Deprecated, please rename it to dtls_policy. WTP data channel DTLS policy

Choices:

  • "clear-text"

  • "dtls-enabled"

  • "ipsec-vpn"

  • "ipsec-sn-vpn"

energy-efficient-ethernet

string

Deprecated, please rename it to energy_efficient_ethernet. Enable/disable use of energy efficient Ethernet on WTP.

Choices:

  • "disable"

  • "enable"

esl-ses-dongle

dictionary

Deprecated, please rename it to esl_ses_dongle. Esl ses dongle.

apc-addr-type

string

Deprecated, please rename it to apc_addr_type. ESL SES-imagotag APC address type

Choices:

  • "fqdn"

  • "ip"

apc-fqdn

string

Deprecated, please rename it to apc_fqdn. FQDN of ESL SES-imagotag Access Point Controller

apc-ip

string

Deprecated, please rename it to apc_ip. IP address of ESL SES-imagotag Access Point Controller

apc-port

integer

Deprecated, please rename it to apc_port. Port of ESL SES-imagotag Access Point Controller

coex-level

string

Deprecated, please rename it to coex_level. ESL SES-imagotag dongle coexistence level

Choices:

  • "none"

compliance-level

string

Deprecated, please rename it to compliance_level. Compliance levels for the ESL solution integration

Choices:

  • "compliance-level-2"

esl-channel

string

Deprecated, please rename it to esl_channel. ESL SES-imagotag dongle channel

Choices:

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

  • "8"

  • "9"

  • "10"

  • "127"

  • "-1"

output-power

string

Deprecated, please rename it to output_power. ESL SES-imagotag dongle output power

Choices:

  • "a"

  • "b"

  • "c"

  • "d"

  • "e"

  • "f"

  • "g"

  • "h"

scd-enable

string

Deprecated, please rename it to scd_enable. Enable/disable ESL SES-imagotag Serial Communication Daemon

Choices:

  • "disable"

  • "enable"

tls-cert-verification

string

Deprecated, please rename it to tls_cert_verification. Enable/disable TLS certificate verification

Choices:

  • "disable"

  • "enable"

tls-fqdn-verification

string

Deprecated, please rename it to tls_fqdn_verification. Enable/disable TLS certificate verification

Choices:

  • "disable"

  • "enable"

ext-info-enable

string

Deprecated, please rename it to ext_info_enable. Enable/disable station/VAP/radio extension information.

Choices:

  • "disable"

  • "enable"

frequency-handoff

string

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

Choices:

  • "disable"

  • "enable"

handoff-roaming

string

Deprecated, please rename it to handoff_roaming. Enable/disable client load balancing during roaming to avoid roaming delay

Choices:

  • "disable"

  • "enable"

handoff-rssi

integer

Deprecated, please rename it to handoff_rssi. Minimum received signal strength indicator

handoff-sta-thresh

integer

Deprecated, please rename it to handoff_sta_thresh. Threshold value for AP handoff.

indoor-outdoor-deployment

string

Deprecated, please rename it to indoor_outdoor_deployment. Set to allow indoor/outdoor-only channels under regulatory rules

Choices:

  • "platform-determined"

  • "outdoor"

  • "indoor"

ip-fragment-preventing

list / elements=string

Deprecated, please rename it to ip_fragment_preventing. Select how to prevent IP fragmentation for CAPWAP tunneled control…

Choices:

  • "tcp-mss-adjust"

  • "icmp-unreachable"

lan

dictionary

Lan.

port-esl-mode

string

Deprecated, please rename it to port_esl_mode. ESL port mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port-esl-ssid

string

Deprecated, please rename it to port_esl_ssid. Bridge ESL port to SSID.

port-mode

string

Deprecated, please rename it to port_mode. LAN port mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port-ssid

string

Deprecated, please rename it to port_ssid. Bridge LAN port to SSID.

port1-mode

string

Deprecated, please rename it to port1_mode. LAN port 1 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port1-ssid

string

Deprecated, please rename it to port1_ssid. Bridge LAN port 1 to SSID.

port2-mode

string

Deprecated, please rename it to port2_mode. LAN port 2 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port2-ssid

string

Deprecated, please rename it to port2_ssid. Bridge LAN port 2 to SSID.

port3-mode

string

Deprecated, please rename it to port3_mode. LAN port 3 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port3-ssid

string

Deprecated, please rename it to port3_ssid. Bridge LAN port 3 to SSID.

port4-mode

string

Deprecated, please rename it to port4_mode. LAN port 4 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port4-ssid

string

Deprecated, please rename it to port4_ssid. Bridge LAN port 4 to SSID.

port5-mode

string

Deprecated, please rename it to port5_mode. LAN port 5 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port5-ssid

string

Deprecated, please rename it to port5_ssid. Bridge LAN port 5 to SSID.

port6-mode

string

Deprecated, please rename it to port6_mode. LAN port 6 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port6-ssid

string

Deprecated, please rename it to port6_ssid. Bridge LAN port 6 to SSID.

port7-mode

string

Deprecated, please rename it to port7_mode. LAN port 7 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port7-ssid

string

Deprecated, please rename it to port7_ssid. Bridge LAN port 7 to SSID.

port8-mode

string

Deprecated, please rename it to port8_mode. LAN port 8 mode.

Choices:

  • "offline"

  • "bridge-to-wan"

  • "bridge-to-ssid"

  • "nat-to-wan"

port8-ssid

string

Deprecated, please rename it to port8_ssid. Bridge LAN port 8 to SSID.

lbs

dictionary

Lbs.

aeroscout

string

Enable/disable AeroScout Real Time Location Service

Choices:

  • "disable"

  • "enable"

aeroscout-ap-mac

string

Deprecated, please rename it to aeroscout_ap_mac. Use BSSID or board MAC address as AP MAC address in AeroScout AP…

Choices:

  • "bssid"

  • "board-mac"

aeroscout-mmu-report

string

Deprecated, please rename it to aeroscout_mmu_report. Enable/disable compounded AeroScout tag and MU report

Choices:

  • "disable"

  • "enable"

aeroscout-mu

string

Deprecated, please rename it to aeroscout_mu. Enable/disable AeroScout Mobile Unit

Choices:

  • "disable"

  • "enable"

aeroscout-mu-factor

integer

Deprecated, please rename it to aeroscout_mu_factor. AeroScout MU mode dilution factor

aeroscout-mu-timeout

integer

Deprecated, please rename it to aeroscout_mu_timeout. AeroScout MU mode timeout

aeroscout-server-ip

string

Deprecated, please rename it to aeroscout_server_ip. IP address of AeroScout server.

aeroscout-server-port

integer

Deprecated, please rename it to aeroscout_server_port. AeroScout server UDP listening port.

string

Deprecated, please rename it to ekahau_blink_mode. Enable/disable Ekahau blink mode

Choices:

  • "disable"

  • "enable"

ekahau-tag

string

Deprecated, please rename it to ekahau_tag. WiFi frame MAC address or WiFi Tag.

erc-server-ip

string

Deprecated, please rename it to erc_server_ip. IP address of Ekahau RTLS Controller

erc-server-port

integer

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

string

Deprecated, please rename it to fortipresence_ble. Enable/disable FortiPresence finding and reporting BLE devices.

Choices:

  • "disable"

  • "enable"

fortipresence-frequency

integer

Deprecated, please rename it to fortipresence_frequency. FortiPresence report transmit frequency

fortipresence-port

integer

Deprecated, please rename it to fortipresence_port. FortiPresence server UDP listening port

fortipresence-project

string

Deprecated, please rename it to fortipresence_project. FortiPresence project name

fortipresence-rogue

string

Deprecated, please rename it to fortipresence_rogue. Enable/disable FortiPresence finding and reporting rogue APs.

Choices:

  • "disable"

  • "enable"

fortipresence-secret

any

(list) Deprecated, please rename it to fortipresence_secret. FortiPresence secret password

fortipresence-server

string

Deprecated, please rename it to fortipresence_server. FortiPresence server IP address.

fortipresence-server-addr-type

string

Deprecated, please rename it to fortipresence_server_addr_type. FortiPresence server address type

Choices:

  • "fqdn"

  • "ipv4"

fortipresence-server-fqdn

string

Deprecated, please rename it to fortipresence_server_fqdn. FQDN of FortiPresence server.

fortipresence-unassoc

string

Deprecated, please rename it to fortipresence_unassoc. Enable/disable FortiPresence finding and reporting unassoci…

Choices:

  • "disable"

  • "enable"

polestar

string

Enable/disable PoleStar BLE NAO Track Real Time Location Service

Choices:

  • "disable"

  • "enable"

polestar-accumulation-interval

integer

Deprecated, please rename it to polestar_accumulation_interval. Time that measurements should be accumulated in se…

polestar-asset-addrgrp-list

string

Deprecated, please rename it to polestar_asset_addrgrp_list. Tags and asset addrgrp list to be reported.

polestar-asset-uuid-list1

string

Deprecated, please rename it to polestar_asset_uuid_list1. Tags and asset UUID list 1 to be reported

polestar-asset-uuid-list2

string

Deprecated, please rename it to polestar_asset_uuid_list2. Tags and asset UUID list 2 to be reported

polestar-asset-uuid-list3

string

Deprecated, please rename it to polestar_asset_uuid_list3. Tags and asset UUID list 3 to be reported

polestar-asset-uuid-list4

string

Deprecated, please rename it to polestar_asset_uuid_list4. Tags and asset UUID list 4 to be reported

polestar-protocol

string

Deprecated, please rename it to polestar_protocol. Select the protocol to report Measurements, Advertising Data, o…

Choices:

  • "WSS"

polestar-reporting-interval

integer

Deprecated, please rename it to polestar_reporting_interval. Time between reporting accumulated measurements in se…

polestar-server-fqdn

string

Deprecated, please rename it to polestar_server_fqdn. FQDN of PoleStar Nao Track Server

polestar-server-path

string

Deprecated, please rename it to polestar_server_path. Path of PoleStar Nao Track Server

polestar-server-port

integer

Deprecated, please rename it to polestar_server_port. Port of PoleStar Nao Track Server

polestar-server-token

string

Deprecated, please rename it to polestar_server_token. Access Token of PoleStar Nao Track Server.

station-locate

string

Deprecated, please rename it to station_locate. Enable/disable client station locating services for all clients, w…

Choices:

  • "disable"

  • "enable"

led-schedules

any

(list or str) Deprecated, please rename it to led_schedules. Recurring firewall schedules for illuminating LEDs on the For…

led-state

string

Deprecated, please rename it to led_state. Enable/disable use of LEDs on WTP

Choices:

  • "disable"

  • "enable"

lldp

string

Enable/disable Link Layer Discovery Protocol

Choices:

  • "disable"

  • "enable"

login-passwd

any

(list) Deprecated, please rename it to login_passwd. Set the managed WTP, FortiAP, or APs administrator password.

login-passwd-change

string

Deprecated, please rename it to login_passwd_change. Change or reset the administrator password of a managed WTP, FortiAP …

Choices:

  • "no"

  • "yes"

  • "default"

max-clients

integer

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

poe-mode

string

Deprecated, please rename it to poe_mode. Set the WTP, FortiAP, or APs PoE mode.

Choices:

  • "auto"

  • "8023af"

  • "8023at"

  • "power-adapter"

  • "full"

  • "high"

  • "low"

radio-1

dictionary

Deprecated, please rename it to radio_1. Radio 1.

80211d

string

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

Choices:

  • "disable"

  • "enable"

80211mc

string

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

Choices:

  • "disable"

  • "enable"

airtime-fairness

string

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

Choices:

  • "disable"

  • "enable"

amsdu

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

ap-handoff

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-addr

string

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

ap-sniffer-bufsize

integer

Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size

ap-sniffer-chan

integer

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

ap-sniffer-chan-width

string

Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer.

Choices:

  • "320MHz"

  • "240MHz"

  • "160MHz"

  • "80MHz"

  • "40MHz"

  • "20MHz"

ap-sniffer-ctl

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-data

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-beacon

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-other

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-probe

string

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

Choices:

  • "disable"

  • "enable"

arrp-profile

string

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

auto-power-high

integer

Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm

auto-power-level

string

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

Choices:

  • "disable"

  • "enable"

auto-power-low

integer

Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm

auto-power-target

string

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

band

string

WiFi band that Radio 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

string

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

Choices:

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth-admission-control

string

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

Choices:

  • "disable"

  • "enable"

bandwidth-capacity

integer

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

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Beacon interval.

bss-color

integer

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

bss-color-mode

string

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

Choices:

  • "auto"

  • "static"

call-admission-control

string

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

Choices:

  • "disable"

  • "enable"

call-capacity

integer

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

channel

any

(list) Selected list of wireless radio channels.

channel-bonding

string

Deprecated, please rename it to channel_bonding. Channel bandwidth

Choices:

  • "disable"

  • "enable"

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

  • "320MHz"

  • "240MHz"

channel-bonding-ext

string

Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension

Choices:

  • "320MHz-1"

  • "320MHz-2"

channel-utilization

string

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

Choices:

  • "disable"

  • "enable"

coexistence

string

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

Choices:

  • "disable"

  • "enable"

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning

Choices:

  • "disable"

  • "enable"

drma

string

Enable/disable dynamic radio mode assignment

Choices:

  • "disable"

  • "enable"

drma-sensitivity

string

Deprecated, please rename it to drma_sensitivity. Network Coverage Factor

Choices:

  • "low"

  • "medium"

  • "high"

dtim

integer

Delivery Traffic Indication Map

frag-threshold

integer

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

frequency-handoff

string

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

Choices:

  • "disable"

  • "enable"

iperf-protocol

string

Deprecated, please rename it to iperf_protocol. Iperf test protocol

Choices:

  • "udp"

  • "tcp"

iperf-server-port

integer

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

max-clients

integer

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

max-distance

integer

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

mimo-mode

string

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

Choices:

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

string

Mode of radio 1.

Choices:

  • "disabled"

  • "ap"

  • "monitor"

  • "sniffer"

  • "sam"

optional-antenna

string

Deprecated, please rename it to optional_antenna. Optional antenna used on FAP

Choices:

  • "none"

  • "FANT-04ABGN-0606-O-N"

  • "FANT-04ABGN-1414-P-N"

  • "FANT-04ABGN-8065-P-N"

  • "FANT-04ABGN-0606-O-R"

  • "FANT-04ABGN-0606-P-R"

  • "FANT-10ACAX-1213-D-N"

  • "FANT-08ABGN-1213-D-R"

  • "custom"

optional-antenna-gain

string

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

power-level

integer

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

power-mode

string

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

Choices:

  • "dBm"

  • "percentage"

power-value

integer

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

powersave-optimize

list / elements=string

Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB…

Choices:

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection-mode

string

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

Choices:

  • "rtscts"

  • "ctsonly"

  • "disable"

radio-id

integer

Deprecated, please rename it to radio_id. Radio id.

rts-threshold

integer

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

sam-bssid

string

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

sam-ca-certificate

string

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

sam-captive-portal

string

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

Choices:

  • "disable"

  • "enable"

sam-client-certificate

string

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

sam-cwp-failure-string

string

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

sam-cwp-match-string

string

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

sam-cwp-password

any

(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication.

sam-cwp-success-string

string

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

sam-cwp-test-url

string

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

sam-cwp-username

string

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

sam-eap-method

string

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

Choices:

  • "tls"

  • "peap"

  • "both"

sam-password

any

(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection.

sam-private-key

string

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

sam-private-key-password

any

(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER…

sam-report-intv

integer

Deprecated, please rename it to sam_report_intv. SAM report interval

sam-security-type

string

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

Choices:

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam-server

string

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

sam-server-fqdn

string

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

sam-server-ip

string

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

sam-server-type

string

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

Choices:

  • "ip"

  • "fqdn"

sam-ssid

string

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

sam-test

string

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

Choices:

  • "ping"

  • "iperf"

sam-username

string

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

short-guard-interval

string

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

Choices:

  • "disable"

  • "enable"

spectrum-analysis

string

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

Choices:

  • "disable"

  • "enable"

  • "scan-only"

transmit-optimize

list / elements=string

Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving…

Choices:

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap-all

string

Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP

Choices:

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

vap1

string

Virtual Access Point

vap2

string

Virtual Access Point

vap3

string

Virtual Access Point

vap4

string

Virtual Access Point

vap5

string

Virtual Access Point

vap6

string

Virtual Access Point

vap7

string

Virtual Access Point

vap8

string

Virtual Access Point

vaps

any

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

wids-profile

string

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

zero-wait-dfs

string

Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio

Choices:

  • "disable"

  • "enable"

radio-2

dictionary

Deprecated, please rename it to radio_2. Radio 2.

80211d

string

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

Choices:

  • "disable"

  • "enable"

80211mc

string

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

Choices:

  • "disable"

  • "enable"

airtime-fairness

string

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

Choices:

  • "disable"

  • "enable"

amsdu

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

ap-handoff

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-addr

string

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

ap-sniffer-bufsize

integer

Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size

ap-sniffer-chan

integer

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

ap-sniffer-chan-width

string

Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer.

Choices:

  • "320MHz"

  • "240MHz"

  • "160MHz"

  • "80MHz"

  • "40MHz"

  • "20MHz"

ap-sniffer-ctl

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-data

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-beacon

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-other

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-probe

string

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

Choices:

  • "disable"

  • "enable"

arrp-profile

string

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

auto-power-high

integer

Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm

auto-power-level

string

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

Choices:

  • "disable"

  • "enable"

auto-power-low

integer

Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm

auto-power-target

string

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

band

string

WiFi band that Radio 2 operates on.

Choices:

  • "802.11b"

  • "802.11a"

  • "802.11g"

  • "802.11n"

  • "802.11ac"

  • "802.11n-5G"

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

string

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

Choices:

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth-admission-control

string

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

Choices:

  • "disable"

  • "enable"

bandwidth-capacity

integer

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

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Beacon interval.

bss-color

integer

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

bss-color-mode

string

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

Choices:

  • "auto"

  • "static"

call-admission-control

string

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

Choices:

  • "disable"

  • "enable"

call-capacity

integer

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

channel

any

(list) Selected list of wireless radio channels.

channel-bonding

string

Deprecated, please rename it to channel_bonding. Channel bandwidth

Choices:

  • "disable"

  • "enable"

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

  • "320MHz"

  • "240MHz"

channel-bonding-ext

string

Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension

Choices:

  • "320MHz-1"

  • "320MHz-2"

channel-utilization

string

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

Choices:

  • "disable"

  • "enable"

coexistence

string

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

Choices:

  • "disable"

  • "enable"

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning

Choices:

  • "disable"

  • "enable"

drma

string

Enable/disable dynamic radio mode assignment

Choices:

  • "disable"

  • "enable"

drma-sensitivity

string

Deprecated, please rename it to drma_sensitivity. Network Coverage Factor

Choices:

  • "low"

  • "medium"

  • "high"

dtim

integer

Delivery Traffic Indication Map

frag-threshold

integer

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

frequency-handoff

string

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

Choices:

  • "disable"

  • "enable"

iperf-protocol

string

Deprecated, please rename it to iperf_protocol. Iperf test protocol

Choices:

  • "udp"

  • "tcp"

iperf-server-port

integer

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

max-clients

integer

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

max-distance

integer

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

mimo-mode

string

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

Choices:

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

string

Mode of radio 2.

Choices:

  • "disabled"

  • "ap"

  • "monitor"

  • "sniffer"

  • "sam"

optional-antenna

string

Deprecated, please rename it to optional_antenna. Optional antenna used on FAP

Choices:

  • "none"

  • "FANT-04ABGN-0606-O-N"

  • "FANT-04ABGN-1414-P-N"

  • "FANT-04ABGN-8065-P-N"

  • "FANT-04ABGN-0606-O-R"

  • "FANT-04ABGN-0606-P-R"

  • "FANT-10ACAX-1213-D-N"

  • "FANT-08ABGN-1213-D-R"

  • "custom"

optional-antenna-gain

string

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

power-level

integer

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

power-mode

string

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

Choices:

  • "dBm"

  • "percentage"

power-value

integer

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

powersave-optimize

list / elements=string

Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB…

Choices:

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection-mode

string

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

Choices:

  • "rtscts"

  • "ctsonly"

  • "disable"

radio-id

integer

Deprecated, please rename it to radio_id. Radio id.

rts-threshold

integer

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

sam-bssid

string

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

sam-ca-certificate

string

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

sam-captive-portal

string

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

Choices:

  • "disable"

  • "enable"

sam-client-certificate

string

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

sam-cwp-failure-string

string

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

sam-cwp-match-string

string

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

sam-cwp-password

any

(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication.

sam-cwp-success-string

string

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

sam-cwp-test-url

string

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

sam-cwp-username

string

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

sam-eap-method

string

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

Choices:

  • "tls"

  • "peap"

  • "both"

sam-password

any

(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection.

sam-private-key

string

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

sam-private-key-password

any

(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER…

sam-report-intv

integer

Deprecated, please rename it to sam_report_intv. SAM report interval

sam-security-type

string

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

Choices:

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam-server

string

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

sam-server-fqdn

string

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

sam-server-ip

string

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

sam-server-type

string

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

Choices:

  • "ip"

  • "fqdn"

sam-ssid

string

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

sam-test

string

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

Choices:

  • "ping"

  • "iperf"

sam-username

string

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

short-guard-interval

string

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

Choices:

  • "disable"

  • "enable"

spectrum-analysis

string

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

Choices:

  • "disable"

  • "enable"

  • "scan-only"

transmit-optimize

list / elements=string

Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving…

Choices:

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap-all

string

Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP

Choices:

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

vap1

string

Virtual Access Point

vap2

string

Virtual Access Point

vap3

string

Virtual Access Point

vap4

string

Virtual Access Point

vap5

string

Virtual Access Point

vap6

string

Virtual Access Point

vap7

string

Virtual Access Point

vap8

string

Virtual Access Point

vaps

any

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

wids-profile

string

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

zero-wait-dfs

string

Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio

Choices:

  • "disable"

  • "enable"

radio-3

dictionary

Deprecated, please rename it to radio_3. Radio 3.

80211d

string

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

Choices:

  • "disable"

  • "enable"

80211mc

string

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

Choices:

  • "disable"

  • "enable"

airtime-fairness

string

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

Choices:

  • "disable"

  • "enable"

amsdu

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

ap-handoff

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-addr

string

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

ap-sniffer-bufsize

integer

Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size

ap-sniffer-chan

integer

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

ap-sniffer-chan-width

string

Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer.

Choices:

  • "320MHz"

  • "240MHz"

  • "160MHz"

  • "80MHz"

  • "40MHz"

  • "20MHz"

ap-sniffer-ctl

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-data

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-beacon

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-other

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-probe

string

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

Choices:

  • "disable"

  • "enable"

arrp-profile

string

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

auto-power-high

integer

Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm

auto-power-level

string

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

Choices:

  • "disable"

  • "enable"

auto-power-low

integer

Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm

auto-power-target

string

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

band

string

WiFi band that Radio 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

string

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

Choices:

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth-admission-control

string

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

Choices:

  • "disable"

  • "enable"

bandwidth-capacity

integer

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

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Beacon interval.

bss-color

integer

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

bss-color-mode

string

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

Choices:

  • "auto"

  • "static"

call-admission-control

string

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

Choices:

  • "disable"

  • "enable"

call-capacity

integer

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

channel

any

(list) Selected list of wireless radio channels.

channel-bonding

string

Deprecated, please rename it to channel_bonding. Channel bandwidth

Choices:

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

  • "320MHz"

  • "240MHz"

channel-bonding-ext

string

Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension

Choices:

  • "320MHz-1"

  • "320MHz-2"

channel-utilization

string

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

Choices:

  • "disable"

  • "enable"

coexistence

string

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

Choices:

  • "disable"

  • "enable"

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning

Choices:

  • "disable"

  • "enable"

drma

string

Enable/disable dynamic radio mode assignment

Choices:

  • "disable"

  • "enable"

drma-sensitivity

string

Deprecated, please rename it to drma_sensitivity. Network Coverage Factor

Choices:

  • "low"

  • "medium"

  • "high"

dtim

integer

Delivery Traffic Indication Map

frag-threshold

integer

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

frequency-handoff

string

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

Choices:

  • "disable"

  • "enable"

iperf-protocol

string

Deprecated, please rename it to iperf_protocol. Iperf test protocol

Choices:

  • "udp"

  • "tcp"

iperf-server-port

integer

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

max-clients

integer

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

max-distance

integer

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

mimo-mode

string

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

Choices:

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

string

Mode of radio 3.

Choices:

  • "disabled"

  • "ap"

  • "monitor"

  • "sniffer"

  • "sam"

optional-antenna

string

Deprecated, please rename it to optional_antenna. Optional antenna used on FAP

Choices:

  • "none"

  • "FANT-04ABGN-0606-O-N"

  • "FANT-04ABGN-1414-P-N"

  • "FANT-04ABGN-8065-P-N"

  • "FANT-04ABGN-0606-O-R"

  • "FANT-04ABGN-0606-P-R"

  • "FANT-10ACAX-1213-D-N"

  • "FANT-08ABGN-1213-D-R"

  • "custom"

optional-antenna-gain

string

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

power-level

integer

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

power-mode

string

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

Choices:

  • "dBm"

  • "percentage"

power-value

integer

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

powersave-optimize

list / elements=string

Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB…

Choices:

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection-mode

string

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

Choices:

  • "rtscts"

  • "ctsonly"

  • "disable"

radio-id

integer

Deprecated, please rename it to radio_id. Radio id.

rts-threshold

integer

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

sam-bssid

string

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

sam-ca-certificate

string

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

sam-captive-portal

string

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

Choices:

  • "disable"

  • "enable"

sam-client-certificate

string

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

sam-cwp-failure-string

string

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

sam-cwp-match-string

string

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

sam-cwp-password

any

(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication.

sam-cwp-success-string

string

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

sam-cwp-test-url

string

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

sam-cwp-username

string

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

sam-eap-method

string

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

Choices:

  • "tls"

  • "peap"

  • "both"

sam-password

any

(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection.

sam-private-key

string

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

sam-private-key-password

any

(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER…

sam-report-intv

integer

Deprecated, please rename it to sam_report_intv. SAM report interval

sam-security-type

string

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

Choices:

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam-server

string

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

sam-server-fqdn

string

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

sam-server-ip

string

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

sam-server-type

string

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

Choices:

  • "ip"

  • "fqdn"

sam-ssid

string

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

sam-test

string

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

Choices:

  • "ping"

  • "iperf"

sam-username

string

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

short-guard-interval

string

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

Choices:

  • "disable"

  • "enable"

spectrum-analysis

string

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

Choices:

  • "disable"

  • "enable"

  • "scan-only"

transmit-optimize

list / elements=string

Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving…

Choices:

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap-all

string

Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP

Choices:

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

vap1

string

Virtual Access Point

vap2

string

Virtual Access Point

vap3

string

Virtual Access Point

vap4

string

Virtual Access Point

vap5

string

Virtual Access Point

vap6

string

Virtual Access Point

vap7

string

Virtual Access Point

vap8

string

Virtual Access Point

vaps

any

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

wids-profile

string

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

zero-wait-dfs

string

Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio

Choices:

  • "disable"

  • "enable"

radio-4

dictionary

Deprecated, please rename it to radio_4. Radio 4.

80211d

string

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

Choices:

  • "disable"

  • "enable"

80211mc

string

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

Choices:

  • "disable"

  • "enable"

airtime-fairness

string

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

Choices:

  • "disable"

  • "enable"

amsdu

string

Enable/disable 802.

Choices:

  • "disable"

  • "enable"

ap-handoff

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-addr

string

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

ap-sniffer-bufsize

integer

Deprecated, please rename it to ap_sniffer_bufsize. Sniffer buffer size

ap-sniffer-chan

integer

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

ap-sniffer-chan-width

string

Deprecated, please rename it to ap_sniffer_chan_width. Channel bandwidth for sniffer.

Choices:

  • "320MHz"

  • "240MHz"

  • "160MHz"

  • "80MHz"

  • "40MHz"

  • "20MHz"

ap-sniffer-ctl

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-data

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-beacon

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-other

string

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

Choices:

  • "disable"

  • "enable"

ap-sniffer-mgmt-probe

string

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

Choices:

  • "disable"

  • "enable"

arrp-profile

string

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

auto-power-high

integer

Deprecated, please rename it to auto_power_high. The upper bound of automatic transmit power adjustment in dBm

auto-power-level

string

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

Choices:

  • "disable"

  • "enable"

auto-power-low

integer

Deprecated, please rename it to auto_power_low. The lower bound of automatic transmit power adjustment in dBm

auto-power-target

string

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

band

string

WiFi band that Radio 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

string

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

Choices:

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth-admission-control

string

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

Choices:

  • "disable"

  • "enable"

bandwidth-capacity

integer

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

beacon-interval

integer

Deprecated, please rename it to beacon_interval. Beacon interval.

bss-color

integer

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

bss-color-mode

string

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

Choices:

  • "auto"

  • "static"

call-admission-control

string

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

Choices:

  • "disable"

  • "enable"

call-capacity

integer

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

channel

any

(list) Selected list of wireless radio channels.

channel-bonding

string

Deprecated, please rename it to channel_bonding. Channel bandwidth

Choices:

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

  • "320MHz"

  • "240MHz"

channel-bonding-ext

string

Deprecated, please rename it to channel_bonding_ext. Channel bandwidth extension

Choices:

  • "320MHz-1"

  • "320MHz-2"

channel-utilization

string

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

Choices:

  • "disable"

  • "enable"

coexistence

string

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

Choices:

  • "disable"

  • "enable"

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning

Choices:

  • "disable"

  • "enable"

drma

string

Enable/disable dynamic radio mode assignment

Choices:

  • "disable"

  • "enable"

drma-sensitivity

string

Deprecated, please rename it to drma_sensitivity. Network Coverage Factor

Choices:

  • "low"

  • "medium"

  • "high"

dtim

integer

Delivery Traffic Indication Map

frag-threshold

integer

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

frequency-handoff

string

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

Choices:

  • "disable"

  • "enable"

iperf-protocol

string

Deprecated, please rename it to iperf_protocol. Iperf test protocol

Choices:

  • "udp"

  • "tcp"

iperf-server-port

integer

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

max-clients

integer

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

max-distance

integer

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

mimo-mode

string

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

Choices:

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

string

Mode of radio 3.

Choices:

  • "ap"

  • "monitor"

  • "sniffer"

  • "disabled"

  • "sam"

optional-antenna

string

Deprecated, please rename it to optional_antenna. Optional antenna used on FAP

Choices:

  • "none"

  • "FANT-04ABGN-0606-O-N"

  • "FANT-04ABGN-1414-P-N"

  • "FANT-04ABGN-8065-P-N"

  • "FANT-04ABGN-0606-O-R"

  • "FANT-04ABGN-0606-P-R"

  • "FANT-10ACAX-1213-D-N"

  • "FANT-08ABGN-1213-D-R"

  • "custom"

optional-antenna-gain

string

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

power-level

integer

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

power-mode

string

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

Choices:

  • "dBm"

  • "percentage"

power-value

integer

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

powersave-optimize

list / elements=string

Deprecated, please rename it to powersave_optimize. Enable client power-saving features such as TIM, AC VO, and OB…

Choices:

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection-mode

string

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

Choices:

  • "rtscts"

  • "ctsonly"

  • "disable"

radio-id

integer

Deprecated, please rename it to radio_id. Radio id.

rts-threshold

integer

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

sam-bssid

string

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

sam-ca-certificate

string

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

sam-captive-portal

string

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

Choices:

  • "disable"

  • "enable"

sam-client-certificate

string

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

sam-cwp-failure-string

string

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

sam-cwp-match-string

string

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

sam-cwp-password

any

(list) Deprecated, please rename it to sam_cwp_password. Password for captive portal authentication.

sam-cwp-success-string

string

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

sam-cwp-test-url

string

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

sam-cwp-username

string

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

sam-eap-method

string

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

Choices:

  • "tls"

  • "peap"

  • "both"

sam-password

any

(list) Deprecated, please rename it to sam_password. Passphrase for WiFi network connection.

sam-private-key

string

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

sam-private-key-password

any

(list) Deprecated, please rename it to sam_private_key_password. Password for private key file for WPA2/WPA3-ENTER…

sam-report-intv

integer

Deprecated, please rename it to sam_report_intv. SAM report interval

sam-security-type

string

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

Choices:

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam-server

string

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

sam-server-fqdn

string

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

sam-server-ip

string

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

sam-server-type

string

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

Choices:

  • "ip"

  • "fqdn"

sam-ssid

string

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

sam-test

string

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

Choices:

  • "ping"

  • "iperf"

sam-username

string

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

short-guard-interval

string

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

Choices:

  • "disable"

  • "enable"

spectrum-analysis

string

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

Choices:

  • "disable"

  • "enable"

  • "scan-only"

transmit-optimize

list / elements=string

Deprecated, please rename it to transmit_optimize. Packet transmission optimization options including power saving…

Choices:

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap-all

string

Deprecated, please rename it to vap_all. Configure method for assigning SSIDs to this FortiAP

Choices:

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

vap1

string

Virtual Access Point

vap2

string

Virtual Access Point

vap3

string

Virtual Access Point

vap4

string

Virtual Access Point

vap5

string

Virtual Access Point

vap6

string

Virtual Access Point

vap7

string

Virtual Access Point

vap8

string

Virtual Access Point

vaps

any

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

wids-profile

string

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

zero-wait-dfs

string

Deprecated, please rename it to zero_wait_dfs. Enable/disable zero wait DFS on radio

Choices:

  • "disable"

  • "enable"

snmp

string

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

Choices:

  • "disable"

  • "enable"

split-tunneling-acl

list / elements=dictionary

Deprecated, please rename it to split_tunneling_acl. Split tunneling acl.

dest-ip

string

Deprecated, please rename it to dest_ip. Destination IP and mask for the split-tunneling subnet.

id

integer

ID.

split-tunneling-acl-local-ap-subnet

string

Deprecated, please rename it to split_tunneling_acl_local_ap_subnet. Enable/disable automatically adding local subnetwork …

Choices:

  • "disable"

  • "enable"

split-tunneling-acl-path

string

Deprecated, please rename it to split_tunneling_acl_path. Split tunneling ACL path is local/tunnel.

Choices:

  • "tunnel"

  • "local"

syslog-profile

string

Deprecated, please rename it to syslog_profile. System log server configuration profile name.

integer

Deprecated, please rename it to tun_mtu_downlink. Downlink CAPWAP tunnel MTU

integer

Deprecated, please rename it to tun_mtu_uplink. Uplink CAPWAP tunnel MTU

unii-4-5ghz-band

string

Deprecated, please rename it to unii_4_5ghz_band. Enable/disable UNII-4 5Ghz band channels

Choices:

  • "disable"

  • "enable"

usb-port

string

Deprecated, please rename it to usb_port. Enable/disable USB port of the WTP

Choices:

  • "disable"

  • "enable"

wan-port-auth

string

Deprecated, please rename it to wan_port_auth. Set WAN port authentication mode

Choices:

  • "none"

  • "802.1x"

wan-port-auth-macsec

string

Deprecated, please rename it to wan_port_auth_macsec. Enable/disable WAN port 802.

Choices:

  • "disable"

  • "enable"

wan-port-auth-methods

string

Deprecated, please rename it to wan_port_auth_methods. WAN port 802.

Choices:

  • "all"

  • "EAP-FAST"

  • "EAP-TLS"

  • "EAP-PEAP"

wan-port-auth-password

any

(list) Deprecated, please rename it to wan_port_auth_password. Set WAN port 802.

wan-port-auth-usrname

string

Deprecated, please rename it to wan_port_auth_usrname. Set WAN port 802.

wan-port-mode

string

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