fortinet.fortios.fortios_wireless_controller_wtp (2.3.6) — module

Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
  fortinet.fortios.fortios_wireless_controller_wtp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_wtp:
          admin: "discovered"
          allowaccess: "https"
          apcfg_profile: "<your_own_value> (source wireless-controller.apcfg-profile.name)"
          ble_major_id: "0"
          ble_minor_id: "0"
          bonjour_profile: "<your_own_value> (source wireless-controller.bonjour-profile.name)"
          coordinate_enable: "enable"
          coordinate_latitude: "<your_own_value>"
          coordinate_longitude: "<your_own_value>"
          coordinate_x: "<your_own_value>"
          coordinate_y: "<your_own_value>"
          firmware_provision: "<your_own_value>"
          firmware_provision_latest: "disable"
          image_download: "enable"
          index: "0"
          ip_fragment_preventing: "tcp-mss-adjust"
          lan:
              port_esl_mode: "offline"
              port_esl_ssid: "<your_own_value> (source system.interface.name)"
              port_mode: "offline"
              port_ssid: "<your_own_value> (source system.interface.name)"
              port1_mode: "offline"
              port1_ssid: "<your_own_value> (source system.interface.name)"
              port2_mode: "offline"
              port2_ssid: "<your_own_value> (source system.interface.name)"
              port3_mode: "offline"
              port3_ssid: "<your_own_value> (source system.interface.name)"
              port4_mode: "offline"
              port4_ssid: "<your_own_value> (source system.interface.name)"
              port5_mode: "offline"
              port5_ssid: "<your_own_value> (source system.interface.name)"
              port6_mode: "offline"
              port6_ssid: "<your_own_value> (source system.interface.name)"
              port7_mode: "offline"
              port7_ssid: "<your_own_value> (source system.interface.name)"
              port8_mode: "offline"
              port8_ssid: "<your_own_value> (source system.interface.name)"
          led_state: "enable"
          location: "<your_own_value>"
          login_passwd: "<your_own_value>"
          login_passwd_change: "yes"
          mesh_bridge_enable: "default"
          name: "default_name_45"
          override_allowaccess: "enable"
          override_ip_fragment: "enable"
          override_lan: "enable"
          override_led_state: "enable"
          override_login_passwd_change: "enable"
          override_split_tunnel: "enable"
          override_wan_port_mode: "enable"
          purdue_level: "1"
          radio_1:
              auto_power_high: "17"
              auto_power_level: "enable"
              auto_power_low: "10"
              auto_power_target: "<your_own_value>"
              band: "802.11a"
              channel:
                  -
                      chan: "<your_own_value>"
              drma_manual_mode: "ap"
              override_analysis: "enable"
              override_band: "enable"
              override_channel: "enable"
              override_txpower: "enable"
              override_vaps: "enable"
              power_level: "100"
              power_mode: "dBm"
              power_value: "27"
              radio_id: "2"
              spectrum_analysis: "enable"
              vap_all: "tunnel"
              vaps:
                  -
                      name: "default_name_75 (source wireless-controller.vap-group.name system.interface.name)"
          radio_2:
              auto_power_high: "17"
              auto_power_level: "enable"
              auto_power_low: "10"
              auto_power_target: "<your_own_value>"
              band: "802.11a"
              channel:
                  -
                      chan: "<your_own_value>"
              drma_manual_mode: "ap"
              override_analysis: "enable"
              override_band: "enable"
              override_channel: "enable"
              override_txpower: "enable"
              override_vaps: "enable"
              power_level: "100"
              power_mode: "dBm"
              power_value: "27"
              radio_id: "2"
              spectrum_analysis: "enable"
              vap_all: "tunnel"
              vaps:
                  -
                      name: "default_name_97 (source wireless-controller.vap-group.name system.interface.name)"
          radio_3:
              auto_power_high: "17"
              auto_power_level: "enable"
              auto_power_low: "10"
              auto_power_target: "<your_own_value>"
              band: "802.11a"
              channel:
                  -
                      chan: "<your_own_value>"
              drma_manual_mode: "ap"
              override_analysis: "enable"
              override_band: "enable"
              override_channel: "enable"
              override_txpower: "enable"
              override_vaps: "enable"
              power_level: "100"
              power_mode: "dBm"
              power_value: "27"
              radio_id: "2"
              spectrum_analysis: "enable"
              vap_all: "tunnel"
              vaps:
                  -
                      name: "default_name_119 (source wireless-controller.vap-group.name system.interface.name)"
          radio_4:
              auto_power_high: "17"
              auto_power_level: "enable"
              auto_power_low: "10"
              auto_power_target: "<your_own_value>"
              band: "802.11a"
              channel:
                  -
                      chan: "<your_own_value>"
              drma_manual_mode: "ap"
              override_analysis: "enable"
              override_band: "enable"
              override_channel: "enable"
              override_txpower: "enable"
              override_vaps: "enable"
              power_level: "100"
              power_mode: "dBm"
              power_value: "27"
              spectrum_analysis: "enable"
              vap_all: "tunnel"
              vaps:
                  -
                      name: "default_name_140 (source wireless-controller.vap-group.name system.interface.name)"
          region: "<your_own_value> (source wireless-controller.region.name)"
          region_x: "<your_own_value>"
          region_y: "<your_own_value>"
          split_tunneling_acl:
              -
                  dest_ip: "<your_own_value>"
                  id: "146"
          split_tunneling_acl_local_ap_subnet: "enable"
          split_tunneling_acl_path: "tunnel"
          tun_mtu_downlink: "0"
          tun_mtu_uplink: "0"
          uuid: "<your_own_value>"
          wan_port_mode: "wan-lan"
          wtp_id: "<your_own_value>"
          wtp_mode: "normal"
          wtp_profile: "<your_own_value> (source wireless-controller.wtp-profile.name)"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

wireless_controller_wtp:
    default: null
    description:
    - Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed
      by FortiGate.
    suboptions:
      admin:
        choices:
        - discovered
        - disable
        - enable
        description:
        - Configure how the FortiGate operating as a wireless controller discovers and
          manages this WTP, AP or FortiAP.
        type: str
      allowaccess:
        choices:
        - https
        - ssh
        - snmp
        - telnet
        - http
        description:
        - Control management access to the managed WTP, FortiAP, or AP. Separate entries
          with a space.
        elements: str
        type: list
      apcfg_profile:
        description:
        - AP local configuration profile name. Source wireless-controller.apcfg-profile.name.
        type: str
      ble_major_id:
        description:
        - Override BLE Major ID.
        type: int
      ble_minor_id:
        description:
        - Override BLE Minor ID.
        type: int
      bonjour_profile:
        description:
        - Bonjour profile name. Source wireless-controller.bonjour-profile.name.
        type: str
      coordinate_enable:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WTP coordinates (X,Y axis).
        type: str
      coordinate_latitude:
        description:
        - WTP latitude coordinate.
        type: str
      coordinate_longitude:
        description:
        - WTP longitude coordinate.
        type: str
      coordinate_x:
        description:
        - X axis coordinate.
        type: str
      coordinate_y:
        description:
        - Y axis coordinate.
        type: str
      firmware_provision:
        description:
        - Firmware version to provision to this FortiAP on bootup (major.minor.build,
          i.e. 6.2.1234).
        type: str
      firmware_provision_latest:
        choices:
        - disable
        - once
        description:
        - Enable/disable one-time automatic provisioning of the latest firmware version.
        type: str
      image_download:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WTP image download.
        type: str
      index:
        description:
        - Index (0 - 4294967295).
        type: int
      ip_fragment_preventing:
        choices:
        - tcp-mss-adjust
        - icmp-unreachable
        description:
        - Method(s) by which IP fragmentation is prevented for control and data packets
          through CAPWAP tunnel .
        elements: str
        type: list
      lan:
        description:
        - WTP LAN port mapping.
        suboptions:
          port1_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 1 mode.
            type: str
          port1_ssid:
            description:
            - Bridge LAN port 1 to SSID. Source system.interface.name.
            type: str
          port2_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 2 mode.
            type: str
          port2_ssid:
            description:
            - Bridge LAN port 2 to SSID. Source system.interface.name.
            type: str
          port3_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 3 mode.
            type: str
          port3_ssid:
            description:
            - Bridge LAN port 3 to SSID. Source system.interface.name.
            type: str
          port4_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 4 mode.
            type: str
          port4_ssid:
            description:
            - Bridge LAN port 4 to SSID. Source system.interface.name.
            type: str
          port5_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 5 mode.
            type: str
          port5_ssid:
            description:
            - Bridge LAN port 5 to SSID. Source system.interface.name.
            type: str
          port6_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 6 mode.
            type: str
          port6_ssid:
            description:
            - Bridge LAN port 6 to SSID. Source system.interface.name.
            type: str
          port7_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 7 mode.
            type: str
          port7_ssid:
            description:
            - Bridge LAN port 7 to SSID. Source system.interface.name.
            type: str
          port8_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port 8 mode.
            type: str
          port8_ssid:
            description:
            - Bridge LAN port 8 to SSID. Source system.interface.name.
            type: str
          port_esl_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - ESL port mode.
            type: str
          port_esl_ssid:
            description:
            - Bridge ESL port to SSID. Source system.interface.name.
            type: str
          port_mode:
            choices:
            - offline
            - nat-to-wan
            - bridge-to-wan
            - bridge-to-ssid
            description:
            - LAN port mode.
            type: str
          port_ssid:
            description:
            - Bridge LAN port to SSID. Source system.interface.name.
            type: str
        type: dict
      led_state:
        choices:
        - enable
        - disable
        description:
        - Enable to allow the FortiAPs LEDs to light. Disable to keep the LEDs off. You
          may want to keep the LEDs off so they are not distracting in low light areas
          etc.
        type: str
      location:
        description:
        - Field for describing the physical location of the WTP, AP or FortiAP.
        type: str
      login_passwd:
        description:
        - Set the managed WTP, FortiAP, or AP"s administrator password.
        type: str
      login_passwd_change:
        choices:
        - 'yes'
        - default
        - 'no'
        description:
        - Change or reset the administrator password of a managed WTP, FortiAP or AP (yes,
          default, or no).
        type: str
      mesh_bridge_enable:
        choices:
        - default
        - enable
        - disable
        description:
        - Enable/disable mesh Ethernet bridge when WTP is configured as a mesh branch/leaf
          AP.
        type: str
      name:
        description:
        - WTP, AP or FortiAP configuration name.
        type: str
      override_allowaccess:
        choices:
        - enable
        - disable
        description:
        - Enable to override the WTP profile management access configuration.
        type: str
      override_ip_fragment:
        choices:
        - enable
        - disable
        description:
        - Enable/disable overriding the WTP profile IP fragment prevention setting.
        type: str
      override_lan:
        choices:
        - enable
        - disable
        description:
        - Enable to override the WTP profile LAN port setting.
        type: str
      override_led_state:
        choices:
        - enable
        - disable
        description:
        - Enable to override the profile LED state setting for this FortiAP. You must
          enable this option to use the led-state command to turn off the FortiAP"s LEDs.
        type: str
      override_login_passwd_change:
        choices:
        - enable
        - disable
        description:
        - Enable to override the WTP profile login-password (administrator password) setting.
        type: str
      override_split_tunnel:
        choices:
        - enable
        - disable
        description:
        - Enable/disable overriding the WTP profile split tunneling setting.
        type: str
      override_wan_port_mode:
        choices:
        - enable
        - disable
        description:
        - Enable/disable overriding the wan-port-mode in the WTP profile.
        type: str
      purdue_level:
        choices:
        - '1'
        - '1.5'
        - '2'
        - '2.5'
        - '3'
        - '3.5'
        - '4'
        - '5'
        - '5.5'
        description:
        - Purdue Level of this WTP.
        type: str
      radio_1:
        description:
        - Configuration options for radio 1.
        suboptions:
          auto_power_high:
            description:
            - The upper bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_level:
            choices:
            - enable
            - disable
            description:
            - Enable/disable automatic power-level adjustment to prevent co-channel interference
              .
            type: str
          auto_power_low:
            description:
            - The lower bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_target:
            description:
            - Target of automatic transmit power adjustment in dBm (-95 to -20).
            type: str
          band:
            choices:
            - 802.11a
            - 802.11b
            - 802.11g
            - 802.11n
            - 802.11n-5G
            - 802.11ac
            - 802.11ax-5G
            - 802.11ax
            - 802.11ac-2G
            - 802.11ax-6G
            - 802.11n,g-only
            - 802.11g-only
            - 802.11n-only
            - 802.11n-5G-only
            - 802.11ac,n-only
            - 802.11ac-only
            - 802.11ax,ac-only
            - 802.11ax,ac,n-only
            - 802.11ax-5G-only
            - 802.11ax,n-only
            - 802.11ax,n,g-only
            - 802.11ax-only
            description:
            - WiFi band that Radio 1 operates on.
            type: str
          channel:
            description:
            - Selected list of wireless radio channels.
            elements: dict
            suboptions:
              chan:
                description:
                - Channel number.
                required: true
                type: str
            type: list
          drma_manual_mode:
            choices:
            - ap
            - monitor
            - ncf
            - ncf-peek
            description:
            - Radio mode to be used for DRMA manual mode .
            type: str
          override_analysis:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile spectrum analysis configuration.
            type: str
          override_band:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile band setting.
            type: str
          override_channel:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile channel settings.
            type: str
          override_txpower:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile power level configuration.
            type: str
          override_vaps:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile Virtual Access Point (VAP) settings.
            type: str
          power_level:
            description:
            - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100).
            type: int
          power_mode:
            choices:
            - dBm
            - percentage
            description:
            - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage
              of the maximum EIRP . This power takes into account both radio transmit
              power and antenna gain. Higher power level settings may be constrained by
              local regulatory requirements and AP capabilities.
            type: str
          power_value:
            description:
            - Radio EIRP power in dBm (1 - 33).
            type: int
          radio_id:
            description:
            - radio-id
            type: int
          spectrum_analysis:
            choices:
            - enable
            - scan-only
            - disable
            description:
            - Enable/disable spectrum analysis to find interference that would negatively
              impact wireless performance.
            type: str
          vap_all:
            choices:
            - tunnel
            - bridge
            - manual
            - enable
            - disable
            description:
            - Configure method for assigning SSIDs to this FortiAP .
            type: str
          vaps:
            description:
            - Manually selected list of Virtual Access Points (VAPs).
            elements: dict
            suboptions:
              name:
                description:
                - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name
                  system.interface.name.
                required: true
                type: str
            type: list
        type: dict
      radio_2:
        description:
        - Configuration options for radio 2.
        suboptions:
          auto_power_high:
            description:
            - The upper bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_level:
            choices:
            - enable
            - disable
            description:
            - Enable/disable automatic power-level adjustment to prevent co-channel interference
              .
            type: str
          auto_power_low:
            description:
            - The lower bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_target:
            description:
            - Target of automatic transmit power adjustment in dBm (-95 to -20).
            type: str
          band:
            choices:
            - 802.11a
            - 802.11b
            - 802.11g
            - 802.11n
            - 802.11n-5G
            - 802.11ac
            - 802.11ax-5G
            - 802.11ax
            - 802.11ac-2G
            - 802.11ax-6G
            - 802.11n,g-only
            - 802.11g-only
            - 802.11n-only
            - 802.11n-5G-only
            - 802.11ac,n-only
            - 802.11ac-only
            - 802.11ax,ac-only
            - 802.11ax,ac,n-only
            - 802.11ax-5G-only
            - 802.11ax,n-only
            - 802.11ax,n,g-only
            - 802.11ax-only
            description:
            - WiFi band that Radio 2 operates on.
            type: str
          channel:
            description:
            - Selected list of wireless radio channels.
            elements: dict
            suboptions:
              chan:
                description:
                - Channel number.
                required: true
                type: str
            type: list
          drma_manual_mode:
            choices:
            - ap
            - monitor
            - ncf
            - ncf-peek
            description:
            - Radio mode to be used for DRMA manual mode .
            type: str
          override_analysis:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile spectrum analysis configuration.
            type: str
          override_band:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile band setting.
            type: str
          override_channel:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile channel settings.
            type: str
          override_txpower:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile power level configuration.
            type: str
          override_vaps:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile Virtual Access Point (VAP) settings.
            type: str
          power_level:
            description:
            - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100).
            type: int
          power_mode:
            choices:
            - dBm
            - percentage
            description:
            - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage
              of the maximum EIRP . This power takes into account both radio transmit
              power and antenna gain. Higher power level settings may be constrained by
              local regulatory requirements and AP capabilities.
            type: str
          power_value:
            description:
            - Radio EIRP power in dBm (1 - 33).
            type: int
          radio_id:
            description:
            - radio-id
            type: int
          spectrum_analysis:
            choices:
            - enable
            - scan-only
            - disable
            description:
            - Enable/disable spectrum analysis to find interference that would negatively
              impact wireless performance.
            type: str
          vap_all:
            choices:
            - tunnel
            - bridge
            - manual
            - enable
            - disable
            description:
            - Configure method for assigning SSIDs to this FortiAP .
            type: str
          vaps:
            description:
            - Manually selected list of Virtual Access Points (VAPs).
            elements: dict
            suboptions:
              name:
                description:
                - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name
                  system.interface.name.
                required: true
                type: str
            type: list
        type: dict
      radio_3:
        description:
        - Configuration options for radio 3.
        suboptions:
          auto_power_high:
            description:
            - The upper bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_level:
            choices:
            - enable
            - disable
            description:
            - Enable/disable automatic power-level adjustment to prevent co-channel interference
              .
            type: str
          auto_power_low:
            description:
            - The lower bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_target:
            description:
            - Target of automatic transmit power adjustment in dBm (-95 to -20).
            type: str
          band:
            choices:
            - 802.11a
            - 802.11b
            - 802.11g
            - 802.11n
            - 802.11n-5G
            - 802.11ac
            - 802.11ax-5G
            - 802.11ax
            - 802.11ac-2G
            - 802.11ax-6G
            - 802.11n,g-only
            - 802.11g-only
            - 802.11n-only
            - 802.11n-5G-only
            - 802.11ac,n-only
            - 802.11ac-only
            - 802.11ax,ac-only
            - 802.11ax,ac,n-only
            - 802.11ax-5G-only
            - 802.11ax,n-only
            - 802.11ax,n,g-only
            - 802.11ax-only
            description:
            - WiFi band that Radio 3 operates on.
            type: str
          channel:
            description:
            - Selected list of wireless radio channels.
            elements: dict
            suboptions:
              chan:
                description:
                - Channel number.
                required: true
                type: str
            type: list
          drma_manual_mode:
            choices:
            - ap
            - monitor
            - ncf
            - ncf-peek
            description:
            - Radio mode to be used for DRMA manual mode .
            type: str
          override_analysis:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile spectrum analysis configuration.
            type: str
          override_band:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile band setting.
            type: str
          override_channel:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile channel settings.
            type: str
          override_txpower:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile power level configuration.
            type: str
          override_vaps:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile Virtual Access Point (VAP) settings.
            type: str
          power_level:
            description:
            - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100).
            type: int
          power_mode:
            choices:
            - dBm
            - percentage
            description:
            - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage
              of the maximum EIRP . This power takes into account both radio transmit
              power and antenna gain. Higher power level settings may be constrained by
              local regulatory requirements and AP capabilities.
            type: str
          power_value:
            description:
            - Radio EIRP power in dBm (1 - 33).
            type: int
          radio_id:
            description:
            - radio-id
            type: int
          spectrum_analysis:
            choices:
            - enable
            - scan-only
            - disable
            description:
            - Enable/disable spectrum analysis to find interference that would negatively
              impact wireless performance.
            type: str
          vap_all:
            choices:
            - tunnel
            - bridge
            - manual
            - enable
            - disable
            description:
            - Configure method for assigning SSIDs to this FortiAP .
            type: str
          vaps:
            description:
            - Manually selected list of Virtual Access Points (VAPs).
            elements: dict
            suboptions:
              name:
                description:
                - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name
                  system.interface.name.
                required: true
                type: str
            type: list
        type: dict
      radio_4:
        description:
        - Configuration options for radio 4.
        suboptions:
          auto_power_high:
            description:
            - The upper bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_level:
            choices:
            - enable
            - disable
            description:
            - Enable/disable automatic power-level adjustment to prevent co-channel interference
              .
            type: str
          auto_power_low:
            description:
            - The lower bound of automatic transmit power adjustment in dBm (the actual
              range of transmit power depends on the AP platform type).
            type: int
          auto_power_target:
            description:
            - Target of automatic transmit power adjustment in dBm (-95 to -20).
            type: str
          band:
            choices:
            - 802.11a
            - 802.11b
            - 802.11g
            - 802.11n
            - 802.11n-5G
            - 802.11ac
            - 802.11ax-5G
            - 802.11ax
            - 802.11ac-2G
            - 802.11ax-6G
            - 802.11n,g-only
            - 802.11g-only
            - 802.11n-only
            - 802.11n-5G-only
            - 802.11ac,n-only
            - 802.11ac-only
            - 802.11ax,ac-only
            - 802.11ax,ac,n-only
            - 802.11ax-5G-only
            - 802.11ax,n-only
            - 802.11ax,n,g-only
            - 802.11ax-only
            description:
            - WiFi band that Radio 4 operates on.
            type: str
          channel:
            description:
            - Selected list of wireless radio channels.
            elements: dict
            suboptions:
              chan:
                description:
                - Channel number.
                required: true
                type: str
            type: list
          drma_manual_mode:
            choices:
            - ap
            - monitor
            - ncf
            - ncf-peek
            description:
            - Radio mode to be used for DRMA manual mode .
            type: str
          override_analysis:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile spectrum analysis configuration.
            type: str
          override_band:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile band setting.
            type: str
          override_channel:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile channel settings.
            type: str
          override_txpower:
            choices:
            - enable
            - disable
            description:
            - Enable to override the WTP profile power level configuration.
            type: str
          override_vaps:
            choices:
            - enable
            - disable
            description:
            - Enable to override WTP profile Virtual Access Point (VAP) settings.
            type: str
          power_level:
            description:
            - Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100).
            type: int
          power_mode:
            choices:
            - dBm
            - percentage
            description:
            - Set radio effective isotropic radiated power (EIRP) in dBm or by a percentage
              of the maximum EIRP . This power takes into account both radio transmit
              power and antenna gain. Higher power level settings may be constrained by
              local regulatory requirements and AP capabilities.
            type: str
          power_value:
            description:
            - Radio EIRP power in dBm (1 - 33).
            type: int
          spectrum_analysis:
            choices:
            - enable
            - scan-only
            - disable
            description:
            - Enable/disable spectrum analysis to find interference that would negatively
              impact wireless performance.
            type: str
          vap_all:
            choices:
            - tunnel
            - bridge
            - manual
            - enable
            - disable
            description:
            - Configure method for assigning SSIDs to this FortiAP .
            type: str
          vaps:
            description:
            - Manually selected list of Virtual Access Points (VAPs).
            elements: dict
            suboptions:
              name:
                description:
                - Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name
                  system.interface.name.
                required: true
                type: str
            type: list
        type: dict
      region:
        description:
        - Region name WTP is associated with. Source wireless-controller.region.name.
        type: str
      region_x:
        description:
        - Relative horizontal region coordinate (between 0 and 1).
        type: str
      region_y:
        description:
        - Relative vertical region coordinate (between 0 and 1).
        type: str
      split_tunneling_acl:
        description:
        - Split tunneling ACL filter list.
        elements: dict
        suboptions:
          dest_ip:
            description:
            - Destination IP and mask for the split-tunneling subnet.
            type: str
          id:
            description:
            - ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
        type: list
      split_tunneling_acl_local_ap_subnet:
        choices:
        - enable
        - disable
        description:
        - Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling
          ACL .
        type: str
      split_tunneling_acl_path:
        choices:
        - tunnel
        - local
        description:
        - Split tunneling ACL path is local/tunnel.
        type: str
      tun_mtu_downlink:
        description:
        - The MTU of downlink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local
          MTU of FortiAP; ).
        type: int
      tun_mtu_uplink:
        description:
        - The maximum transmission unit (MTU) of uplink CAPWAP tunnel (576 - 1500 bytes
          or 0; 0 means the local MTU of FortiAP; ).
        type: int
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
      wan_port_mode:
        choices:
        - wan-lan
        - wan-only
        description:
        - Enable/disable using the FortiAP WAN port as a LAN port.
        type: str
      wtp_id:
        description:
        - WTP ID.
        required: true
        type: str
      wtp_mode:
        choices:
        - normal
        - remote
        description:
        - WTP, AP, or FortiAP operating mode; normal (by default) or remote. A tunnel
          mode SSID can be assigned to an AP in normal mode but not remote mode, while
          a local-bridge mode SSID can be assigned to an AP in either normal mode or remote
          mode.
        type: str
      wtp_profile:
        description:
        - WTP profile name to apply to this WTP, AP or FortiAP. Source wireless-controller.wtp-profile.name.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str