:source: fortios_wireless_controller_vap.py
:orphan:
.. fortios_wireless_controller_vap:
fortios_wireless_controller_vap -- Configure Virtual Access Points (VAPs) in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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 vap 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.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_vap - Configure Virtual Access Points (VAPs). type: dict
more...
| Supported Version Ranges |
| wireless_controller_vap |
v6.0.0 -> 7.6.6 |
- access_control_list - Profile name for access-control-list. Source wireless-controller.access-control-list.name. type: str
more...
|
Supported Version Ranges |
| access_control_list |
v6.4.0 -> 7.6.6 |
- acct_interim_interval - WiFi RADIUS accounting interim interval (60 - 86400 sec). type: int
more...
|
Supported Version Ranges |
| acct_interim_interval |
v6.0.0 -> v6.2.7 |
- additional_akms - Additional AKMs. type: list choices: akm6, akm24
more...
|
Supported Version Ranges |
| additional_akms |
v7.0.0 -> 7.6.6 |
| [akm6] |
v7.0.0 -> 7.6.6 |
| [akm24] |
v7.4.4 -> 7.6.6 |
- address_group - Firewall Address Group Name. Source firewall.addrgrp.name. type: str
more...
|
Supported Version Ranges |
| address_group |
v6.2.0 -> 7.6.6 |
- address_group_policy - Configure MAC address filtering policy for MAC addresses that are in the address-group. type: str choices: disable, allow, deny
more...
|
Supported Version Ranges |
| address_group_policy |
v7.2.0 -> 7.6.6 |
| [disable] |
v7.2.0 -> 7.6.6 |
| [allow] |
v7.2.0 -> 7.6.6 |
| [deny] |
v7.2.0 -> 7.6.6 |
- akm24_only - WPA3 SAE using group-dependent hash only . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| akm24_only |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
- alias - Alias. type: str
more...
|
Supported Version Ranges |
| alias |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
- antivirus_profile - AntiVirus profile name. Source antivirus.profile.name. type: str
more...
|
Supported Version Ranges |
| antivirus_profile |
v7.0.1 -> 7.6.6 |
- application_detection_engine - Enable/disable application detection engine . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| application_detection_engine |
v7.2.0 -> 7.6.6 |
| [enable] |
v7.2.0 -> 7.6.6 |
| [disable] |
v7.2.0 -> 7.6.6 |
- application_dscp_marking - Enable/disable application attribute based DSCP marking . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| application_dscp_marking |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
- application_list - Application control list name. Source application.list.name. type: str
more...
|
Supported Version Ranges |
| application_list |
v7.0.1 -> 7.6.6 |
- application_report_intv - Application report interval (30 - 864000 sec). type: int
more...
|
Supported Version Ranges |
| application_report_intv |
v7.2.0 -> 7.6.6 |
- atf_weight - Airtime weight in percentage . type: int
more...
|
Supported Version Ranges |
| atf_weight |
v6.2.0 -> 7.6.6 |
- auth - Authentication protocol. type: str choices: radius, usergroup, psk
more...
|
Supported Version Ranges |
| auth |
v6.0.0 -> 7.6.6 |
| [radius] |
v6.0.0 -> 7.6.6 |
| [usergroup] |
v6.0.0 -> 7.6.6 |
| [psk] |
v6.0.0 -> v7.4.0 |
- auth_cert - HTTPS server certificate. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| auth_cert |
v7.0.4 -> 7.6.6 |
- auth_portal_addr - Address of captive portal. type: str
more...
|
Supported Version Ranges |
| auth_portal_addr |
v7.0.4 -> 7.6.6 |
- beacon_advertising - Fortinet beacon advertising IE data . type: list choices: name, model, serial-number
more...
|
Supported Version Ranges |
| beacon_advertising |
v7.0.2 -> 7.6.6 |
| [name] |
v7.0.2 -> 7.6.6 |
| [model] |
v7.0.2 -> 7.6.6 |
| [serial-number] |
v7.0.2 -> 7.6.6 |
- beacon_protection - Enable/disable beacon protection support . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| beacon_protection |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
- broadcast_ssid - Enable/disable broadcasting the SSID . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| broadcast_ssid |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- broadcast_suppression - Optional suppression of broadcast messages. For example, you can keep DHCP messages, ARP broadcasts, and so on off of the wireless network. type: list choices: dhcp-up, dhcp-down, dhcp-starvation, dhcp-ucast, arp-known, arp-unknown, arp-reply, arp-poison, arp-proxy, netbios-ns, netbios-ds, ipv6, all-other-mc, all-other-bc
more...
|
Supported Version Ranges |
| broadcast_suppression |
v6.0.0 -> 7.6.6 |
| [dhcp-up] |
v6.0.0 -> 7.6.6 |
| [dhcp-down] |
v6.0.0 -> 7.6.6 |
| [dhcp-starvation] |
v6.0.0 -> 7.6.6 |
| [dhcp-ucast] |
v6.2.0 -> 7.6.6 |
| [arp-known] |
v6.0.0 -> 7.6.6 |
| [arp-unknown] |
v6.0.0 -> 7.6.6 |
| [arp-reply] |
v6.0.0 -> 7.6.6 |
| [arp-poison] |
v6.0.0 -> 7.6.6 |
| [arp-proxy] |
v6.0.0 -> 7.6.6 |
| [netbios-ns] |
v6.0.0 -> 7.6.6 |
| [netbios-ds] |
v6.0.0 -> 7.6.6 |
| [ipv6] |
v6.0.0 -> 7.6.6 |
| [all-other-mc] |
v6.0.0 -> 7.6.6 |
| [all-other-bc] |
v6.0.0 -> 7.6.6 |
- bss_color_partial - Enable/disable 802.11ax partial BSS color . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| bss_color_partial |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [enable] |
v6.4.0 -> v6.4.0 |
| [disable] |
v6.4.0 -> v6.4.0 |
- bstm_disassociation_imminent - Enable/disable forcing of disassociation after the BSTM request timer has been reached . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| bstm_disassociation_imminent |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- bstm_load_balancing_disassoc_timer - Time interval for client to voluntarily leave AP before forcing a disassociation due to AP load-balancing (0 to 30). type: int
more...
|
Supported Version Ranges |
| bstm_load_balancing_disassoc_timer |
v7.0.0 -> 7.6.6 |
- bstm_rssi_disassoc_timer - Time interval for client to voluntarily leave AP before forcing a disassociation due to low RSSI (0 to 2000). type: int
more...
|
Supported Version Ranges |
| bstm_rssi_disassoc_timer |
v7.0.0 -> 7.6.6 |
- called_station_id_type - The format type of RADIUS attribute Called-Station-Id . type: str choices: mac, ip, apname
more...
|
Supported Version Ranges |
| called_station_id_type |
v7.6.1 -> 7.6.6 |
| [mac] |
v7.6.1 -> 7.6.6 |
| [ip] |
v7.6.1 -> 7.6.6 |
| [apname] |
v7.6.1 -> 7.6.6 |
- captive_network_assistant_bypass - Enable/disable Captive Network Assistant bypass. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| captive_network_assistant_bypass |
v7.6.4 -> 7.6.6 |
| [enable] |
v7.6.4 -> 7.6.6 |
| [disable] |
v7.6.4 -> 7.6.6 |
- captive_portal - Enable/disable captive portal. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| captive_portal |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
- captive_portal_ac_name - Local-bridging captive portal ac-name. type: str
more...
|
Supported Version Ranges |
| captive_portal_ac_name |
v6.0.0 -> 7.6.6 |
- captive_portal_auth_timeout - Hard timeout - AP will always clear the session after timeout regardless of traffic (0 - 864000 sec). type: int
more...
|
Supported Version Ranges |
| captive_portal_auth_timeout |
v6.4.0 -> 7.6.6 |
- captive_portal_fw_accounting - Enable/disable RADIUS accounting for captive portal firewall authentication session. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| captive_portal_fw_accounting |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
- captive_portal_macauth_radius_secret - Secret key to access the macauth RADIUS server. type: str
more...
|
Supported Version Ranges |
| captive_portal_macauth_radius_secret |
v6.0.0 -> v6.2.7 |
- captive_portal_macauth_radius_server - Captive portal external RADIUS server domain name or IP address. type: str
more...
|
Supported Version Ranges |
| captive_portal_macauth_radius_server |
v6.0.0 -> v6.2.7 |
- captive_portal_radius_secret - Secret key to access the RADIUS server. type: str
more...
|
Supported Version Ranges |
| captive_portal_radius_secret |
v6.0.0 -> v6.2.7 |
- captive_portal_radius_server - Captive portal RADIUS server domain name or IP address. type: str
more...
|
Supported Version Ranges |
| captive_portal_radius_server |
v6.0.0 -> v6.2.7 |
- captive_portal_session_timeout_interval - Session timeout interval (0 - 864000 sec). type: int
more...
|
Supported Version Ranges |
| captive_portal_session_timeout_interval |
v6.0.0 -> v6.2.7 |
- dhcp_address_enforcement - Enable/disable DHCP address enforcement . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dhcp_address_enforcement |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- dhcp_lease_time - DHCP lease time in seconds for NAT IP address. type: int
more...
|
Supported Version Ranges |
| dhcp_lease_time |
v6.0.0 -> 7.6.6 |
- dhcp_option43_insertion - Enable/disable insertion of DHCP option 43 . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dhcp_option43_insertion |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
- dhcp_option82_circuit_id_insertion - Enable/disable DHCP option 82 circuit-id insert . type: str choices: style-1, style-2, style-3, disable
more...
|
Supported Version Ranges |
| dhcp_option82_circuit_id_insertion |
v6.0.0 -> 7.6.6 |
| [style-1] |
v6.0.0 -> 7.6.6 |
| [style-2] |
v6.0.0 -> 7.6.6 |
| [style-3] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dhcp_option82_insertion - Enable/disable DHCP option 82 insert . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dhcp_option82_insertion |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- dhcp_option82_remote_id_insertion - Enable/disable DHCP option 82 remote-id insert . type: str choices: style-1, disable
more...
|
Supported Version Ranges |
| dhcp_option82_remote_id_insertion |
v6.0.0 -> 7.6.6 |
| [style-1] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- domain_name_stripping - Enable/disable stripping domain name from identity . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| domain_name_stripping |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
- dynamic_vlan - Enable/disable dynamic VLAN assignment. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dynamic_vlan |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- eap_reauth - Enable/disable EAP re-authentication for WPA-Enterprise security. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| eap_reauth |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- eap_reauth_intv - EAP re-authentication interval (1800 - 864000 sec). type: int
more...
|
Supported Version Ranges |
| eap_reauth_intv |
v6.0.0 -> 7.6.6 |
- eapol_key_retries - Enable/disable retransmission of EAPOL-Key frames (message 3/4 and group message 1/2) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| eapol_key_retries |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- encrypt - Encryption protocol to use (only available when security is set to a WPA type). type: str choices: TKIP, AES, TKIP-AES
more...
|
Supported Version Ranges |
| encrypt |
v6.0.0 -> 7.6.6 |
| [TKIP] |
v6.0.0 -> 7.6.6 |
| [AES] |
v6.0.0 -> 7.6.6 |
| [TKIP-AES] |
v6.0.0 -> 7.6.6 |
- external_fast_roaming - Enable/disable fast roaming or pre-authentication with external APs not managed by the FortiGate . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| external_fast_roaming |
v6.0.0 -> v7.6.0 |
| [enable] |
v6.0.0 -> v7.6.0 |
| [disable] |
v6.0.0 -> v7.6.0 |
- external_logout - URL of external authentication logout server. type: str
more...
|
Supported Version Ranges |
| external_logout |
v6.0.0 -> 7.6.6 |
- external_pre_auth - Enable/disable pre-authentication with external APs not managed by the FortiGate . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| external_pre_auth |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- external_web - URL of external authentication web server. type: str
more...
|
Supported Version Ranges |
| external_web |
v6.0.0 -> 7.6.6 |
- external_web_format - URL query parameter detection . type: str choices: auto-detect, no-query-string, partial-query-string
more...
|
Supported Version Ranges |
| external_web_format |
v6.2.0 -> 7.6.6 |
| [auto-detect] |
v6.2.0 -> 7.6.6 |
| [no-query-string] |
v6.2.0 -> 7.6.6 |
| [partial-query-string] |
v6.2.0 -> 7.6.6 |
- fast_bss_transition - Enable/disable 802.11r Fast BSS Transition (FT) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| fast_bss_transition |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- fast_roaming - Enable/disable fast-roaming, or pre-authentication, where supported by clients . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fast_roaming |
v6.0.0 -> v7.6.0 |
| [enable] |
v6.0.0 -> v7.6.0 |
| [disable] |
v6.0.0 -> v7.6.0 |
- ft_mobility_domain - Mobility domain identifier in FT (1 - 65535). type: int
more...
|
Supported Version Ranges |
| ft_mobility_domain |
v6.0.0 -> 7.6.6 |
- ft_over_ds - Enable/disable FT over the Distribution System (DS). type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ft_over_ds |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- ft_r0_key_lifetime - Lifetime of the PMK-R0 key in FT, 1-65535 minutes. type: int
more...
|
Supported Version Ranges |
| ft_r0_key_lifetime |
v6.0.0 -> 7.6.6 |
- gas_comeback_delay - GAS comeback delay (0 or 100 - 10000 milliseconds). type: int
more...
|
Supported Version Ranges |
| gas_comeback_delay |
v7.0.0 -> 7.6.6 |
- gas_fragmentation_limit - GAS fragmentation limit (512 - 4096). type: int
more...
|
Supported Version Ranges |
| gas_fragmentation_limit |
v7.0.0 -> 7.6.6 |
- gtk_rekey - Enable/disable GTK rekey for WPA security. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| gtk_rekey |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- gtk_rekey_intv - GTK rekey interval (600 - 864000 sec). type: int
more...
|
Supported Version Ranges |
| gtk_rekey_intv |
v6.0.0 -> 7.6.6 |
- high_efficiency - Enable/disable 802.11ax high efficiency . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| high_efficiency |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- hotspot20_profile - Hotspot 2.0 profile name. Source wireless-controller.hotspot20.hs-profile.name. type: str
more...
|
Supported Version Ranges |
| hotspot20_profile |
v6.0.0 -> 7.6.6 |
- igmp_snooping - Enable/disable IGMP snooping. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| igmp_snooping |
v6.4.4 -> 7.6.6 |
| [enable] |
v6.4.4 -> 7.6.6 |
| [disable] |
v6.4.4 -> 7.6.6 |
- intra_vap_privacy - Enable/disable blocking communication between clients on the same SSID (called intra-SSID privacy) . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| intra_vap_privacy |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ip - IP address and subnet mask for the local standalone NAT subnet. type: str
more...
|
Supported Version Ranges |
| ip |
v6.0.0 -> 7.6.6 |
- ips_sensor - IPS sensor name. Source ips.sensor.name. type: str
more...
|
Supported Version Ranges |
| ips_sensor |
v7.0.1 -> 7.6.6 |
- ipv6_rules - Optional rules of IPv6 packets. For example, you can keep RA, RS and so on off of the wireless network. type: list choices: drop-icmp6ra, drop-icmp6rs, drop-llmnr6, drop-icmp6mld2, drop-dhcp6s, drop-dhcp6c, ndp-proxy, drop-ns-dad, drop-ns-nondad
more...
|
Supported Version Ranges |
| ipv6_rules |
v6.4.0 -> 7.6.6 |
| [drop-icmp6ra] |
v6.4.0 -> 7.6.6 |
| [drop-icmp6rs] |
v6.4.0 -> 7.6.6 |
| [drop-llmnr6] |
v6.4.0 -> 7.6.6 |
| [drop-icmp6mld2] |
v6.4.0 -> 7.6.6 |
| [drop-dhcp6s] |
v6.4.0 -> 7.6.6 |
| [drop-dhcp6c] |
v6.4.0 -> 7.6.6 |
| [ndp-proxy] |
v6.4.0 -> 7.6.6 |
| [drop-ns-dad] |
v6.4.0 -> 7.6.6 |
| [drop-ns-nondad] |
v6.4.0 -> 7.6.6 |
- key - WEP Key. type: str
more...
|
Supported Version Ranges |
| key |
v6.0.0 -> 7.6.6 |
- keyindex - WEP key index (1 - 4). type: int
more...
|
Supported Version Ranges |
| keyindex |
v6.0.0 -> 7.6.6 |
- l3_roaming - Enable/disable layer 3 roaming . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| l3_roaming |
v7.2.0 -> 7.6.6 |
| [enable] |
v7.2.0 -> 7.6.6 |
| [disable] |
v7.2.0 -> 7.6.6 |
- l3_roaming_mode - Select the way that layer 3 roaming traffic is passed . type: str choices: direct, indirect
more...
|
Supported Version Ranges |
| l3_roaming_mode |
v7.2.1 -> 7.6.6 |
| [direct] |
v7.2.1 -> 7.6.6 |
| [indirect] |
v7.2.1 -> 7.6.6 |
- ldpc - VAP low-density parity-check (LDPC) coding configuration. type: str choices: disable, rx, tx, rxtx
more...
|
Supported Version Ranges |
| ldpc |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [rx] |
v6.0.0 -> 7.6.6 |
| [tx] |
v6.0.0 -> 7.6.6 |
| [rxtx] |
v6.0.0 -> 7.6.6 |
- local_authentication - Enable/disable AP local authentication. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| local_authentication |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- local_bridging - Enable/disable bridging of wireless and Ethernet interfaces on the FortiAP . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| local_bridging |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- local_lan - Allow/deny traffic destined for a Class A, B, or C private IP address . type: str choices: allow, deny
more...
|
Supported Version Ranges |
| local_lan |
v6.0.0 -> 7.6.6 |
| [allow] |
v6.0.0 -> 7.6.6 |
| [deny] |
v6.0.0 -> 7.6.6 |
- local_lan_partition - Enable/disable segregating client traffic to local LAN side . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| local_lan_partition |
v7.6.0 -> 7.6.6 |
| [enable] |
v7.6.0 -> 7.6.6 |
| [disable] |
v7.6.0 -> 7.6.6 |
- local_standalone - Enable/disable AP local standalone . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| local_standalone |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- local_standalone_dns - Enable/disable AP local standalone DNS. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| local_standalone_dns |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- local_standalone_dns_ip - IPv4 addresses for the local standalone DNS. type: list
- local_standalone_nat - Enable/disable AP local standalone NAT mode. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| local_standalone_nat |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- mac_auth_bypass - Enable/disable MAC authentication bypass. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| mac_auth_bypass |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- mac_called_station_delimiter - MAC called station delimiter . type: str choices: hyphen, single-hyphen, colon, none
more...
|
Supported Version Ranges |
| mac_called_station_delimiter |
v7.0.0 -> 7.6.6 |
| [hyphen] |
v7.0.0 -> 7.6.6 |
| [single-hyphen] |
v7.0.0 -> 7.6.6 |
| [colon] |
v7.0.0 -> 7.6.6 |
| [none] |
v7.0.0 -> 7.6.6 |
- mac_calling_station_delimiter - MAC calling station delimiter . type: str choices: hyphen, single-hyphen, colon, none
more...
|
Supported Version Ranges |
| mac_calling_station_delimiter |
v7.0.0 -> 7.6.6 |
| [hyphen] |
v7.0.0 -> 7.6.6 |
| [single-hyphen] |
v7.0.0 -> 7.6.6 |
| [colon] |
v7.0.0 -> 7.6.6 |
| [none] |
v7.0.0 -> 7.6.6 |
- mac_case - MAC case . type: str choices: uppercase, lowercase
more...
|
Supported Version Ranges |
| mac_case |
v7.0.0 -> 7.6.6 |
| [uppercase] |
v7.0.0 -> 7.6.6 |
| [lowercase] |
v7.0.0 -> 7.6.6 |
- mac_filter - Enable/disable MAC filtering to block wireless clients by mac address. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| mac_filter |
v6.0.0 -> v7.4.0 |
| [enable] |
v6.0.0 -> v7.4.0 |
| [disable] |
v6.0.0 -> v7.4.0 |
- mac_filter_list - Create a list of MAC addresses for MAC address filtering. type: list member_path: mac_filter_list:id
more...
| Supported Version Ranges |
| mac_filter_list |
v6.0.0 -> v7.4.0 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> v7.4.0 |
- mac - MAC address. type: str
more...
|
Supported Version Ranges |
| mac |
v6.0.0 -> v7.4.0 |
- mac_filter_policy - Deny or allow the client with this MAC address. type: str choices: allow, deny
more...
|
Supported Version Ranges |
| mac_filter_policy |
v6.0.0 -> v7.4.0 |
| [allow] |
v6.0.0 -> v7.4.0 |
| [deny] |
v6.0.0 -> v7.4.0 |
- mac_filter_policy_other - Allow or block clients with MAC addresses that are not in the filter list. type: str choices: allow, deny
more...
|
Supported Version Ranges |
| mac_filter_policy_other |
v6.0.0 -> v7.4.0 |
| [allow] |
v6.0.0 -> v7.4.0 |
| [deny] |
v6.0.0 -> v7.4.0 |
- mac_password_delimiter - MAC authentication password delimiter . type: str choices: hyphen, single-hyphen, colon, none
more...
|
Supported Version Ranges |
| mac_password_delimiter |
v7.0.0 -> 7.6.6 |
| [hyphen] |
v7.0.0 -> 7.6.6 |
| [single-hyphen] |
v7.0.0 -> 7.6.6 |
| [colon] |
v7.0.0 -> 7.6.6 |
| [none] |
v7.0.0 -> 7.6.6 |
- mac_username_delimiter - MAC authentication username delimiter . type: str choices: hyphen, single-hyphen, colon, none
more...
|
Supported Version Ranges |
| mac_username_delimiter |
v7.0.0 -> 7.6.6 |
| [hyphen] |
v7.0.0 -> 7.6.6 |
| [single-hyphen] |
v7.0.0 -> 7.6.6 |
| [colon] |
v7.0.0 -> 7.6.6 |
| [none] |
v7.0.0 -> 7.6.6 |
- max_clients - Maximum number of clients that can connect simultaneously to the VAP . type: int
more...
|
Supported Version Ranges |
| max_clients |
v6.0.0 -> 7.6.6 |
- max_clients_ap - Maximum number of clients that can connect simultaneously to the VAP per AP radio . type: int
more...
|
Supported Version Ranges |
| max_clients_ap |
v6.0.0 -> 7.6.6 |
- mbo - Enable/disable Multiband Operation . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| mbo |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
- mbo_cell_data_conn_pref - MBO cell data connection preference (0, 1, or 255). type: str choices: excluded, prefer-not, prefer-use
more...
|
Supported Version Ranges |
| mbo_cell_data_conn_pref |
v7.0.0 -> 7.6.6 |
| [excluded] |
v7.0.0 -> 7.6.6 |
| [prefer-not] |
v7.0.0 -> 7.6.6 |
| [prefer-use] |
v7.0.0 -> 7.6.6 |
- me_disable_thresh - Disable multicast enhancement when this many clients are receiving multicast traffic. type: int
more...
|
Supported Version Ranges |
| me_disable_thresh |
v6.0.0 -> 7.6.6 |
- mesh_backhaul - Enable/disable using this VAP as a WiFi mesh backhaul . This entry is only available when security is set to a WPA type or open. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| mesh_backhaul |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- mlo - Enable/disable WiFi7 Multi-Link-Operation . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| mlo |
v7.6.5 -> 7.6.6 |
| [disable] |
v7.6.5 -> 7.6.6 |
| [enable] |
v7.6.5 -> 7.6.6 |
- mpsk - Enable/disable multiple PSK authentication. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| mpsk |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- mpsk_concurrent_clients - Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication (0 - 65535). type: int
more...
|
Supported Version Ranges |
| mpsk_concurrent_clients |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- mpsk_key - List of multiple PSK entries. type: list member_path: mpsk_key:key_name
more...
| Supported Version Ranges |
| mpsk_key |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- comment - Comment. type: str
more...
|
Supported Version Ranges |
| comment |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- concurrent_clients - Number of clients that can connect using this pre-shared key. type: str
more...
|
Supported Version Ranges |
| concurrent_clients |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- key_name - Pre-shared key name. type: str required: true
more...
|
Supported Version Ranges |
| key_name |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- mpsk_schedules - Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. type: list member_path: mpsk_key:key_name/mpsk_schedules:name
more...
| Supported Version Ranges |
| mpsk_schedules |
v6.2.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- passphrase - WPA Pre-shared key. type: str
more...
|
Supported Version Ranges |
| passphrase |
v6.0.0 -> v6.2.7 |
v6.4.1 -> v6.4.1 |
- mpsk_profile - MPSK profile name. Source wireless-controller.mpsk-profile.name. type: str
more...
|
Supported Version Ranges |
| mpsk_profile |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
- mu_mimo - Enable/disable Multi-user MIMO . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| mu_mimo |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- multicast_enhance - Enable/disable converting multicast to unicast to improve performance . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| multicast_enhance |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- multicast_rate - Multicast rate (0, 6000, 12000, or 24000 kbps). type: str choices: 0, 6000, 12000, 24000
more...
|
Supported Version Ranges |
| multicast_rate |
v6.0.0 -> 7.6.6 |
| [0] |
v6.0.0 -> 7.6.6 |
| [6000] |
v6.0.0 -> 7.6.6 |
| [12000] |
v6.0.0 -> 7.6.6 |
| [24000] |
v6.0.0 -> 7.6.6 |
- nac - Enable/disable network access control. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nac |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- nac_profile - NAC profile name. Source wireless-controller.nac-profile.name. type: str
more...
|
Supported Version Ranges |
| nac_profile |
v7.0.0 -> 7.6.6 |
- name - Virtual AP name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- nas_filter_rule - Enable/disable NAS filter rule support . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| nas_filter_rule |
v7.4.4 -> 7.6.6 |
| [enable] |
v7.4.4 -> 7.6.6 |
| [disable] |
v7.4.4 -> 7.6.6 |
- neighbor_report_dual_band - Enable/disable dual-band neighbor report . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| neighbor_report_dual_band |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
- okc - Enable/disable Opportunistic Key Caching (OKC) . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| okc |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- osen - Enable/disable OSEN as part of key management . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| osen |
v7.0.2 -> 7.6.6 |
| [enable] |
v7.0.2 -> 7.6.6 |
| [disable] |
v7.0.2 -> 7.6.6 |
- owe_groups - OWE-Groups. type: list choices: 19, 20, 21
more...
|
Supported Version Ranges |
| owe_groups |
v6.2.0 -> 7.6.6 |
| [19] |
v6.2.0 -> 7.6.6 |
| [20] |
v6.2.0 -> 7.6.6 |
| [21] |
v6.2.0 -> 7.6.6 |
- owe_transition - Enable/disable OWE transition mode support. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| owe_transition |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
- owe_transition_ssid - OWE transition mode peer SSID. type: str
more...
|
Supported Version Ranges |
| owe_transition_ssid |
v6.2.0 -> 7.6.6 |
- passphrase - WPA pre-shared key (PSK) to be used to authenticate WiFi users. type: str
more...
|
Supported Version Ranges |
| passphrase |
v6.0.0 -> 7.6.6 |
- pmf - Protected Management Frames (PMF) support . type: str choices: disable, enable, optional
more...
|
Supported Version Ranges |
| pmf |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [optional] |
v6.0.0 -> 7.6.6 |
- pmf_assoc_comeback_timeout - Protected Management Frames (PMF) comeback maximum timeout (1-20 sec). type: int
more...
|
Supported Version Ranges |
| pmf_assoc_comeback_timeout |
v6.0.0 -> 7.6.6 |
- pmf_sa_query_retry_timeout - Protected Management Frames (PMF) SA query retry timeout interval (1 - 5 100s of msec). type: int
more...
|
Supported Version Ranges |
| pmf_sa_query_retry_timeout |
v6.0.0 -> 7.6.6 |
- port_macauth - Enable/disable LAN port MAC authentication . type: str choices: disable, radius, address-group
more...
|
Supported Version Ranges |
| port_macauth |
v6.4.4 -> 7.6.6 |
| [disable] |
v6.4.4 -> 7.6.6 |
| [radius] |
v6.4.4 -> 7.6.6 |
| [address-group] |
v6.4.4 -> 7.6.6 |
- port_macauth_reauth_timeout - LAN port MAC authentication re-authentication timeout value . type: int
more...
|
Supported Version Ranges |
| port_macauth_reauth_timeout |
v6.4.4 -> 7.6.6 |
- port_macauth_timeout - LAN port MAC authentication idle timeout value . type: int
more...
|
Supported Version Ranges |
| port_macauth_timeout |
v6.4.4 -> 7.6.6 |
- portal_message_override_group - Replacement message group for this VAP (only available when security is set to a captive portal type). Source system.replacemsg-group .name. type: str
more...
|
Supported Version Ranges |
| portal_message_override_group |
v6.0.0 -> 7.6.6 |
- portal_message_overrides - Individual message overrides. type: dict
more...
| Supported Version Ranges |
| portal_message_overrides |
v6.0.0 -> 7.6.6 |
- auth_disclaimer_page - Override auth-disclaimer-page message with message from portal-message-overrides group. type: str
more...
|
Supported Version Ranges |
| auth_disclaimer_page |
v6.0.0 -> 7.6.6 |
- auth_login_failed_page - Override auth-login-failed-page message with message from portal-message-overrides group. type: str
more...
|
Supported Version Ranges |
| auth_login_failed_page |
v6.0.0 -> 7.6.6 |
- auth_login_page - Override auth-login-page message with message from portal-message-overrides group. type: str
more...
|
Supported Version Ranges |
| auth_login_page |
v6.0.0 -> 7.6.6 |
- auth_reject_page - Override auth-reject-page message with message from portal-message-overrides group. type: str
more...
|
Supported Version Ranges |
| auth_reject_page |
v6.0.0 -> 7.6.6 |
- portal_type - Captive portal functionality. Configure how the captive portal authenticates users and whether it includes a disclaimer. type: str choices: auth, auth+disclaimer, disclaimer, email-collect, cmcc, cmcc-macauth, auth-mac, external-auth, external-macauth
more...
|
Supported Version Ranges |
| portal_type |
v6.0.0 -> 7.6.6 |
| [auth] |
v6.0.0 -> 7.6.6 |
| [auth+disclaimer] |
v6.0.0 -> 7.6.6 |
| [disclaimer] |
v6.0.0 -> 7.6.6 |
| [email-collect] |
v6.0.0 -> 7.6.6 |
| [cmcc] |
v6.0.0 -> 7.6.6 |
| [cmcc-macauth] |
v6.0.0 -> 7.6.6 |
| [auth-mac] |
v6.0.0 -> 7.6.6 |
| [external-auth] |
v6.2.0 -> 7.6.6 |
| [external-macauth] |
v7.0.0 -> 7.6.6 |
- pre_auth - Enable/disable pre-authentication, where supported by clients . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| pre_auth |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- primary_wag_profile - Primary wireless access gateway profile name. Source wireless-controller.wag-profile.name. type: str
more...
|
Supported Version Ranges |
| primary_wag_profile |
v6.2.0 -> 7.6.6 |
- probe_resp_suppression - Enable/disable probe response suppression (to ignore weak signals) . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| probe_resp_suppression |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- probe_resp_threshold - Minimum signal level/threshold in dBm required for the AP response to probe requests (-95 to -20). type: str
more...
|
Supported Version Ranges |
| probe_resp_threshold |
v6.0.0 -> 7.6.6 |
- ptk_rekey - Enable/disable PTK rekey for WPA-Enterprise security. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ptk_rekey |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ptk_rekey_intv - PTK rekey interval (600 - 864000 sec). type: int
more...
|
Supported Version Ranges |
| ptk_rekey_intv |
v6.0.0 -> 7.6.6 |
- qos_profile - Quality of service profile name. Source wireless-controller.qos-profile.name. type: str
more...
|
Supported Version Ranges |
| qos_profile |
v6.0.0 -> 7.6.6 |
- quarantine - Enable/disable station quarantine . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| quarantine |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- radio_2g_threshold - Minimum signal level/threshold in dBm required for the AP response to receive a packet in 2.4G band (-95 to -20). type: str
more...
|
Supported Version Ranges |
| radio_2g_threshold |
v6.0.0 -> 7.6.6 |
- radio_5g_threshold - Minimum signal level/threshold in dBm required for the AP response to receive a packet in 5G band(-95 to -20). type: str
more...
|
Supported Version Ranges |
| radio_5g_threshold |
v6.0.0 -> 7.6.6 |
- radio_sensitivity - Enable/disable software radio sensitivity (to ignore weak signals) . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| radio_sensitivity |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- radius_mac_auth - Enable/disable RADIUS-based MAC authentication of clients . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| radius_mac_auth |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- radius_mac_auth_block_interval - Don"t send RADIUS MAC auth request again if the client has been rejected within specific interval (0 or 30 - 864000 seconds). type: int
more...
|
Supported Version Ranges |
| radius_mac_auth_block_interval |
v7.2.4 -> 7.6.6 |
- radius_mac_auth_server - RADIUS-based MAC authentication server. Source user.radius.name. type: str
more...
|
Supported Version Ranges |
| radius_mac_auth_server |
v6.0.0 -> 7.6.6 |
- radius_mac_auth_usergroups - Selective user groups that are permitted for RADIUS mac authentication. type: list member_path: radius_mac_auth_usergroups:name
more...
| Supported Version Ranges |
| radius_mac_auth_usergroups |
v6.0.0 -> 7.6.6 |
- name - User group name. Source user.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- radius_mac_mpsk_auth - Enable/disable RADIUS-based MAC authentication of clients for MPSK authentication . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| radius_mac_mpsk_auth |
v7.0.2 -> 7.6.6 |
| [enable] |
v7.0.2 -> 7.6.6 |
| [disable] |
v7.0.2 -> 7.6.6 |
- radius_mac_mpsk_timeout - RADIUS MAC MPSK cache timeout interval (0 or 300 - 864000). type: int
more...
|
Supported Version Ranges |
| radius_mac_mpsk_timeout |
v7.0.2 -> 7.6.6 |
- radius_server - RADIUS server to be used to authenticate WiFi users. Source user.radius.name. type: str
more...
|
Supported Version Ranges |
| radius_server |
v6.0.0 -> 7.6.6 |
- rates_11a - Allowed data rates for 802.11a. type: list choices: 6, 6-basic, 9, 9-basic, 12, 12-basic, 18, 18-basic, 24, 24-basic, 36, 36-basic, 48, 48-basic, 54, 54-basic, 1, 1-basic, 2, 2-basic, 5.5, 5.5-basic, 11, 11-basic
more...
|
Supported Version Ranges |
| rates_11a |
v6.0.0 -> 7.6.6 |
| [6] |
v6.0.0 -> 7.6.6 |
| [6-basic] |
v6.0.0 -> 7.6.6 |
| [9] |
v6.0.0 -> 7.6.6 |
| [9-basic] |
v6.0.0 -> 7.6.6 |
| [12] |
v6.0.0 -> 7.6.6 |
| [12-basic] |
v6.0.0 -> 7.6.6 |
| [18] |
v6.0.0 -> 7.6.6 |
| [18-basic] |
v6.0.0 -> 7.6.6 |
| [24] |
v6.0.0 -> 7.6.6 |
| [24-basic] |
v6.0.0 -> 7.6.6 |
| [36] |
v6.0.0 -> 7.6.6 |
| [36-basic] |
v6.0.0 -> 7.6.6 |
| [48] |
v6.0.0 -> 7.6.6 |
| [48-basic] |
v6.0.0 -> 7.6.6 |
| [54] |
v6.0.0 -> 7.6.6 |
| [54-basic] |
v6.0.0 -> 7.6.6 |
| [1] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [1-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [2] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [2-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [5.5] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [5.5-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [11] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
| [11-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> v7.4.4 |
- rates_11ac_mcs_map - Comma separated list of max supported VHT MCS for spatial streams 1 through 8. type: str
more...
|
Supported Version Ranges |
| rates_11ac_mcs_map |
v7.2.1 -> 7.6.6 |
- rates_11ac_ss12 - Allowed data rates for 802.11ac with 1 or 2 spatial streams. type: list choices: mcs0/1, mcs1/1, mcs2/1, mcs3/1, mcs4/1, mcs5/1, mcs6/1, mcs7/1, mcs8/1, mcs9/1, mcs10/1, mcs11/1, mcs0/2, mcs1/2, mcs2/2, mcs3/2, mcs4/2, mcs5/2, mcs6/2, mcs7/2, mcs8/2, mcs9/2, mcs10/2, mcs11/2
more...
|
Supported Version Ranges |
| rates_11ac_ss12 |
v6.0.0 -> v7.2.0 |
| [mcs0/1] |
v6.0.0 -> v7.2.0 |
| [mcs1/1] |
v6.0.0 -> v7.2.0 |
| [mcs2/1] |
v6.0.0 -> v7.2.0 |
| [mcs3/1] |
v6.0.0 -> v7.2.0 |
| [mcs4/1] |
v6.0.0 -> v7.2.0 |
| [mcs5/1] |
v6.0.0 -> v7.2.0 |
| [mcs6/1] |
v6.0.0 -> v7.2.0 |
| [mcs7/1] |
v6.0.0 -> v7.2.0 |
| [mcs8/1] |
v6.0.0 -> v7.2.0 |
| [mcs9/1] |
v6.0.0 -> v7.2.0 |
| [mcs10/1] |
v6.0.0 -> v7.2.0 |
| [mcs11/1] |
v6.0.0 -> v7.2.0 |
| [mcs0/2] |
v6.0.0 -> v7.2.0 |
| [mcs1/2] |
v6.0.0 -> v7.2.0 |
| [mcs2/2] |
v6.0.0 -> v7.2.0 |
| [mcs3/2] |
v6.0.0 -> v7.2.0 |
| [mcs4/2] |
v6.0.0 -> v7.2.0 |
| [mcs5/2] |
v6.0.0 -> v7.2.0 |
| [mcs6/2] |
v6.0.0 -> v7.2.0 |
| [mcs7/2] |
v6.0.0 -> v7.2.0 |
| [mcs8/2] |
v6.0.0 -> v7.2.0 |
| [mcs9/2] |
v6.0.0 -> v7.2.0 |
| [mcs10/2] |
v6.0.0 -> v7.2.0 |
| [mcs11/2] |
v6.0.0 -> v7.2.0 |
- rates_11ac_ss34 - Allowed data rates for 802.11ac with 3 or 4 spatial streams. type: list choices: mcs0/3, mcs1/3, mcs2/3, mcs3/3, mcs4/3, mcs5/3, mcs6/3, mcs7/3, mcs8/3, mcs9/3, mcs10/3, mcs11/3, mcs0/4, mcs1/4, mcs2/4, mcs3/4, mcs4/4, mcs5/4, mcs6/4, mcs7/4, mcs8/4, mcs9/4, mcs10/4, mcs11/4
more...
|
Supported Version Ranges |
| rates_11ac_ss34 |
v6.0.0 -> v7.2.0 |
| [mcs0/3] |
v6.0.0 -> v7.2.0 |
| [mcs1/3] |
v6.0.0 -> v7.2.0 |
| [mcs2/3] |
v6.0.0 -> v7.2.0 |
| [mcs3/3] |
v6.0.0 -> v7.2.0 |
| [mcs4/3] |
v6.0.0 -> v7.2.0 |
| [mcs5/3] |
v6.0.0 -> v7.2.0 |
| [mcs6/3] |
v6.0.0 -> v7.2.0 |
| [mcs7/3] |
v6.0.0 -> v7.2.0 |
| [mcs8/3] |
v6.0.0 -> v7.2.0 |
| [mcs9/3] |
v6.0.0 -> v7.2.0 |
| [mcs10/3] |
v6.0.0 -> v7.2.0 |
| [mcs11/3] |
v6.0.0 -> v7.2.0 |
| [mcs0/4] |
v6.0.0 -> v7.2.0 |
| [mcs1/4] |
v6.0.0 -> v7.2.0 |
| [mcs2/4] |
v6.0.0 -> v7.2.0 |
| [mcs3/4] |
v6.0.0 -> v7.2.0 |
| [mcs4/4] |
v6.0.0 -> v7.2.0 |
| [mcs5/4] |
v6.0.0 -> v7.2.0 |
| [mcs6/4] |
v6.0.0 -> v7.2.0 |
| [mcs7/4] |
v6.0.0 -> v7.2.0 |
| [mcs8/4] |
v6.0.0 -> v7.2.0 |
| [mcs9/4] |
v6.0.0 -> v7.2.0 |
| [mcs10/4] |
v6.0.0 -> v7.2.0 |
| [mcs11/4] |
v6.0.0 -> v7.2.0 |
- rates_11ax_mcs_map - Comma separated list of max supported HE MCS for spatial streams 1 through 8. type: str
more...
|
Supported Version Ranges |
| rates_11ax_mcs_map |
v7.2.1 -> 7.6.6 |
- rates_11ax_ss12 - Allowed data rates for 802.11ax with 1 or 2 spatial streams. type: list choices: mcs0/1, mcs1/1, mcs2/1, mcs3/1, mcs4/1, mcs5/1, mcs6/1, mcs7/1, mcs8/1, mcs9/1, mcs10/1, mcs11/1, mcs0/2, mcs1/2, mcs2/2, mcs3/2, mcs4/2, mcs5/2, mcs6/2, mcs7/2, mcs8/2, mcs9/2, mcs10/2, mcs11/2
more...
|
Supported Version Ranges |
| rates_11ax_ss12 |
v7.0.2 -> v7.2.0 |
| [mcs0/1] |
v7.0.2 -> v7.2.0 |
| [mcs1/1] |
v7.0.2 -> v7.2.0 |
| [mcs2/1] |
v7.0.2 -> v7.2.0 |
| [mcs3/1] |
v7.0.2 -> v7.2.0 |
| [mcs4/1] |
v7.0.2 -> v7.2.0 |
| [mcs5/1] |
v7.0.2 -> v7.2.0 |
| [mcs6/1] |
v7.0.2 -> v7.2.0 |
| [mcs7/1] |
v7.0.2 -> v7.2.0 |
| [mcs8/1] |
v7.0.2 -> v7.2.0 |
| [mcs9/1] |
v7.0.2 -> v7.2.0 |
| [mcs10/1] |
v7.0.2 -> v7.2.0 |
| [mcs11/1] |
v7.0.2 -> v7.2.0 |
| [mcs0/2] |
v7.0.2 -> v7.2.0 |
| [mcs1/2] |
v7.0.2 -> v7.2.0 |
| [mcs2/2] |
v7.0.2 -> v7.2.0 |
| [mcs3/2] |
v7.0.2 -> v7.2.0 |
| [mcs4/2] |
v7.0.2 -> v7.2.0 |
| [mcs5/2] |
v7.0.2 -> v7.2.0 |
| [mcs6/2] |
v7.0.2 -> v7.2.0 |
| [mcs7/2] |
v7.0.2 -> v7.2.0 |
| [mcs8/2] |
v7.0.2 -> v7.2.0 |
| [mcs9/2] |
v7.0.2 -> v7.2.0 |
| [mcs10/2] |
v7.0.2 -> v7.2.0 |
| [mcs11/2] |
v7.0.2 -> v7.2.0 |
- rates_11ax_ss34 - Allowed data rates for 802.11ax with 3 or 4 spatial streams. type: list choices: mcs0/3, mcs1/3, mcs2/3, mcs3/3, mcs4/3, mcs5/3, mcs6/3, mcs7/3, mcs8/3, mcs9/3, mcs10/3, mcs11/3, mcs0/4, mcs1/4, mcs2/4, mcs3/4, mcs4/4, mcs5/4, mcs6/4, mcs7/4, mcs8/4, mcs9/4, mcs10/4, mcs11/4
more...
|
Supported Version Ranges |
| rates_11ax_ss34 |
v7.0.2 -> v7.2.0 |
| [mcs0/3] |
v7.0.2 -> v7.2.0 |
| [mcs1/3] |
v7.0.2 -> v7.2.0 |
| [mcs2/3] |
v7.0.2 -> v7.2.0 |
| [mcs3/3] |
v7.0.2 -> v7.2.0 |
| [mcs4/3] |
v7.0.2 -> v7.2.0 |
| [mcs5/3] |
v7.0.2 -> v7.2.0 |
| [mcs6/3] |
v7.0.2 -> v7.2.0 |
| [mcs7/3] |
v7.0.2 -> v7.2.0 |
| [mcs8/3] |
v7.0.2 -> v7.2.0 |
| [mcs9/3] |
v7.0.2 -> v7.2.0 |
| [mcs10/3] |
v7.0.2 -> v7.2.0 |
| [mcs11/3] |
v7.0.2 -> v7.2.0 |
| [mcs0/4] |
v7.0.2 -> v7.2.0 |
| [mcs1/4] |
v7.0.2 -> v7.2.0 |
| [mcs2/4] |
v7.0.2 -> v7.2.0 |
| [mcs3/4] |
v7.0.2 -> v7.2.0 |
| [mcs4/4] |
v7.0.2 -> v7.2.0 |
| [mcs5/4] |
v7.0.2 -> v7.2.0 |
| [mcs6/4] |
v7.0.2 -> v7.2.0 |
| [mcs7/4] |
v7.0.2 -> v7.2.0 |
| [mcs8/4] |
v7.0.2 -> v7.2.0 |
| [mcs9/4] |
v7.0.2 -> v7.2.0 |
| [mcs10/4] |
v7.0.2 -> v7.2.0 |
| [mcs11/4] |
v7.0.2 -> v7.2.0 |
- rates_11be_mcs_map - Comma separated list of max nss that supports EHT-MCS 0-9, 10-11, 12-13 for 20MHz/40MHz/80MHz bandwidth. type: str
more...
|
Supported Version Ranges |
| rates_11be_mcs_map |
v7.4.4 -> 7.6.6 |
- rates_11be_mcs_map_160 - Comma separated list of max nss that supports EHT-MCS 0-9, 10-11, 12-13 for 160MHz bandwidth. type: str
more...
|
Supported Version Ranges |
| rates_11be_mcs_map_160 |
v7.4.4 -> 7.6.6 |
- rates_11be_mcs_map_320 - Comma separated list of max nss that supports EHT-MCS 0-9, 10-11, 12-13 for 320MHz bandwidth. type: str
more...
|
Supported Version Ranges |
| rates_11be_mcs_map_320 |
v7.4.4 -> 7.6.6 |
- rates_11bg - Allowed data rates for 802.11b/g. type: list choices: 1, 1-basic, 2, 2-basic, 5.5, 5.5-basic, 11, 11-basic, 6, 6-basic, 9, 9-basic, 12, 12-basic, 18, 18-basic, 24, 24-basic, 36, 36-basic, 48, 48-basic, 54, 54-basic
more...
|
Supported Version Ranges |
| rates_11bg |
v6.0.0 -> 7.6.6 |
| [1] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [1-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [2] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [2-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [5.5] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [5.5-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [11] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [11-basic] |
v6.0.0 -> v7.4.0 |
v7.4.2 -> 7.6.6 |
| [6] |
v6.0.0 -> 7.6.6 |
| [6-basic] |
v6.0.0 -> 7.6.6 |
| [9] |
v6.0.0 -> 7.6.6 |
| [9-basic] |
v6.0.0 -> 7.6.6 |
| [12] |
v6.0.0 -> 7.6.6 |
| [12-basic] |
v6.0.0 -> 7.6.6 |
| [18] |
v6.0.0 -> 7.6.6 |
| [18-basic] |
v6.0.0 -> 7.6.6 |
| [24] |
v6.0.0 -> 7.6.6 |
| [24-basic] |
v6.0.0 -> 7.6.6 |
| [36] |
v6.0.0 -> 7.6.6 |
| [36-basic] |
v6.0.0 -> 7.6.6 |
| [48] |
v6.0.0 -> 7.6.6 |
| [48-basic] |
v6.0.0 -> 7.6.6 |
| [54] |
v6.0.0 -> 7.6.6 |
| [54-basic] |
v6.0.0 -> 7.6.6 |
- rates_11n_ss12 - Allowed data rates for 802.11n with 1 or 2 spatial streams. type: list choices: mcs0/1, mcs1/1, mcs2/1, mcs3/1, mcs4/1, mcs5/1, mcs6/1, mcs7/1, mcs8/2, mcs9/2, mcs10/2, mcs11/2, mcs12/2, mcs13/2, mcs14/2, mcs15/2
more...
|
Supported Version Ranges |
| rates_11n_ss12 |
v6.0.0 -> 7.6.6 |
| [mcs0/1] |
v6.0.0 -> 7.6.6 |
| [mcs1/1] |
v6.0.0 -> 7.6.6 |
| [mcs2/1] |
v6.0.0 -> 7.6.6 |
| [mcs3/1] |
v6.0.0 -> 7.6.6 |
| [mcs4/1] |
v6.0.0 -> 7.6.6 |
| [mcs5/1] |
v6.0.0 -> 7.6.6 |
| [mcs6/1] |
v6.0.0 -> 7.6.6 |
| [mcs7/1] |
v6.0.0 -> 7.6.6 |
| [mcs8/2] |
v6.0.0 -> 7.6.6 |
| [mcs9/2] |
v6.0.0 -> 7.6.6 |
| [mcs10/2] |
v6.0.0 -> 7.6.6 |
| [mcs11/2] |
v6.0.0 -> 7.6.6 |
| [mcs12/2] |
v6.0.0 -> 7.6.6 |
| [mcs13/2] |
v6.0.0 -> 7.6.6 |
| [mcs14/2] |
v6.0.0 -> 7.6.6 |
| [mcs15/2] |
v6.0.0 -> 7.6.6 |
- rates_11n_ss34 - Allowed data rates for 802.11n with 3 or 4 spatial streams. type: list choices: mcs16/3, mcs17/3, mcs18/3, mcs19/3, mcs20/3, mcs21/3, mcs22/3, mcs23/3, mcs24/4, mcs25/4, mcs26/4, mcs27/4, mcs28/4, mcs29/4, mcs30/4, mcs31/4
more...
|
Supported Version Ranges |
| rates_11n_ss34 |
v6.0.0 -> 7.6.6 |
| [mcs16/3] |
v6.0.0 -> 7.6.6 |
| [mcs17/3] |
v6.0.0 -> 7.6.6 |
| [mcs18/3] |
v6.0.0 -> 7.6.6 |
| [mcs19/3] |
v6.0.0 -> 7.6.6 |
| [mcs20/3] |
v6.0.0 -> 7.6.6 |
| [mcs21/3] |
v6.0.0 -> 7.6.6 |
| [mcs22/3] |
v6.0.0 -> 7.6.6 |
| [mcs23/3] |
v6.0.0 -> 7.6.6 |
| [mcs24/4] |
v6.0.0 -> 7.6.6 |
| [mcs25/4] |
v6.0.0 -> 7.6.6 |
| [mcs26/4] |
v6.0.0 -> 7.6.6 |
| [mcs27/4] |
v6.0.0 -> 7.6.6 |
| [mcs28/4] |
v6.0.0 -> 7.6.6 |
| [mcs29/4] |
v6.0.0 -> 7.6.6 |
| [mcs30/4] |
v6.0.0 -> 7.6.6 |
| [mcs31/4] |
v6.0.0 -> 7.6.6 |
- roaming_acct_interim_update - Enable/disable using accounting interim update instead of accounting start/stop on roaming for WPA-Enterprise security. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| roaming_acct_interim_update |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
- sae_groups - SAE-Groups. type: list choices: 19, 20, 21, 1, 2, 5, 14, 15, 16, 17, 18, 27, 28, 29, 30, 31
more...
|
Supported Version Ranges |
| sae_groups |
v6.2.0 -> 7.6.6 |
| [19] |
v6.2.0 -> 7.6.6 |
| [20] |
v6.2.0 -> 7.6.6 |
| [21] |
v6.2.0 -> 7.6.6 |
| [1] |
v6.2.3 -> v6.2.3 |
| [2] |
v6.2.3 -> v6.2.3 |
| [5] |
v6.2.3 -> v6.2.3 |
| [14] |
v6.2.3 -> v6.2.3 |
| [15] |
v6.2.3 -> v6.2.3 |
| [16] |
v6.2.3 -> v6.2.3 |
| [17] |
v6.2.3 -> v6.2.3 |
| [18] |
v6.2.3 -> v6.2.3 |
| [27] |
v6.2.3 -> v6.2.3 |
| [28] |
v6.2.3 -> v6.2.3 |
| [29] |
v6.2.3 -> v6.2.3 |
| [30] |
v6.2.3 -> v6.2.3 |
| [31] |
v6.2.3 -> v6.2.3 |
- sae_h2e_only - Use hash-to-element-only mechanism for PWE derivation . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sae_h2e_only |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.0.8 -> v7.0.12 |
| [disable] |
v7.0.8 -> v7.0.12 |
- sae_hnp_only - Use hunting-and-pecking-only mechanism for PWE derivation . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sae_hnp_only |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
- sae_password - WPA3 SAE password to be used to authenticate WiFi users. type: str
more...
|
Supported Version Ranges |
| sae_password |
v6.2.0 -> 7.6.6 |
- sae_pk - Enable/disable WPA3 SAE-PK . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sae_pk |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.0.8 -> v7.0.12 |
| [disable] |
v7.0.8 -> v7.0.12 |
- sae_private_key - Private key used for WPA3 SAE-PK authentication. type: str
more...
|
Supported Version Ranges |
| sae_private_key |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
- scan_botnet_connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str choices: disable, monitor, block
more...
|
Supported Version Ranges |
| scan_botnet_connections |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
| [monitor] |
v7.0.1 -> 7.6.6 |
| [block] |
v7.0.1 -> 7.6.6 |
- schedule - Firewall schedules for enabling this VAP on the FortiAP. This VAP will be enabled when at least one of the schedules is valid. Separate multiple schedule names with a space. type: list member_path: schedule:name
more...
| Supported Version Ranges |
| schedule |
v6.0.0 -> 7.6.6 |
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.2.0 -> 7.6.6 |
- secondary_wag_profile - Secondary wireless access gateway profile name. Source wireless-controller.wag-profile.name. type: str
more...
|
Supported Version Ranges |
| secondary_wag_profile |
v6.2.0 -> 7.6.6 |
- security - Security mode for the wireless interface . type: str choices: open, wep64, wep128, wpa-personal, wpa-enterprise, wpa-only-personal, wpa-only-enterprise, wpa2-only-personal, wpa2-only-enterprise, wpa3-enterprise, wpa3-only-enterprise, wpa3-enterprise-transition, wpa3-sae, wpa3-sae-transition, owe, osen, captive-portal, wpa-personal+captive-portal, wpa-only-personal+captive-portal, wpa2-only-personal+captive-portal
more...
|
Supported Version Ranges |
| security |
v6.0.0 -> 7.6.6 |
| [open] |
v6.0.0 -> 7.6.6 |
| [wep64] |
v6.0.0 -> 7.6.6 |
| [wep128] |
v6.0.0 -> 7.6.6 |
| [wpa-personal] |
v6.0.0 -> 7.6.6 |
| [wpa-enterprise] |
v6.0.0 -> 7.6.6 |
| [wpa-only-personal] |
v6.0.0 -> 7.6.6 |
| [wpa-only-enterprise] |
v6.0.0 -> 7.6.6 |
| [wpa2-only-personal] |
v6.0.0 -> 7.6.6 |
| [wpa2-only-enterprise] |
v6.0.0 -> 7.6.6 |
| [wpa3-enterprise] |
v6.2.0 -> 7.6.6 |
| [wpa3-only-enterprise] |
v7.0.0 -> 7.6.6 |
| [wpa3-enterprise-transition] |
v7.0.0 -> 7.6.6 |
| [wpa3-sae] |
v6.2.0 -> 7.6.6 |
| [wpa3-sae-transition] |
v6.2.0 -> 7.6.6 |
| [owe] |
v6.2.0 -> 7.6.6 |
| [osen] |
v6.0.0 -> 7.6.6 |
| [captive-portal] |
v6.0.0 -> v7.4.3 |
| [wpa-personal+captive-portal] |
v6.0.0 -> v7.4.3 |
| [wpa-only-personal+captive-portal] |
v6.0.0 -> v7.4.3 |
| [wpa2-only-personal+captive-portal] |
v6.0.0 -> v7.4.3 |
- security_exempt_list - Optional security exempt list for captive portal authentication. Source user.security-exempt-list.name. type: str
more...
|
Supported Version Ranges |
| security_exempt_list |
v6.0.0 -> 7.6.6 |
- security_obsolete_option - Enable/disable obsolete security options. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| security_obsolete_option |
v6.0.0 -> v6.0.11 |
v6.2.3 -> v6.2.3 |
| [enable] |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
- security_redirect_url - Optional URL for redirecting users after they pass captive portal authentication. type: str
more...
|
Supported Version Ranges |
| security_redirect_url |
v6.0.0 -> 7.6.6 |
- selected_usergroups - Selective user groups that are permitted to authenticate. type: list member_path: selected_usergroups:name
more...
| Supported Version Ranges |
| selected_usergroups |
v6.0.0 -> 7.6.6 |
- name - User group name. Source user.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- set_80211k - Enable/disable 802.11k assisted roaming . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| set_80211k |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
- set_80211v - Enable/disable 802.11v assisted roaming . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| set_80211v |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
- split_tunneling - Enable/disable split tunneling . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| split_tunneling |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ssid - IEEE 802.11 service set identifier (SSID) for the wireless interface. Users who wish to use the wireless network must configure their computers to access this SSID name. type: str
more...
|
Supported Version Ranges |
| ssid |
v6.0.0 -> 7.6.6 |
- sticky_client_remove - Enable/disable sticky client remove to maintain good signal level clients in SSID . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sticky_client_remove |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
- sticky_client_threshold_2g - Minimum signal level/threshold in dBm required for the 2G client to be serviced by the AP (-95 to -20). type: str
more...
|
Supported Version Ranges |
| sticky_client_threshold_2g |
v6.4.0 -> 7.6.6 |
- sticky_client_threshold_5g - Minimum signal level/threshold in dBm required for the 5G client to be serviced by the AP (-95 to -20). type: str
more...
|
Supported Version Ranges |
| sticky_client_threshold_5g |
v6.4.0 -> 7.6.6 |
- sticky_client_threshold_6g - Minimum signal level/threshold in dBm required for the 6G client to be serviced by the AP (-95 to -20). type: str
more...
|
Supported Version Ranges |
| sticky_client_threshold_6g |
v7.0.8 -> v7.0.12 |
v7.2.1 -> 7.6.6 |
- target_wake_time - Enable/disable 802.11ax target wake time . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| target_wake_time |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- tkip_counter_measure - Enable/disable TKIP counter measure. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tkip_counter_measure |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- tunnel_echo_interval - The time interval to send echo to both primary and secondary tunnel peers (1 - 65535 sec). type: int
more...
|
Supported Version Ranges |
| tunnel_echo_interval |
v6.2.0 -> 7.6.6 |
- tunnel_fallback_interval - The time interval for secondary tunnel to fall back to primary tunnel (0 - 65535 sec). type: int
more...
|
Supported Version Ranges |
| tunnel_fallback_interval |
v6.2.0 -> 7.6.6 |
- usergroup - Firewall user group to be used to authenticate WiFi users. type: list member_path: usergroup:name
more...
| Supported Version Ranges |
| usergroup |
v6.0.0 -> 7.6.6 |
- name - User group name. Source user.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- utm_log - Enable/disable UTM logging. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| utm_log |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- utm_profile - UTM profile name. Source wireless-controller.utm-profile.name. type: str
more...
|
Supported Version Ranges |
| utm_profile |
v6.0.0 -> 7.6.6 |
- utm_status - Enable to add one or more security profiles (AV, IPS, etc.) to the VAP. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| utm_status |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- vdom - Name of the VDOM that the Virtual AP has been added to. Source system.vdom.name. type: str
more...
|
Supported Version Ranges |
| vdom |
v6.0.0 -> v6.0.11 |
- vlan_auto - Enable/disable automatic management of SSID VLAN interface. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| vlan_auto |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- vlan_name - Table for mapping VLAN name to VLAN ID. type: list member_path: vlan_name:name
more...
| Supported Version Ranges |
| vlan_name |
v7.0.4 -> 7.6.6 |
- name - VLAN name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v7.0.4 -> 7.6.6 |
- vlan_id - VLAN IDs (maximum 8 VLAN IDs). type: list
- vlan_pool - VLAN pool. type: list member_path: vlan_pool:id
more...
| Supported Version Ranges |
| vlan_pool |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- wtp_group - WTP group name. Source wireless-controller.wtp-group.name. type: str
more...
|
Supported Version Ranges |
| wtp_group |
v6.0.0 -> 7.6.6 |
- vlan_pooling - Enable/disable VLAN pooling, to allow grouping of multiple wireless controller VLANs into VLAN pools . When set to wtp-group, VLAN pooling occurs with VLAN assignment by wtp-group. type: str choices: wtp-group, round-robin, hash, disable
more...
|
Supported Version Ranges |
| vlan_pooling |
v6.0.0 -> 7.6.6 |
| [wtp-group] |
v6.0.0 -> 7.6.6 |
| [round-robin] |
v6.0.0 -> 7.6.6 |
| [hash] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- vlanid - Optional VLAN ID. type: int
more...
|
Supported Version Ranges |
| vlanid |
v6.0.0 -> 7.6.6 |
- voice_enterprise - Enable/disable 802.11k and 802.11v assisted Voice-Enterprise roaming . type: str choices: disable, enable
more...
|
Supported Version Ranges |
| voice_enterprise |
v6.0.0 -> v7.4.1 |
| [disable] |
v6.0.0 -> v7.4.1 |
| [enable] |
v6.0.0 -> v7.4.1 |
- webfilter_profile - WebFilter profile name. Source webfilter.profile.name. type: str
more...
|
Supported Version Ranges |
| webfilter_profile |
v7.0.1 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure Virtual Access Points (VAPs).
fortinet.fortios.fortios_wireless_controller_vap:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
wireless_controller_vap:
access_control_list: " (source wireless-controller.access-control-list.name)"
acct_interim_interval: "43200"
additional_akms: "akm6"
address_group: " (source firewall.addrgrp.name)"
address_group_policy: "disable"
akm24_only: "disable"
alias: ""
antivirus_profile: " (source antivirus.profile.name)"
application_detection_engine: "enable"
application_dscp_marking: "enable"
application_list: " (source application.list.name)"
application_report_intv: "120"
atf_weight: "20"
auth: "radius"
auth_cert: " (source vpn.certificate.local.name)"
auth_portal_addr: ""
beacon_advertising: "name"
beacon_protection: "disable"
broadcast_ssid: "enable"
broadcast_suppression: "dhcp-up"
bss_color_partial: "enable"
bstm_disassociation_imminent: "enable"
bstm_load_balancing_disassoc_timer: "10"
bstm_rssi_disassoc_timer: "200"
called_station_id_type: "mac"
captive_network_assistant_bypass: "enable"
captive_portal: "enable"
captive_portal_ac_name: ""
captive_portal_auth_timeout: "0"
captive_portal_fw_accounting: "enable"
captive_portal_macauth_radius_secret: ""
captive_portal_macauth_radius_server: ""
captive_portal_radius_secret: ""
captive_portal_radius_server: ""
captive_portal_session_timeout_interval: "432000"
dhcp_address_enforcement: "enable"
dhcp_lease_time: "2400"
dhcp_option43_insertion: "enable"
dhcp_option82_circuit_id_insertion: "style-1"
dhcp_option82_insertion: "enable"
dhcp_option82_remote_id_insertion: "style-1"
domain_name_stripping: "disable"
dynamic_vlan: "enable"
eap_reauth: "enable"
eap_reauth_intv: "86400"
eapol_key_retries: "disable"
encrypt: "TKIP"
external_fast_roaming: "enable"
external_logout: ""
external_pre_auth: "enable"
external_web: ""
external_web_format: "auto-detect"
fast_bss_transition: "disable"
fast_roaming: "enable"
ft_mobility_domain: "1000"
ft_over_ds: "disable"
ft_r0_key_lifetime: "480"
gas_comeback_delay: "500"
gas_fragmentation_limit: "1024"
gtk_rekey: "enable"
gtk_rekey_intv: "86400"
high_efficiency: "enable"
hotspot20_profile: " (source wireless-controller.hotspot20.hs-profile.name)"
igmp_snooping: "enable"
intra_vap_privacy: "enable"
ip: ""
ips_sensor: " (source ips.sensor.name)"
ipv6_rules: "drop-icmp6ra"
key: ""
keyindex: "1"
l3_roaming: "enable"
l3_roaming_mode: "direct"
ldpc: "disable"
local_authentication: "enable"
local_bridging: "enable"
local_lan: "allow"
local_lan_partition: "enable"
local_standalone: "enable"
local_standalone_dns: "enable"
local_standalone_dns_ip: ""
local_standalone_nat: "enable"
mac_auth_bypass: "enable"
mac_called_station_delimiter: "hyphen"
mac_calling_station_delimiter: "hyphen"
mac_case: "uppercase"
mac_filter: "enable"
mac_filter_list:
-
id: "90"
mac: ""
mac_filter_policy: "allow"
mac_filter_policy_other: "allow"
mac_password_delimiter: "hyphen"
mac_username_delimiter: "hyphen"
max_clients: "0"
max_clients_ap: "0"
mbo: "disable"
mbo_cell_data_conn_pref: "excluded"
me_disable_thresh: "32"
mesh_backhaul: "enable"
mlo: "disable"
mpsk: "enable"
mpsk_concurrent_clients: "32767"
mpsk_key:
-
comment: "Comment."
concurrent_clients: ""
key_name: ""
mpsk_schedules:
-
name: "default_name_110 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
passphrase: ""
mpsk_profile: " (source wireless-controller.mpsk-profile.name)"
mu_mimo: "enable"
multicast_enhance: "enable"
multicast_rate: "0"
nac: "enable"
nac_profile: " (source wireless-controller.nac-profile.name)"
name: "default_name_118"
nas_filter_rule: "enable"
neighbor_report_dual_band: "disable"
okc: "disable"
osen: "enable"
owe_groups: "19"
owe_transition: "disable"
owe_transition_ssid: ""
passphrase: ""
pmf: "disable"
pmf_assoc_comeback_timeout: "1"
pmf_sa_query_retry_timeout: "2"
port_macauth: "disable"
port_macauth_reauth_timeout: "7200"
port_macauth_timeout: "600"
portal_message_override_group: " (source system.replacemsg-group.name)"
portal_message_overrides:
auth_disclaimer_page: ""
auth_login_failed_page: ""
auth_login_page: ""
auth_reject_page: ""
portal_type: "auth"
pre_auth: "enable"
primary_wag_profile: " (source wireless-controller.wag-profile.name)"
probe_resp_suppression: "enable"
probe_resp_threshold: ""
ptk_rekey: "enable"
ptk_rekey_intv: "86400"
qos_profile: " (source wireless-controller.qos-profile.name)"
quarantine: "enable"
radio_2g_threshold: ""
radio_5g_threshold: ""
radio_sensitivity: "enable"
radius_mac_auth: "enable"
radius_mac_auth_block_interval: "0"
radius_mac_auth_server: " (source user.radius.name)"
radius_mac_auth_usergroups:
-
name: "default_name_155 (source user.group.name)"
radius_mac_mpsk_auth: "enable"
radius_mac_mpsk_timeout: "86400"
radius_server: " (source user.radius.name)"
rates_11a: "6"
rates_11ac_mcs_map: ""
rates_11ac_ss12: "mcs0/1"
rates_11ac_ss34: "mcs0/3"
rates_11ax_mcs_map: ""
rates_11ax_ss12: "mcs0/1"
rates_11ax_ss34: "mcs0/3"
rates_11be_mcs_map: ""
rates_11be_mcs_map_160: ""
rates_11be_mcs_map_320: ""
rates_11bg: "1"
rates_11n_ss12: "mcs0/1"
rates_11n_ss34: "mcs16/3"
roaming_acct_interim_update: "enable"
sae_groups: "19"
sae_h2e_only: "enable"
sae_hnp_only: "enable"
sae_password: ""
sae_pk: "enable"
sae_private_key: ""
scan_botnet_connections: "disable"
schedule:
-
name: "default_name_181 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
secondary_wag_profile: " (source wireless-controller.wag-profile.name)"
security: "open"
security_exempt_list: " (source user.security-exempt-list.name)"
security_obsolete_option: "enable"
security_redirect_url: ""
selected_usergroups:
-
name: "default_name_188 (source user.group.name)"
set_80211k: "disable"
set_80211v: "disable"
split_tunneling: "enable"
ssid: ""
sticky_client_remove: "enable"
sticky_client_threshold_2g: ""
sticky_client_threshold_5g: ""
sticky_client_threshold_6g: ""
target_wake_time: "enable"
tkip_counter_measure: "enable"
tunnel_echo_interval: "300"
tunnel_fallback_interval: "7200"
usergroup:
-
name: "default_name_202 (source user.group.name)"
utm_log: "enable"
utm_profile: " (source wireless-controller.utm-profile.name)"
utm_status: "enable"
vdom: " (source system.vdom.name)"
vlan_auto: "enable"
vlan_name:
-
name: "default_name_209"
vlan_id: ""
vlan_pool:
-
id: "212"
wtp_group: " (source wireless-controller.wtp-group.name)"
vlan_pooling: "wtp-group"
vlanid: "0"
voice_enterprise: "disable"
webfilter_profile: " (source webfilter.profile.name)"
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.