fortinet.fortios.fortios_wireless_controller_wtp_profile – Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_wtp_profile.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wtp_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

state

string / required

Indicates whether to create or remove the object.

Choices:

  • present

  • absent

vdom

string

Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Default: “root”

wireless_controller_wtp_profile

dictionary

Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.

allowaccess

list / elements=string

Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space.

Choices:

  • telnet

  • http

  • https

  • ssh

  • snmp

ap_country

string

Country in which this WTP, FortiAP or AP will operate .

Choices:

  • NA

  • AL

  • DZ

  • AO

  • AR

  • AM

  • AU

  • AT

  • AZ

  • BH

  • BD

  • BB

  • BY

  • BE

  • BZ

  • BO

  • BA

  • BR

  • BN

  • BG

  • KH

  • CL

  • CN

  • CO

  • CR

  • HR

  • CY

  • CZ

  • DK

  • DO

  • EC

  • EG

  • SV

  • EE

  • FI

  • FR

  • GE

  • DE

  • GR

  • GL

  • GD

  • GU

  • GT

  • HT

  • HN

  • HK

  • HU

  • IS

  • IN

  • ID

  • IR

  • IE

  • IL

  • IT

  • JM

  • JO

  • KZ

  • KE

  • KP

  • KR

  • KW

  • LV

  • LB

  • LI

  • LT

  • LU

  • MO

  • MK

  • MY

  • MT

  • MX

  • MC

  • MA

  • MZ

  • MM

  • NP

  • NL

  • AN

  • AW

  • NZ

  • False

  • OM

  • PK

  • PA

  • PG

  • PY

  • PE

  • PH

  • PL

  • PT

  • PR

  • QA

  • RO

  • RU

  • RW

  • SA

  • RS

  • ME

  • SG

  • SK

  • SI

  • ZA

  • ES

  • LK

  • SE

  • SD

  • CH

  • SY

  • TW

  • TZ

  • TH

  • TT

  • TN

  • TR

  • AE

  • UA

  • GB

  • US

  • PS

  • UY

  • UZ

  • VE

  • VN

  • YE

  • ZB

  • ZW

  • JP

  • CA

  • CF

  • BS

  • BF

  • KY

  • CX

  • GH

  • GY

  • CI

  • MW

  • MV

  • FM

  • KN

  • LC

  • VC

  • SN

  • TM

  • TC

  • UG

  • VU

  • AF

  • AS

  • BJ

  • BM

  • BT

  • BW

  • CM

  • TD

  • CG

  • CD

  • DM

  • ET

  • GF

  • PF

  • FO

  • FJ

  • GI

  • GP

  • IQ

  • IM

  • LA

  • LS

  • LY

  • MG

  • ML

  • MH

  • MQ

  • MR

  • MU

  • YT

  • MD

  • NI

  • NE

  • MP

  • PW

  • RE

  • BL

  • MF

  • PM

  • SL

  • SR

  • TG

  • VI

  • WF

  • ZM

ap_handoff

string

Enable/disable AP handoff of clients to other APs .

Choices:

  • enable

  • disable

apcfg_profile

string

AP local configuration profile name. Source wireless-controller.apcfg-profile.name.

ble_profile

string

Bluetooth Low Energy profile name. Source wireless-controller.ble-profile.name.

comment

string

Comment.

console_login

string

Enable/disable FAP console login access .

Choices:

  • enable

  • disable

control_message_offload

list / elements=string

Enable/disable CAPWAP control message data channel offload.

Choices:

  • ebp-frame

  • aeroscout-tag

  • ap-list

  • sta-list

  • sta-cap-list

  • stats

  • aeroscout-mu

  • sta-health

  • spectral-analysis

deny_mac_list

list / elements=string

List of MAC addresses that are denied access to this WTP, FortiAP, or AP.

id

integer / required

ID.

mac

string

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

dtls_in_kernel

string

Enable/disable data channel DTLS in kernel.

Choices:

  • enable

  • disable

dtls_policy

list / elements=string

WTP data channel DTLS policy .

Choices:

  • clear-text

  • dtls-enabled

  • ipsec-vpn

energy_efficient_ethernet

string

Enable/disable use of energy efficient Ethernet on WTP.

Choices:

  • enable

  • disable

esl_ses_dongle

dictionary

ESL SES-imagotag dongle configuration.

apc_addr_type

string

ESL SES-imagotag APC address type .

Choices:

  • fqdn

  • ip

apc_fqdn

string

FQDN of ESL SES-imagotag Access Point Controller (APC).

apc_ip

string

IP address of ESL SES-imagotag Access Point Controller (APC).

apc_port

integer

Port of ESL SES-imagotag Access Point Controller (APC).

coex_level

string

ESL SES-imagotag dongle coexistence level .

Choices:

  • none

compliance_level

string

Compliance levels for the ESL solution integration .

Choices:

  • compliance-level-2

esl_channel

string

ESL SES-imagotag dongle channel .

Choices:

  • -1

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 127

output_power

string

ESL SES-imagotag dongle output power .

Choices:

  • a

  • b

  • c

  • d

  • e

  • f

  • g

  • h

scd_enable

string

Enable/disable ESL SES-imagotag Serial Communication Daemon (SCD) .

Choices:

  • enable

  • disable

tls_cert_verification

string

Enable/disable TLS Certificate verification. .

Choices:

  • enable

  • disable

tls_fqdn_verification

string

Enable/disable TLS Certificate verification. .

Choices:

  • enable

  • disable

ext_info_enable

string

Enable/disable station/VAP/radio extension information.

Choices:

  • enable

  • disable

frequency_handoff

string

Enable/disable frequency handoff of clients to other channels .

Choices:

  • enable

  • disable

handoff_roaming

string

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

Choices:

  • enable

  • disable

handoff_rssi

integer

Minimum received signal strength indicator (RSSI) value for handoff (20 - 30).

handoff_sta_thresh

integer

Threshold value for AP handoff.

indoor_outdoor_deployment

string

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

Choices:

  • platform-determined

  • outdoor

  • indoor

ip_fragment_preventing

list / elements=string

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

Choices:

  • tcp-mss-adjust

  • icmp-unreachable

lan

dictionary

WTP LAN port mapping.

port1_mode

string

LAN port 1 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port1_ssid

string

Bridge LAN port 1 to SSID. Source wireless-controller.vap.name.

port2_mode

string

LAN port 2 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port2_ssid

string

Bridge LAN port 2 to SSID. Source wireless-controller.vap.name.

port3_mode

string

LAN port 3 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port3_ssid

string

Bridge LAN port 3 to SSID. Source wireless-controller.vap.name.

port4_mode

string

LAN port 4 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port4_ssid

string

Bridge LAN port 4 to SSID. Source wireless-controller.vap.name.

port5_mode

string

LAN port 5 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port5_ssid

string

Bridge LAN port 5 to SSID. Source wireless-controller.vap.name.

port6_mode

string

LAN port 6 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port6_ssid

string

Bridge LAN port 6 to SSID. Source wireless-controller.vap.name.

port7_mode

string

LAN port 7 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port7_ssid

string

Bridge LAN port 7 to SSID. Source wireless-controller.vap.name.

port8_mode

string

LAN port 8 mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port8_ssid

string

Bridge LAN port 8 to SSID. Source wireless-controller.vap.name.

port_esl_mode

string

ESL port mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port_esl_ssid

string

Bridge ESL port to SSID. Source system.interface.name.

port_mode

string

LAN port mode.

Choices:

  • offline

  • nat-to-wan

  • bridge-to-wan

  • bridge-to-ssid

port_ssid

string

Bridge LAN port to SSID. Source wireless-controller.vap.name.

lbs

dictionary

Set various location based service (LBS) options.

aeroscout

string

Enable/disable AeroScout Real Time Location Service (RTLS) support .

Choices:

  • enable

  • disable

aeroscout_ap_mac

string

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

Choices:

  • bssid

  • board-mac

aeroscout_mmu_report

string

Enable/disable compounded AeroScout tag and MU report .

Choices:

  • enable

  • disable

aeroscout_mu

string

Enable/disable AeroScout Mobile Unit (MU) support .

Choices:

  • enable

  • disable

aeroscout_mu_factor

integer

AeroScout MU mode dilution factor .

aeroscout_mu_timeout

integer

AeroScout MU mode timeout (0 - 65535 sec).

aeroscout_server_ip

string

IP address of AeroScout server.

aeroscout_server_port

integer

AeroScout server UDP listening port.

string

Enable/disable Ekahau blink mode (now known as AiRISTA Flow) to track and locate WiFi tags .

Choices:

  • enable

  • disable

ekahau_tag

string

WiFi frame MAC address or WiFi Tag.

erc_server_ip

string

IP address of Ekahau RTLS Controller (ERC).

erc_server_port

integer

Ekahau RTLS Controller (ERC) UDP listening port.

fortipresence

string

Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they don”t connect to this WiFi network .

Choices:

  • foreign

  • both

  • disable

fortipresence_ble

string

Enable/disable FortiPresence finding and reporting BLE devices.

Choices:

  • enable

  • disable

fortipresence_frequency

integer

FortiPresence report transmit frequency (5 - 65535 sec).

fortipresence_port

integer

FortiPresence server UDP listening port .

fortipresence_project

string

FortiPresence project name (max. 16 characters).

fortipresence_rogue

string

Enable/disable FortiPresence finding and reporting rogue APs.

Choices:

  • enable

  • disable

fortipresence_secret

string

FortiPresence secret password (max. 16 characters).

fortipresence_server

string

FortiPresence server IP address.

fortipresence_unassoc

string

Enable/disable FortiPresence finding and reporting unassociated stations.

Choices:

  • enable

  • disable

station_locate

string

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

Choices:

  • enable

  • disable

led_schedules

list / elements=string

Recurring firewall schedules for illuminating LEDs on the FortiAP. If led-state is enabled, LEDs will be visible when at least one of the schedules is valid. Separate multiple schedule names with a space.

name

string / required

LED schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name.

led_state

string

Enable/disable use of LEDs on WTP .

Choices:

  • enable

  • disable

lldp

string

Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP .

Choices:

  • enable

  • disable

login_passwd

string

Set the managed WTP, FortiAP, or AP”s administrator password.

login_passwd_change

string

Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no).

Choices:

  • True

  • default

  • False

max_clients

integer

Maximum number of stations (STAs) supported by the WTP .

name

string / required

WTP (or FortiAP or AP) profile name.

platform

dictionary

WTP, FortiAP, or AP platform.

ddscan

string

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

Choices:

  • enable

  • disable

mode

string

Configure operation mode of 5G radios .

Choices:

  • single-5G

  • dual-5G

type

string

WTP, FortiAP or AP platform type. There are built-in WTP profiles for all supported FortiAP models. You can select a built-in profile and customize it or create a new profile.

Choices:

  • AP-11N

  • 220B

  • 210B

  • 222B

  • 112B

  • 320B

  • 11C

  • 14C

  • 223B

  • 28C

  • 320C

  • 221C

  • 25D

  • 222C

  • 224D

  • 214B

  • 21D

  • 24D

  • 112D

  • 223C

  • 321C

  • C220C

  • C225C

  • C23JD

  • C24JE

  • S321C

  • S322C

  • S323C

  • S311C

  • S313C

  • S321CR

  • S322CR

  • S323CR

  • S421E

  • S422E

  • S423E

  • 421E

  • 423E

  • 221E

  • 222E

  • 223E

  • 224E

  • S221E

  • S223E

  • U421E

  • U422EV

  • U423E

  • U221EV

  • U223EV

  • U24JEV

  • U321EV

  • U323EV

  • 231E

  • 321E

  • 431F

  • 432F

  • 433F

  • 231F

  • 234F

  • 23JF

  • U431F

  • U433F

  • 831F

  • U231F

  • U234F

  • U432F

poe_mode

string

Set the WTP, FortiAP, or AP”s PoE mode.

Choices:

  • auto

  • 8023af

  • 8023at

  • power-adapter

  • full

  • high

  • low

radio_1

dictionary

Configuration options for radio 1.

airtime_fairness

string

Enable/disable airtime fairness .

Choices:

  • enable

  • disable

amsdu

string

Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients .

Choices:

  • enable

  • disable

ap_handoff

string

Enable/disable AP handoff of clients to other APs .

Choices:

  • enable

  • disable

ap_sniffer_addr

string

MAC address to monitor.

ap_sniffer_bufsize

integer

Sniffer buffer size (1 - 32 MB).

ap_sniffer_chan

integer

Channel on which to operate the sniffer .

ap_sniffer_ctl

string

Enable/disable sniffer on WiFi control frame .

Choices:

  • enable

  • disable

ap_sniffer_data

string

Enable/disable sniffer on WiFi data frame .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_beacon

string

Enable/disable sniffer on WiFi management Beacon frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_other

string

Enable/disable sniffer on WiFi management other frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_probe

string

Enable/disable sniffer on WiFi management probe frames .

Choices:

  • enable

  • disable

auto_power_high

integer

Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_level

string

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

Choices:

  • enable

  • disable

auto_power_low

integer

Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_target

string

The target of automatic transmit power adjustment in dBm. (-95 to -20).

band

string

WiFi band that Radio 1 operates on.

Choices:

  • 802.11a

  • 802.11b

  • 802.11g

  • 802.11n

  • 802.11n-5G

  • 802.11ac

  • 802.11n,g-only

  • 802.11g-only

  • 802.11n-only

  • 802.11n-5G-only

  • 802.11ac,n-only

  • 802.11ac-only

  • 802.11ax-5G

  • 802.11ax

  • 802.11ax,ac-only

  • 802.11ax,ac,n-only

  • 802.11ax-5G-only

  • 802.11ax,n-only

  • 802.11ax,n,g-only

  • 802.11ax-only

  • 802.11ac-2G

band_5g_type

string

WiFi 5G band type.

Choices:

  • 5g-full

  • 5g-high

  • 5g-low

bandwidth_admission_control

string

Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it.

Choices:

  • enable

  • disable

bandwidth_capacity

integer

Maximum bandwidth capacity allowed (1 - 600000 Kbps).

beacon_interval

integer

Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type).

bss_color

integer

BSS color value for this 11ax radio (0 - 63, 0 means disable. ).

call_admission_control

string

Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them.

Choices:

  • enable

  • disable

call_capacity

integer

Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60).

channel

list / elements=string

Selected list of wireless radio channels.

chan

string / required

Channel number.

channel_bonding

string

Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.

Choices:

  • 80MHz

  • 40MHz

  • 20MHz

  • 160MHz

channel_utilization

string

Enable/disable measuring channel utilization.

Choices:

  • enable

  • disable

coexistence

string

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

Choices:

  • enable

  • disable

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel .

Choices:

  • enable

  • disable

drma

string

Enable/disable dynamic radio mode assignment (DRMA) .

Choices:

  • disable

  • enable

drma_sensitivity

string

Network Coverage Factor (NCF) percentage required to consider a radio as redundant .

Choices:

  • low

  • medium

  • high

dtim

integer

DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255). Set higher to save client battery life.

frag_threshold

integer

Maximum packet size that can be sent without fragmentation (800 - 2346 bytes).

frequency_handoff

string

Enable/disable frequency handoff of clients to other channels .

Choices:

  • enable

  • disable

iperf_protocol

string

Iperf test protocol .

Choices:

  • udp

  • tcp

iperf_server_port

integer

Iperf service port number.

max_clients

integer

Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.

max_distance

integer

Maximum expected distance between the AP and clients (0 - 54000 m).

mode

string

Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.

Choices:

  • disabled

  • ap

  • monitor

  • sniffer

  • sam

power_level

integer

Radio power level as a percentage of the maximum transmit power (0 - 100).

power_mode

string

Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities.

Choices:

  • dBm

  • percentage

power_value

integer

Radio EIRP power in dBm (1 - 33).

powersave_optimize

string

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

Choices:

  • tim

  • ac-vo

  • no-obss-scan

  • no-11b-rate

  • client-rate-follow

protection_mode

string

Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).

Choices:

  • rtscts

  • ctsonly

  • disable

radio_id

integer

radio-id

rts_threshold

integer

Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes).

sam_bssid

string

BSSID for WiFi network.

sam_captive_portal

string

Enable/disable Captive Portal Authentication .

Choices:

  • enable

  • disable

sam_cwp_failure_string

string

Failure identification on the page after an incorrect login.

sam_cwp_match_string

string

Identification string from the captive portal login form.

sam_cwp_password

string

Password for captive portal authentication.

sam_cwp_success_string

string

Success identification on the page after a successful login.

sam_cwp_test_url

string

Website the client is trying to access.

sam_cwp_username

string

Username for captive portal authentication.

sam_password

string

Passphrase for WiFi network connection.

sam_report_intv

integer

SAM report interval (sec), 0 for a one-time report.

sam_security_type

string

Select WiFi network security type .

Choices:

  • open

  • wpa-personal

  • wpa-enterprise

sam_server

string

SAM test server IP address or domain name.

sam_server_fqdn

string

SAM test server domain name.

sam_server_ip

string

SAM test server IP address.

sam_server_type

string

Select SAM server type .

Choices:

  • ip

  • fqdn

sam_ssid

string

SSID for WiFi network.

sam_test

string

Select SAM test type .

Choices:

  • ping

  • iperf

sam_username

string

Username for WiFi network connection.

short_guard_interval

string

Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.

Choices:

  • enable

  • disable

spectrum_analysis

string

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

Choices:

  • enable

  • disable

  • scan-only

transmit_optimize

string

Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default.

Choices:

  • disable

  • power-save

  • aggr-limit

  • retry-limit

  • send-bar

vap_all

string

Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) .

Choices:

  • enable

  • disable

  • tunnel

  • bridge

  • manual

vaps

list / elements=string

Manually selected list of Virtual Access Points (VAPs).

name

string / required

Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name wireless-controller.vap.name.

wids_profile

string

Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name.

zero_wait_dfs

string

Enable/disable zero wait DFS on radio .

Choices:

  • enable

  • disable

radio_2

dictionary

Configuration options for radio 2.

airtime_fairness

string

Enable/disable airtime fairness .

Choices:

  • enable

  • disable

amsdu

string

Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients .

Choices:

  • enable

  • disable

ap_handoff

string

Enable/disable AP handoff of clients to other APs .

Choices:

  • enable

  • disable

ap_sniffer_addr

string

MAC address to monitor.

ap_sniffer_bufsize

integer

Sniffer buffer size (1 - 32 MB).

ap_sniffer_chan

integer

Channel on which to operate the sniffer .

ap_sniffer_ctl

string

Enable/disable sniffer on WiFi control frame .

Choices:

  • enable

  • disable

ap_sniffer_data

string

Enable/disable sniffer on WiFi data frame .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_beacon

string

Enable/disable sniffer on WiFi management Beacon frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_other

string

Enable/disable sniffer on WiFi management other frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_probe

string

Enable/disable sniffer on WiFi management probe frames .

Choices:

  • enable

  • disable

auto_power_high

integer

Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_level

string

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

Choices:

  • enable

  • disable

auto_power_low

integer

Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_target

string

The target of automatic transmit power adjustment in dBm. (-95 to -20).

band

string

WiFi band that Radio 2 operates on.

Choices:

  • 802.11a

  • 802.11b

  • 802.11g

  • 802.11n

  • 802.11n-5G

  • 802.11ac

  • 802.11n,g-only

  • 802.11g-only

  • 802.11n-only

  • 802.11n-5G-only

  • 802.11ac,n-only

  • 802.11ac-only

  • 802.11ax-5G

  • 802.11ax

  • 802.11ax,ac-only

  • 802.11ax,ac,n-only

  • 802.11ax-5G-only

  • 802.11ax,n-only

  • 802.11ax,n,g-only

  • 802.11ax-only

  • 802.11ac-2G

band_5g_type

string

WiFi 5G band type.

Choices:

  • 5g-full

  • 5g-high

  • 5g-low

bandwidth_admission_control

string

Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it.

Choices:

  • enable

  • disable

bandwidth_capacity

integer

Maximum bandwidth capacity allowed (1 - 600000 Kbps).

beacon_interval

integer

Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type).

bss_color

integer

BSS color value for this 11ax radio (0 - 63, 0 means disable. ).

call_admission_control

string

Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them.

Choices:

  • enable

  • disable

call_capacity

integer

Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60).

channel

list / elements=string

Selected list of wireless radio channels.

chan

string / required

Channel number.

channel_bonding

string

Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.

Choices:

  • 80MHz

  • 40MHz

  • 20MHz

  • 160MHz

channel_utilization

string

Enable/disable measuring channel utilization.

Choices:

  • enable

  • disable

coexistence

string

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

Choices:

  • enable

  • disable

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel .

Choices:

  • enable

  • disable

drma

string

Enable/disable dynamic radio mode assignment (DRMA) .

Choices:

  • disable

  • enable

drma_sensitivity

string

Network Coverage Factor (NCF) percentage required to consider a radio as redundant .

Choices:

  • low

  • medium

  • high

dtim

integer

DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255). Set higher to save client battery life.

frag_threshold

integer

Maximum packet size that can be sent without fragmentation (800 - 2346 bytes).

frequency_handoff

string

Enable/disable frequency handoff of clients to other channels .

Choices:

  • enable

  • disable

iperf_protocol

string

Iperf test protocol .

Choices:

  • udp

  • tcp

iperf_server_port

integer

Iperf service port number.

max_clients

integer

Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.

max_distance

integer

Maximum expected distance between the AP and clients (0 - 54000 m).

mode

string

Mode of radio 2. Radio 2 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.

Choices:

  • disabled

  • ap

  • monitor

  • sniffer

  • sam

power_level

integer

Radio power level as a percentage of the maximum transmit power (0 - 100).

power_mode

string

Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities.

Choices:

  • dBm

  • percentage

power_value

integer

Radio EIRP power in dBm (1 - 33).

powersave_optimize

string

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

Choices:

  • tim

  • ac-vo

  • no-obss-scan

  • no-11b-rate

  • client-rate-follow

protection_mode

string

Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).

Choices:

  • rtscts

  • ctsonly

  • disable

radio_id

integer

radio-id

rts_threshold

integer

Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes).

sam_bssid

string

BSSID for WiFi network.

sam_captive_portal

string

Enable/disable Captive Portal Authentication .

Choices:

  • enable

  • disable

sam_cwp_failure_string

string

Failure identification on the page after an incorrect login.

sam_cwp_match_string

string

Identification string from the captive portal login form.

sam_cwp_password

string

Password for captive portal authentication.

sam_cwp_success_string

string

Success identification on the page after a successful login.

sam_cwp_test_url

string

Website the client is trying to access.

sam_cwp_username

string

Username for captive portal authentication.

sam_password

string

Passphrase for WiFi network connection.

sam_report_intv

integer

SAM report interval (sec), 0 for a one-time report.

sam_security_type

string

Select WiFi network security type .

Choices:

  • open

  • wpa-personal

  • wpa-enterprise

sam_server

string

SAM test server IP address or domain name.

sam_server_fqdn

string

SAM test server domain name.

sam_server_ip

string

SAM test server IP address.

sam_server_type

string

Select SAM server type .

Choices:

  • ip

  • fqdn

sam_ssid

string

SSID for WiFi network.

sam_test

string

Select SAM test type .

Choices:

  • ping

  • iperf

sam_username

string

Username for WiFi network connection.

short_guard_interval

string

Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.

Choices:

  • enable

  • disable

spectrum_analysis

string

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

Choices:

  • enable

  • disable

  • scan-only

transmit_optimize

string

Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default.

Choices:

  • disable

  • power-save

  • aggr-limit

  • retry-limit

  • send-bar

vap_all

string

Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) .

Choices:

  • enable

  • disable

  • tunnel

  • bridge

  • manual

vaps

list / elements=string

Manually selected list of Virtual Access Points (VAPs).

name

string / required

Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name wireless-controller.vap.name.

wids_profile

string

Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name.

zero_wait_dfs

string

Enable/disable zero wait DFS on radio .

Choices:

  • enable

  • disable

radio_3

dictionary

Configuration options for radio 3.

airtime_fairness

string

Enable/disable airtime fairness .

Choices:

  • enable

  • disable

amsdu

string

Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients .

Choices:

  • enable

  • disable

ap_handoff

string

Enable/disable AP handoff of clients to other APs .

Choices:

  • enable

  • disable

ap_sniffer_addr

string

MAC address to monitor.

ap_sniffer_bufsize

integer

Sniffer buffer size (1 - 32 MB).

ap_sniffer_chan

integer

Channel on which to operate the sniffer .

ap_sniffer_ctl

string

Enable/disable sniffer on WiFi control frame .

Choices:

  • enable

  • disable

ap_sniffer_data

string

Enable/disable sniffer on WiFi data frame .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_beacon

string

Enable/disable sniffer on WiFi management Beacon frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_other

string

Enable/disable sniffer on WiFi management other frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_probe

string

Enable/disable sniffer on WiFi management probe frames .

Choices:

  • enable

  • disable

auto_power_high

integer

The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_level

string

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

Choices:

  • enable

  • disable

auto_power_low

integer

The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_target

string

The target of automatic transmit power adjustment in dBm. (-95 to -20).

band

string

WiFi band that Radio 3 operates on.

Choices:

  • 802.11a

  • 802.11b

  • 802.11g

  • 802.11n

  • 802.11n-5G

  • 802.11ac

  • 802.11ax-5G

  • 802.11ax

  • 802.11n,g-only

  • 802.11g-only

  • 802.11n-only

  • 802.11n-5G-only

  • 802.11ac,n-only

  • 802.11ac-only

  • 802.11ax,ac-only

  • 802.11ax,ac,n-only

  • 802.11ax-5G-only

  • 802.11ax,n-only

  • 802.11ax,n,g-only

  • 802.11ax-only

  • 802.11ac-2G

band_5g_type

string

WiFi 5G band type.

Choices:

  • 5g-full

  • 5g-high

  • 5g-low

bandwidth_admission_control

string

Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it.

Choices:

  • enable

  • disable

bandwidth_capacity

integer

Maximum bandwidth capacity allowed (1 - 600000 Kbps).

beacon_interval

integer

Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type).

bss_color

integer

BSS color value for this 11ax radio (0 - 63, 0 means disable. ).

call_admission_control

string

Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them.

Choices:

  • enable

  • disable

call_capacity

integer

Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60).

channel

list / elements=string

Selected list of wireless radio channels.

chan

string / required

Channel number.

channel_bonding

string

Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.

Choices:

  • 160MHz

  • 80MHz

  • 40MHz

  • 20MHz

channel_utilization

string

Enable/disable measuring channel utilization.

Choices:

  • enable

  • disable

coexistence

string

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

Choices:

  • enable

  • disable

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel .

Choices:

  • enable

  • disable

drma

string

Enable/disable dynamic radio mode assignment (DRMA) .

Choices:

  • disable

  • enable

drma_sensitivity

string

Network Coverage Factor (NCF) percentage required to consider a radio as redundant .

Choices:

  • low

  • medium

  • high

dtim

integer

Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode.

frag_threshold

integer

Maximum packet size that can be sent without fragmentation (800 - 2346 bytes).

frequency_handoff

string

Enable/disable frequency handoff of clients to other channels .

Choices:

  • enable

  • disable

iperf_protocol

string

Iperf test protocol .

Choices:

  • udp

  • tcp

iperf_server_port

integer

Iperf service port number.

max_clients

integer

Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.

max_distance

integer

Maximum expected distance between the AP and clients (0 - 54000 m).

mode

string

Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.

Choices:

  • disabled

  • ap

  • monitor

  • sniffer

  • sam

power_level

integer

Radio power level as a percentage of the maximum transmit power (0 - 100).

power_mode

string

Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities.

Choices:

  • dBm

  • percentage

power_value

integer

Radio EIRP power in dBm (1 - 33).

powersave_optimize

string

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

Choices:

  • tim

  • ac-vo

  • no-obss-scan

  • no-11b-rate

  • client-rate-follow

protection_mode

string

Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).

Choices:

  • rtscts

  • ctsonly

  • disable

radio_id

integer

radio-id

rts_threshold

integer

Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes).

sam_bssid

string

BSSID for WiFi network.

sam_captive_portal

string

Enable/disable Captive Portal Authentication .

Choices:

  • enable

  • disable

sam_cwp_failure_string

string

Failure identification on the page after an incorrect login.

sam_cwp_match_string

string

Identification string from the captive portal login form.

sam_cwp_password

string

Password for captive portal authentication.

sam_cwp_success_string

string

Success identification on the page after a successful login.

sam_cwp_test_url

string

Website the client is trying to access.

sam_cwp_username

string

Username for captive portal authentication.

sam_password

string

Passphrase for WiFi network connection.

sam_report_intv

integer

SAM report interval (sec), 0 for a one-time report.

sam_security_type

string

Select WiFi network security type .

Choices:

  • open

  • wpa-personal

  • wpa-enterprise

sam_server

string

SAM test server IP address or domain name.

sam_server_fqdn

string

SAM test server domain name.

sam_server_ip

string

SAM test server IP address.

sam_server_type

string

Select SAM server type .

Choices:

  • ip

  • fqdn

sam_ssid

string

SSID for WiFi network.

sam_test

string

Select SAM test type .

Choices:

  • ping

  • iperf

sam_username

string

Username for WiFi network connection.

short_guard_interval

string

Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.

Choices:

  • enable

  • disable

spectrum_analysis

string

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

Choices:

  • enable

  • disable

  • scan-only

transmit_optimize

string

Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default.

Choices:

  • disable

  • power-save

  • aggr-limit

  • retry-limit

  • send-bar

vap_all

string

Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) .

Choices:

  • enable

  • disable

  • tunnel

  • bridge

  • manual

vaps

list / elements=string

Manually selected list of Virtual Access Points (VAPs).

name

string / required

Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name.

wids_profile

string

Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name.

zero_wait_dfs

string

Enable/disable zero wait DFS on radio .

Choices:

  • enable

  • disable

radio_4

dictionary

Configuration options for radio 4.

airtime_fairness

string

Enable/disable airtime fairness .

Choices:

  • enable

  • disable

amsdu

string

Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients .

Choices:

  • enable

  • disable

ap_handoff

string

Enable/disable AP handoff of clients to other APs .

Choices:

  • enable

  • disable

ap_sniffer_addr

string

MAC address to monitor.

ap_sniffer_bufsize

integer

Sniffer buffer size (1 - 32 MB).

ap_sniffer_chan

integer

Channel on which to operate the sniffer .

ap_sniffer_ctl

string

Enable/disable sniffer on WiFi control frame .

Choices:

  • enable

  • disable

ap_sniffer_data

string

Enable/disable sniffer on WiFi data frame .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_beacon

string

Enable/disable sniffer on WiFi management Beacon frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_other

string

Enable/disable sniffer on WiFi management other frames .

Choices:

  • enable

  • disable

ap_sniffer_mgmt_probe

string

Enable/disable sniffer on WiFi management probe frames .

Choices:

  • enable

  • disable

auto_power_high

integer

The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_level

string

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

Choices:

  • enable

  • disable

auto_power_low

integer

The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type).

auto_power_target

string

The target of automatic transmit power adjustment in dBm. (-95 to -20).

band

string

WiFi band that Radio 3 operates on.

Choices:

  • 802.11a

  • 802.11b

  • 802.11g

  • 802.11n

  • 802.11n-5G

  • 802.11ac

  • 802.11ax-5G

  • 802.11ax

  • 802.11n,g-only

  • 802.11g-only

  • 802.11n-only

  • 802.11n-5G-only

  • 802.11ac,n-only

  • 802.11ac-only

  • 802.11ax,ac-only

  • 802.11ax,ac,n-only

  • 802.11ax-5G-only

  • 802.11ax,n-only

  • 802.11ax,n,g-only

  • 802.11ax-only

  • 802.11ac-2G

band_5g_type

string

WiFi 5G band type.

Choices:

  • 5g-full

  • 5g-high

  • 5g-low

bandwidth_admission_control

string

Enable/disable WiFi multimedia (WMM) bandwidth admission control to optimize WiFi bandwidth use. A request to join the wireless network is only allowed if the access point has enough bandwidth to support it.

Choices:

  • enable

  • disable

bandwidth_capacity

integer

Maximum bandwidth capacity allowed (1 - 600000 Kbps).

beacon_interval

integer

Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type).

bss_color

integer

BSS color value for this 11ax radio (0 - 63, 0 means disable. ).

call_admission_control

string

Enable/disable WiFi multimedia (WMM) call admission control to optimize WiFi bandwidth use for VoIP calls. New VoIP calls are only accepted if there is enough bandwidth available to support them.

Choices:

  • enable

  • disable

call_capacity

integer

Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60).

channel

list / elements=string

Selected list of wireless radio channels.

chan

string / required

Channel number.

channel_bonding

string

Channel bandwidth: 160,80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence.

Choices:

  • 160MHz

  • 80MHz

  • 40MHz

  • 20MHz

channel_utilization

string

Enable/disable measuring channel utilization.

Choices:

  • enable

  • disable

coexistence

string

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

Choices:

  • enable

  • disable

darrp

string

Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel .

Choices:

  • enable

  • disable

drma

string

Enable/disable dynamic radio mode assignment (DRMA) .

Choices:

  • disable

  • enable

drma_sensitivity

string

Network Coverage Factor (NCF) percentage required to consider a radio as redundant .

Choices:

  • low

  • medium

  • high

dtim

integer

Delivery Traffic Indication Map (DTIM) period (1 - 255). Set higher to save battery life of WiFi client in power-save mode.

frag_threshold

integer

Maximum packet size that can be sent without fragmentation (800 - 2346 bytes).

frequency_handoff

string

Enable/disable frequency handoff of clients to other channels .

Choices:

  • enable

  • disable

iperf_protocol

string

Iperf test protocol .

Choices:

  • udp

  • tcp

iperf_server_port

integer

Iperf service port number.

max_clients

integer

Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware.

max_distance

integer

Maximum expected distance between the AP and clients (0 - 54000 m).

mode

string

Mode of radio 3. Radio 3 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer.

Choices:

  • disabled

  • ap

  • monitor

  • sniffer

  • sam

power_level

integer

Radio power level as a percentage of the maximum transmit power (0 - 100).

power_mode

string

Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage of the maximum EIRP . This power takes into account both radio transmit power and antenna gain. Higher power level settings may be constrained by local regulatory requirements and AP capabilities.

Choices:

  • dBm

  • percentage

power_value

integer

Radio EIRP power in dBm (1 - 33).

powersave_optimize

string

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

Choices:

  • tim

  • ac-vo

  • no-obss-scan

  • no-11b-rate

  • client-rate-follow

protection_mode

string

Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable).

Choices:

  • rtscts

  • ctsonly

  • disable

rts_threshold

integer

Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes).

sam_bssid

string

BSSID for WiFi network.

sam_captive_portal

string

Enable/disable Captive Portal Authentication .

Choices:

  • enable

  • disable

sam_cwp_failure_string

string

Failure identification on the page after an incorrect login.

sam_cwp_match_string

string

Identification string from the captive portal login form.

sam_cwp_password

string

Password for captive portal authentication.

sam_cwp_success_string

string

Success identification on the page after a successful login.

sam_cwp_test_url

string

Website the client is trying to access.

sam_cwp_username

string

Username for captive portal authentication.

sam_password

string

Passphrase for WiFi network connection.

sam_report_intv

integer

SAM report interval (sec), 0 for a one-time report.

sam_security_type

string

Select WiFi network security type .

Choices:

  • open

  • wpa-personal

  • wpa-enterprise

sam_server

string

SAM test server IP address or domain name.

sam_server_fqdn

string

SAM test server domain name.

sam_server_ip

string

SAM test server IP address.

sam_server_type

string

Select SAM server type .

Choices:

  • ip

  • fqdn

sam_ssid

string

SSID for WiFi network.

sam_test

string

Select SAM test type .

Choices:

  • ping

  • iperf

sam_username

string

Username for WiFi network connection.

short_guard_interval

string

Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns.

Choices:

  • enable

  • disable

spectrum_analysis

string

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

Choices:

  • enable

  • disable

  • scan-only

transmit_optimize

string

Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default.

Choices:

  • disable

  • power-save

  • aggr-limit

  • retry-limit

  • send-bar

vap_all

string

Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) .

Choices:

  • enable

  • disable

  • tunnel

  • bridge

  • manual

vaps

list / elements=string

Manually selected list of Virtual Access Points (VAPs).

name

string / required

Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name.

wids_profile

string

Wireless Intrusion Detection System (WIDS) profile name to assign to the radio. Source wireless-controller.wids-profile.name.

zero_wait_dfs

string

Enable/disable zero wait DFS on radio .

Choices:

  • enable

  • disable

split_tunneling_acl

list / elements=string

Split tunneling ACL filter list.

dest_ip

string

Destination IP and mask for the split-tunneling subnet.

id

integer / required

ID.

split_tunneling_acl_local_ap_subnet

string

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

Choices:

  • enable

  • disable

split_tunneling_acl_path

string

Split tunneling ACL path is local/tunnel.

Choices:

  • tunnel

  • local

integer

Downlink CAPWAP tunnel MTU (0, 576, or 1500 bytes).

integer

Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes).

wan_port_mode

string

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

Choices:

  • wan-lan

  • wan-only

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_wireless_controller_wtp_profile
    fortios_wireless_controller_wtp_profile:
      vdom: root
      state: present
      wireless_controller_wtp_profile:
        ap_country: NA
        ap_handoff: disable
        control_message_offload: ebp-frame
        dtls_in_kernel: disable
        dtls_policy: clear-text
        energy_efficient_ethernet: disable
        ext_info_enable: enable
        frequency_handoff: disable
        handoff_roaming: enable
        handoff_rssi: 25
        handoff_sta_thresh: 55
        ip_fragment_preventing: tcp-mss-adjust
        led_state: enable
        lldp: enable
        login_passwd_change: 'no'
        max_clients: 0
        name: terr-test-rdmstr
        poe_mode: auto
        split_tunneling_acl_local_ap_subnet: disable
        split_tunneling_acl_path: local
        tun_mtu_downlink: 576
        tun_mtu_uplink: 576
        wan_port_mode: wan-only

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)