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

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

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 ¶

access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
wireless_controller_wtp_profile - Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. type: dict

state - B(Deprecated) type: str required: False choices: present, absent
allowaccess - Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space. type: str choices: telnet, http, https, ssh
ap_country - Country in which this WTP, FortiAP or AP will operate . type: str 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
ble_profile - Bluetooth Low Energy profile name. Source wireless-controller.ble-profile.name. type: str
comment - Comment. type: str
control_message_offload - Enable/disable CAPWAP control message data channel offload. type: str choices: ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu
deny_mac_list - List of MAC addresses that are denied access to this WTP, FortiAP, or AP. type: list

id - ID. type: int required: True
mac - A WiFi device with this MAC address is denied access to this WTP, FortiAP or AP. type: str

dtls_in_kernel - Enable/disable data channel DTLS in kernel. type: str choices: enable, disable
dtls_policy - WTP data channel DTLS policy . type: str choices: clear-text, dtls-enabled, ipsec-vpn
energy_efficient_ethernet - Enable/disable use of energy efficient Ethernet on WTP. type: str choices: enable, disable
ext_info_enable - Enable/disable station/VAP/radio extension information. type: str choices: enable, disable
handoff_roaming - Enable/disable client load balancing during roaming to avoid roaming delay . type: str choices: enable, disable
handoff_rssi - Minimum received signal strength indicator (RSSI) value for handoff (20 - 30). type: int
handoff_sta_thresh - Threshold value for AP handoff (5 - 35). type: int
ip_fragment_preventing - Select how to prevent IP fragmentation for CAPWAP tunneled control and data packets . type: str choices: tcp-mss-adjust, icmp-unreachable
lan - WTP LAN port mapping. type: dict

port_mode - LAN port mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port_ssid - Bridge LAN port to SSID. Source wireless-controller.vap.name. type: str
port1_mode - LAN port 1 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port1_ssid - Bridge LAN port 1 to SSID. Source wireless-controller.vap.name. type: str
port2_mode - LAN port 2 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port2_ssid - Bridge LAN port 2 to SSID. Source wireless-controller.vap.name. type: str
port3_mode - LAN port 3 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port3_ssid - Bridge LAN port 3 to SSID. Source wireless-controller.vap.name. type: str
port4_mode - LAN port 4 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port4_ssid - Bridge LAN port 4 to SSID. Source wireless-controller.vap.name. type: str
port5_mode - LAN port 5 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port5_ssid - Bridge LAN port 5 to SSID. Source wireless-controller.vap.name. type: str
port6_mode - LAN port 6 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port6_ssid - Bridge LAN port 6 to SSID. Source wireless-controller.vap.name. type: str
port7_mode - LAN port 7 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port7_ssid - Bridge LAN port 7 to SSID. Source wireless-controller.vap.name. type: str
port8_mode - LAN port 8 mode. type: str choices: offline, nat-to-wan, bridge-to-wan, bridge-to-ssid
port8_ssid - Bridge LAN port 8 to SSID. Source wireless-controller.vap.name. type: str

lbs - Set various location based service (LBS) options. type: dict

aeroscout - Enable/disable AeroScout Real Time Location Service (RTLS) support. type: str choices: enable, disable
aeroscout_ap_mac - Use BSSID or board MAC address as AP MAC address in the Aeroscout AP message. type: str choices: bssid, board-mac
aeroscout_mmu_report - Enable/disable MU compounded report. type: str choices: enable, disable
aeroscout_mu - Enable/disable AeroScout support. type: str choices: enable, disable
aeroscout_mu_factor - AeroScout Mobile Unit (MU) mode dilution factor . type: int
aeroscout_mu_timeout - AeroScout MU mode timeout (0 - 65535 sec). type: int
aeroscout_server_ip - IP address of AeroScout server. type: str
aeroscout_server_port - AeroScout server UDP listening port. type: int
ekahau_blink_mode - Enable/disable Ekahua blink mode (also called AiRISTA Flow Blink Mode) to find the location of devices connected to a wireless LAN . type: str choices: enable, disable
ekahau_tag - WiFi frame MAC address or WiFi Tag. type: str
erc_server_ip - IP address of Ekahua RTLS Controller (ERC). type: str
erc_server_port - Ekahua RTLS Controller (ERC) UDP listening port. type: int
fortipresence - Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they don"t connect to this WiFi network . type: str choices: foreign, both, disable
fortipresence_frequency - FortiPresence report transmit frequency (5 - 65535 sec). type: int
fortipresence_port - FortiPresence server UDP listening port . type: int
fortipresence_project - FortiPresence project name (max. 16 characters). type: str
fortipresence_rogue - Enable/disable FortiPresence finding and reporting rogue APs. type: str choices: enable, disable
fortipresence_secret - FortiPresence secret password (max. 16 characters). type: str
fortipresence_server - FortiPresence server IP address. type: str
fortipresence_unassoc - Enable/disable FortiPresence finding and reporting unassociated stations. type: str choices: enable, disable
station_locate - Enable/disable client station locating services for all clients, whether associated or not . type: str choices: enable, disable

led_schedules - 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. type: list

name - LED schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name. type: str required: True

led_state - Enable/disable use of LEDs on WTP . type: str choices: enable, disable
lldp - Enable/disable Link Layer Discovery Protocol (LLDP) for the WTP, FortiAP, or AP . type: str choices: enable, disable
login_passwd - Set the managed WTP, FortiAP, or AP"s administrator password. type: str
login_passwd_change - Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no). type: str choices: True, default, False
max_clients - Maximum number of stations (STAs) supported by the WTP . type: int
name - WTP (or FortiAP or AP) profile name. type: str required: True
platform - WTP, FortiAP, or AP platform. type: dict

type - 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. type: str 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

poe_mode - Set the WTP, FortiAP, or AP"s PoE mode. type: str choices: auto, 8023af, 8023at, power-adapter
radio_1 - Configuration options for radio 1. type: dict

amsdu - Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . type: str choices: enable, disable
ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
ap_sniffer_addr - MAC address to monitor. type: str
ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
ap_sniffer_chan - Channel on which to operate the sniffer . type: int
ap_sniffer_ctl - Enable/disable sniffer on WiFi control frame . type: str choices: enable, disable
ap_sniffer_data - Enable/disable sniffer on WiFi data frame . type: str choices: enable, disable
ap_sniffer_mgmt_beacon - Enable/disable sniffer on WiFi management Beacon frames . type: str choices: enable, disable
ap_sniffer_mgmt_other - Enable/disable sniffer on WiFi management other frames . type: str choices: enable, disable
ap_sniffer_mgmt_probe - Enable/disable sniffer on WiFi management probe frames . type: str choices: enable, disable
auto_power_high - Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type). type: int
auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
auto_power_low - Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). type: int
band - WiFi band that Radio 1 operates on. type: str 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
bandwidth_admission_control - 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. type: str choices: enable, disable
bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
beacon_interval - Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type). type: int
call_admission_control - 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. type: str choices: enable, disable
call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). type: int
channel - Selected list of wireless radio channels. type: list

chan - Channel number. type: str required: True

channel_bonding - Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 80MHz, 40MHz, 20MHz
channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
coexistence - Enable/disable allowing both HT20 and HT40 on the same radio . type: str choices: enable, disable
darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . type: str choices: enable, disable
dtim - DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255). Set higher to save client battery life. type: int
frag_threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). type: int
frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
max_clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. type: int
max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
mode - Mode of radio 1. Radio 1 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. type: str choices: disabled, ap, monitor, sniffer
power_level - Radio power level as a percentage of the maximum transmit power (0 - 100). type: int
powersave_optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: str choices: tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow
protection_mode - Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). type: str choices: rtscts, ctsonly, disable
radio_id - radio-id type: int
rts_threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). type: int
short_guard_interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: enable, disable
spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, disable
transmit_optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. type: str choices: disable, power-save, aggr-limit, retry-limit, send-bar
vap_all - Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) . type: str choices: enable, disable
vaps - Manually selected list of Virtual Access Points (VAPs). type: list

name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name wireless-controller.vap.name. type: str required: True

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

radio_2 - Configuration options for radio 2. type: dict

amsdu - Enable/disable 802.11n AMSDU support. AMSDU can improve performance if supported by your WiFi clients . type: str choices: enable, disable
ap_handoff - Enable/disable AP handoff of clients to other APs . type: str choices: enable, disable
ap_sniffer_addr - MAC address to monitor. type: str
ap_sniffer_bufsize - Sniffer buffer size (1 - 32 MB). type: int
ap_sniffer_chan - Channel on which to operate the sniffer . type: int
ap_sniffer_ctl - Enable/disable sniffer on WiFi control frame . type: str choices: enable, disable
ap_sniffer_data - Enable/disable sniffer on WiFi data frame . type: str choices: enable, disable
ap_sniffer_mgmt_beacon - Enable/disable sniffer on WiFi management Beacon frames . type: str choices: enable, disable
ap_sniffer_mgmt_other - Enable/disable sniffer on WiFi management other frames . type: str choices: enable, disable
ap_sniffer_mgmt_probe - Enable/disable sniffer on WiFi management probe frames . type: str choices: enable, disable
auto_power_high - Automatic transmit power high limit in dBm (the actual range of transmit power depends on the AP platform type). type: int
auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
auto_power_low - Automatic transmission power low limit in dBm (the actual range of transmit power depends on the AP platform type). type: int
band - WiFi band that Radio 2 operates on. type: str 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
bandwidth_admission_control - 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. type: str choices: enable, disable
bandwidth_capacity - Maximum bandwidth capacity allowed (1 - 600000 Kbps). type: int
beacon_interval - Beacon interval. The time between beacon frames in msec (the actual range of beacon interval depends on the AP platform type). type: int
call_admission_control - 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. type: str choices: enable, disable
call_capacity - Maximum number of Voice over WLAN (VoWLAN) phones supported by the radio (0 - 60). type: int
channel - Selected list of wireless radio channels. type: list

chan - Channel number. type: str required: True

channel_bonding - Channel bandwidth: 80, 40, or 20MHz. Channels may use both 20 and 40 by enabling coexistence. type: str choices: 80MHz, 40MHz, 20MHz
channel_utilization - Enable/disable measuring channel utilization. type: str choices: enable, disable
coexistence - Enable/disable allowing both HT20 and HT40 on the same radio . type: str choices: enable, disable
darrp - Enable/disable Distributed Automatic Radio Resource Provisioning (DARRP) to make sure the radio is always using the most optimal channel . type: str choices: enable, disable
dtim - DTIM interval. The frequency to transmit Delivery Traffic Indication Message (or Map) (DTIM) messages (1 - 255). Set higher to save client battery life. type: int
frag_threshold - Maximum packet size that can be sent without fragmentation (800 - 2346 bytes). type: int
frequency_handoff - Enable/disable frequency handoff of clients to other channels . type: str choices: enable, disable
max_clients - Maximum number of stations (STAs) or WiFi clients supported by the radio. Range depends on the hardware. type: int
max_distance - Maximum expected distance between the AP and clients (0 - 54000 m). type: int
mode - Mode of radio 2. Radio 2 can be disabled, configured as an access point, a rogue AP monitor, or a sniffer. type: str choices: disabled, ap, monitor, sniffer
power_level - Radio power level as a percentage of the maximum transmit power (0 - 100). type: int
powersave_optimize - Enable client power-saving features such as TIM, AC VO, and OBSS etc. type: str choices: tim, ac-vo, no-obss-scan, no-11b-rate, client-rate-follow
protection_mode - Enable/disable 802.11g protection modes to support backwards compatibility with older clients (rtscts, ctsonly, disable). type: str choices: rtscts, ctsonly, disable
radio_id - radio-id type: int
rts_threshold - Maximum packet size for RTS transmissions, specifying the maximum size of a data packet before RTS/CTS (256 - 2346 bytes). type: int
short_guard_interval - Use either the short guard interval (Short GI) of 400 ns or the long guard interval (Long GI) of 800 ns. type: str choices: enable, disable
spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, disable
transmit_optimize - Packet transmission optimization options including power saving, aggregation limiting, retry limiting, etc. All are enabled by default. type: str choices: disable, power-save, aggr-limit, retry-limit, send-bar
vap_all - Enable/disable the automatic inheritance of all Virtual Access Points (VAPs) . type: str choices: enable, disable
vaps - Manually selected list of Virtual Access Points (VAPs). type: list

name - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name wireless-controller.vap.name. type: str required: True

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

split_tunneling_acl - Split tunneling ACL filter list. type: list

dest_ip - Destination IP and mask for the split-tunneling subnet. type: str
id - ID. type: int required: True

split_tunneling_acl_local_ap_subnet - Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL . type: str choices: enable, disable
split_tunneling_acl_path - Split tunneling ACL path is local/tunnel. type: str choices: tunnel, local
tun_mtu_downlink - Downlink CAPWAP tunnel MTU (0, 576, or 1500 bytes). type: int
tun_mtu_uplink - Uplink CAPWAP tunnel MTU (0, 576, or 1500 bytes). type: int
wan_port_mode - Enable/disable using a WAN port as a LAN port. type: str choices: wan-lan, wan-only

Notes ¶

Note

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

Examples ¶

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms.
    fortios_wireless_controller_wtp_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_wtp_profile:
        allowaccess: "telnet"
        ap_country: "NA"
        ble_profile: "<your_own_value> (source wireless-controller.ble-profile.name)"
        comment: "Comment."
        control_message_offload: "ebp-frame"
        deny_mac_list:
         -
            id:  "9"
            mac: "<your_own_value>"
        dtls_in_kernel: "enable"
        dtls_policy: "clear-text"
        energy_efficient_ethernet: "enable"
        ext_info_enable: "enable"
        handoff_roaming: "enable"
        handoff_rssi: "16"
        handoff_sta_thresh: "17"
        ip_fragment_preventing: "tcp-mss-adjust"
        lan:
            port_mode: "offline"
            port_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port1_mode: "offline"
            port1_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port2_mode: "offline"
            port2_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port3_mode: "offline"
            port3_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port4_mode: "offline"
            port4_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port5_mode: "offline"
            port5_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port6_mode: "offline"
            port6_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port7_mode: "offline"
            port7_ssid: "<your_own_value> (source wireless-controller.vap.name)"
            port8_mode: "offline"
            port8_ssid: "<your_own_value> (source wireless-controller.vap.name)"
        lbs:
            aeroscout: "enable"
            aeroscout_ap_mac: "bssid"
            aeroscout_mmu_report: "enable"
            aeroscout_mu: "enable"
            aeroscout_mu_factor: "43"
            aeroscout_mu_timeout: "44"
            aeroscout_server_ip: "<your_own_value>"
            aeroscout_server_port: "46"
            ekahau_blink_mode: "enable"
            ekahau_tag: "<your_own_value>"
            erc_server_ip: "<your_own_value>"
            erc_server_port: "50"
            fortipresence: "foreign"
            fortipresence_frequency: "52"
            fortipresence_port: "53"
            fortipresence_project: "<your_own_value>"
            fortipresence_rogue: "enable"
            fortipresence_secret: "<your_own_value>"
            fortipresence_server: "<your_own_value>"
            fortipresence_unassoc: "enable"
            station_locate: "enable"
        led_schedules:
         -
            name: "default_name_61 (source firewall.schedule.group.name firewall.schedule.recurring.name)"
        led_state: "enable"
        lldp: "enable"
        login_passwd: "<your_own_value>"
        login_passwd_change: "yes"
        max_clients: "66"
        name: "default_name_67"
        platform:
            type: "AP-11N"
        poe_mode: "auto"
        radio_1:
            amsdu: "enable"
            ap_handoff: "enable"
            ap_sniffer_addr: "<your_own_value>"
            ap_sniffer_bufsize: "75"
            ap_sniffer_chan: "76"
            ap_sniffer_ctl: "enable"
            ap_sniffer_data: "enable"
            ap_sniffer_mgmt_beacon: "enable"
            ap_sniffer_mgmt_other: "enable"
            ap_sniffer_mgmt_probe: "enable"
            auto_power_high: "82"
            auto_power_level: "enable"
            auto_power_low: "84"
            band: "802.11a"
            bandwidth_admission_control: "enable"
            bandwidth_capacity: "87"
            beacon_interval: "88"
            call_admission_control: "enable"
            call_capacity: "90"
            channel:
             -
                chan: "<your_own_value>"
            channel_bonding: "80MHz"
            channel_utilization: "enable"
            coexistence: "enable"
            darrp: "enable"
            dtim: "97"
            frag_threshold: "98"
            frequency_handoff: "enable"
            max_clients: "100"
            max_distance: "101"
            mode: "disabled"
            power_level: "103"
            powersave_optimize: "tim"
            protection_mode: "rtscts"
            radio_id: "106"
            rts_threshold: "107"
            short_guard_interval: "enable"
            spectrum_analysis: "enable"
            transmit_optimize: "disable"
            vap_all: "enable"
            vaps:
             -
                name: "default_name_113 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
            wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
        radio_2:
            amsdu: "enable"
            ap_handoff: "enable"
            ap_sniffer_addr: "<your_own_value>"
            ap_sniffer_bufsize: "119"
            ap_sniffer_chan: "120"
            ap_sniffer_ctl: "enable"
            ap_sniffer_data: "enable"
            ap_sniffer_mgmt_beacon: "enable"
            ap_sniffer_mgmt_other: "enable"
            ap_sniffer_mgmt_probe: "enable"
            auto_power_high: "126"
            auto_power_level: "enable"
            auto_power_low: "128"
            band: "802.11a"
            bandwidth_admission_control: "enable"
            bandwidth_capacity: "131"
            beacon_interval: "132"
            call_admission_control: "enable"
            call_capacity: "134"
            channel:
             -
                chan: "<your_own_value>"
            channel_bonding: "80MHz"
            channel_utilization: "enable"
            coexistence: "enable"
            darrp: "enable"
            dtim: "141"
            frag_threshold: "142"
            frequency_handoff: "enable"
            max_clients: "144"
            max_distance: "145"
            mode: "disabled"
            power_level: "147"
            powersave_optimize: "tim"
            protection_mode: "rtscts"
            radio_id: "150"
            rts_threshold: "151"
            short_guard_interval: "enable"
            spectrum_analysis: "enable"
            transmit_optimize: "disable"
            vap_all: "enable"
            vaps:
             -
                name: "default_name_157 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
            wids_profile: "<your_own_value> (source wireless-controller.wids-profile.name)"
        split_tunneling_acl:
         -
            dest_ip: "<your_own_value>"
            id:  "161"
        split_tunneling_acl_local_ap_subnet: "enable"
        split_tunneling_acl_path: "tunnel"
        tun_mtu_downlink: "164"
        tun_mtu_uplink: "165"
        wan_port_mode: "wan-lan"

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:

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.