fmgd_wireless_wtp – Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • wireless_wtp - Configure Wireless Termination Points type: dict
    • admin Configure how the fortigate operating as a wireless controller discovers and manages this wtp, ap or fortiap. type: str choices: [discovery, disable, enable, discovered] more...
    • allowaccess Control management access to the managed wtp, fortiap, or ap. type: list choices: [https, ssh, snmp, http, telnet] more...
    • apcfg_profile (Alias name: apcfg-profile) Ap local configuration profile name. type: list more...
    • ble_major_id (Alias name: ble-major-id) Override ble major id. type: int more...
    • ble_minor_id (Alias name: ble-minor-id) Override ble minor id. type: int more...
    • bonjour_profile (Alias name: bonjour-profile) Bonjour profile name. type: list more...
    • coordinate_latitude (Alias name: coordinate-latitude) Wtp latitude coordinate. type: str more...
    • coordinate_longitude (Alias name: coordinate-longitude) Wtp longitude coordinate. type: str more...
    • firmware_provision (Alias name: firmware-provision) Firmware version to provision to this fortiap on bootup (major. type: str more...
    • firmware_provision_latest (Alias name: firmware-provision-latest) Enable/disable one-time automatic provisioning of the latest firmware version. type: str choices: [disable, once] more...
    • image_download (Alias name: image-download) Enable/disable wtp image download. type: str choices: [disable, enable] more...
    • index Index. type: int more...
    • ip_fragment_preventing (Alias name: ip-fragment-preventing) Method(s) by which ip fragmentation is prevented for control and data packets through capwap tunnel (default = tcp-mss-adjust). type: list choices: [tcp-mss-adjust, icmp-unreachable] more...
    • lan Lan. type: dict more...
      • port_esl_mode (Alias name: port-esl-mode) Esl port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port_esl_ssid (Alias name: port-esl-ssid) Bridge esl port to ssid. type: list more...
      • port_mode (Alias name: port-mode) Lan port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port_ssid (Alias name: port-ssid) Bridge lan port to ssid. type: list more...
      • port1_mode (Alias name: port1-mode) Lan port 1 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port1_ssid (Alias name: port1-ssid) Bridge lan port 1 to ssid. type: list more...
      • port2_mode (Alias name: port2-mode) Lan port 2 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port2_ssid (Alias name: port2-ssid) Bridge lan port 2 to ssid. type: list more...
      • port3_mode (Alias name: port3-mode) Lan port 3 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port3_ssid (Alias name: port3-ssid) Bridge lan port 3 to ssid. type: list more...
      • port4_mode (Alias name: port4-mode) Lan port 4 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port4_ssid (Alias name: port4-ssid) Bridge lan port 4 to ssid. type: list more...
      • port5_mode (Alias name: port5-mode) Lan port 5 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port5_ssid (Alias name: port5-ssid) Bridge lan port 5 to ssid. type: list more...
      • port6_mode (Alias name: port6-mode) Lan port 6 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port6_ssid (Alias name: port6-ssid) Bridge lan port 6 to ssid. type: list more...
      • port7_mode (Alias name: port7-mode) Lan port 7 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port7_ssid (Alias name: port7-ssid) Bridge lan port 7 to ssid. type: list more...
      • port8_mode (Alias name: port8-mode) Lan port 8 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
      • port8_ssid (Alias name: port8-ssid) Bridge lan port 8 to ssid. type: list more...
    • led_state (Alias name: led-state) Enable to allow the fortiaps leds to light. type: str choices: [disable, enable] more...
    • location Field for describing the physical location of the wtp, ap or fortiap. type: str more...
    • login_passwd (Alias name: login-passwd) Set the managed wtp, fortiap, or aps administrator password. type: list more...
    • login_passwd_change (Alias name: login-passwd-change) Change or reset the administrator password of a managed wtp, fortiap or ap (yes, default, or no, default = no). type: str choices: [no, yes, default] more...
    • mesh_bridge_enable (Alias name: mesh-bridge-enable) Enable/disable mesh ethernet bridge when wtp is configured as a mesh branch/leaf ap. type: str choices: [disable, enable, default] more...
    • name Wtp, ap or fortiap configuration name. type: str more...
    • override_allowaccess (Alias name: override-allowaccess) Enable to override the wtp profile management access configuration. type: str choices: [disable, enable] more...
    • override_ip_fragment (Alias name: override-ip-fragment) Enable/disable overriding the wtp profile ip fragment prevention setting. type: str choices: [disable, enable] more...
    • override_lan (Alias name: override-lan) Enable to override the wtp profile lan port setting. type: str choices: [disable, enable] more...
    • override_led_state (Alias name: override-led-state) Enable to override the profile led state setting for this fortiap. type: str choices: [disable, enable] more...
    • override_login_passwd_change (Alias name: override-login-passwd-change) Enable to override the wtp profile login-password (administrator password) setting. type: str choices: [disable, enable] more...
    • override_split_tunnel (Alias name: override-split-tunnel) Enable/disable overriding the wtp profile split tunneling setting. type: str choices: [disable, enable] more...
    • override_wan_port_mode (Alias name: override-wan-port-mode) Enable/disable overriding the wan-port-mode in the wtp profile. type: str choices: [disable, enable] more...
    • purdue_level (Alias name: purdue-level) Purdue level of this wtp. type: str choices: [1, 2, 3, 4, 5, 1.5, 2.5, 3.5, 5.5] more...
    • radio_1 (Alias name: radio-1) Radio 1. type: dict more...
      • auto_power_high (Alias name: auto-power-high) The upper bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: auto-power-low) The lower bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 1 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • channel Selected list of wireless radio channels. type: list more...
      • drma_manual_mode (Alias name: drma-manual-mode) Radio mode to be used for drma manual mode (default = ncf). type: str choices: [ap, monitor, ncf, ncf-peek] more...
      • override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable] more...
      • override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable] more...
      • override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable] more...
      • override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable] more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable] more...
    • radio_2 (Alias name: radio-2) Radio 2. type: dict more...
      • auto_power_high (Alias name: auto-power-high) The upper bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: auto-power-low) The lower bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 2 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • channel Selected list of wireless radio channels. type: list more...
      • drma_manual_mode (Alias name: drma-manual-mode) Radio mode to be used for drma manual mode (default = ncf). type: str choices: [ap, monitor, ncf, ncf-peek] more...
      • override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable] more...
      • override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable] more...
      • override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable] more...
      • override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable] more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable] more...
    • radio_3 (Alias name: radio-3) Radio 3. type: dict more...
      • auto_power_high (Alias name: auto-power-high) The upper bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: auto-power-low) The lower bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 3 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • channel Selected list of wireless radio channels. type: list more...
      • drma_manual_mode (Alias name: drma-manual-mode) Radio mode to be used for drma manual mode (default = ncf). type: str choices: [ap, monitor, ncf, ncf-peek] more...
      • override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable] more...
      • override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable] more...
      • override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable] more...
      • override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable] more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable] more...
    • radio_4 (Alias name: radio-4) Radio 4. type: dict more...
      • auto_power_high (Alias name: auto-power-high) The upper bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_level (Alias name: auto-power-level) Enable/disable automatic power-level adjustment to prevent co-channel interference (default = enable). type: str choices: [disable, enable] more...
      • auto_power_low (Alias name: auto-power-low) The lower bound of automatic transmit power adjustment in dbm (the actual range of transmit power depends on the ap platform type). type: int more...
      • auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str more...
      • band Wifi band that radio 4 operates on. type: list choices: [802.11a, 802.11b, 802.11g, 802.11n, 802.11n-5G, 802.11n,g-only, 802.11g-only, 802.11n-only, 802.11n-5G-only, 802.11ac, 802.11ac,n-only, 802.11ac-only, 802.11ax-5G, 802.11ax,ac-only, 802.11ax,ac,n-only, 802.11ax-5G-only, 802.11ax, 802.11ax,n-only, 802.11ax,n,g-only, 802.11ax-only, 802.11ac-2G, 802.11ax-6G, 802.11n-2G, 802.11ac-5G, 802.11ax-2G, 802.11be-2G, 802.11be-5G, 802.11be-6G] more...
      • channel Selected list of wireless radio channels. type: list more...
      • drma_manual_mode (Alias name: drma-manual-mode) Radio mode to be used for drma manual mode (default = ncf). type: str choices: [ap, monitor, ncf, ncf-peek] more...
      • override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable] more...
      • override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable] more...
      • override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable] more...
      • override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable] more...
      • power_level (Alias name: power-level) Radio eirp power level as a percentage of the maximum eirp power (0 - 100, default = 100). type: int more...
      • power_mode (Alias name: power-mode) Set radio effective isotropic radiated power (eirp) in dbm or by a percentage of the maximum eirp (default = percentage). type: str choices: [dBm, percentage] more...
      • power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int more...
      • radio_id (Alias name: radio-id) Radio id. type: int more...
      • vap_all (Alias name: vap-all) Configure method for assigning ssids to this fortiap (default = automatically assign tunnel ssids). type: str choices: [disable, enable, tunnel, bridge, manual] more...
      • vap1 Virtual access point (vap) for wlan id 1 type: str more...
      • vap2 Virtual access point (vap) for wlan id 2 type: str more...
      • vap3 Virtual access point (vap) for wlan id 3 type: str more...
      • vap4 Virtual access point (vap) for wlan id 4 type: str more...
      • vap5 Virtual access point (vap) for wlan id 5 type: str more...
      • vap6 Virtual access point (vap) for wlan id 6 type: str more...
      • vap7 Virtual access point (vap) for wlan id 7 type: str more...
      • vap8 Virtual access point (vap) for wlan id 8 type: str more...
      • vaps Manually selected list of virtual access points (vaps). type: list more...
      • spectrum_analysis (Alias name: spectrum-analysis) Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: [disable, enable, scan-only] more...
      • override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable] more...
    • region Region name wtp is associated with. type: list more...
    • region_x (Alias name: region-x) Relative horizontal region coordinate (between 0 and 1). type: str more...
    • region_y (Alias name: region-y) Relative vertical region coordinate (between 0 and 1). type: str more...
    • split_tunneling_acl (Alias name: split-tunneling-acl) Split tunneling acl. type: list more...
      • dest_ip (Alias name: dest-ip) Destination ip and mask for the split-tunneling subnet. type: list more...
      • id Id. type: int more...
    • split_tunneling_acl_local_ap_subnet (Alias name: split-tunneling-acl-local-ap-subnet) Enable/disable automatically adding local subnetwork of fortiap to split-tunneling acl (default = disable). type: str choices: [disable, enable] more...
    • split_tunneling_acl_path (Alias name: split-tunneling-acl-path) Split tunneling acl path is local/tunnel. type: str choices: [tunnel, local] more...
    • tun_mtu_downlink (Alias name: tun-mtu-downlink) The mtu of downlink capwap tunnel (576 - 1500 bytes or 0; 0 means the local mtu of fortiap; default = 0). type: int more...
    • tun_mtu_uplink (Alias name: tun-mtu-uplink) The maximum transmission unit (mtu) of uplink capwap tunnel (576 - 1500 bytes or 0; 0 means the local mtu of fortiap; default = 0). type: int more...
    • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
    • wan_port_mode (Alias name: wan-port-mode) Enable/disable using the fortiap wan port as a lan port. type: str choices: [wan-lan, wan-only] more...
    • wtp_id (Alias name: wtp-id) Wtp id. type: str more...
    • wtp_mode (Alias name: wtp-mode) Wtp, ap, or fortiap operating mode (default = normal). type: str choices: [normal, remote] more...
    • wtp_profile (Alias name: wtp-profile) Wtp profile name to apply to this wtp, ap or fortiap. type: list more...
    • comment Comment. type: str more...
    • _prefer_img_ver (Alias name: _prefer-img-ver) Prefer img ver. type: str more...
    • default_mesh_root (Alias name: default-mesh-root) Configure default mesh root ssid when it is not included by radios ssid configuration. type: str choices: [disable, enable] more...
    • override_default_mesh_root (Alias name: override-default-mesh-root) Enable to override the wtp profile default mesh root ssid setting. type: str choices: [disable, enable] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Wireless Termination Points
      fortinet.fmgdevice.fmgd_wireless_wtp:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        wireless_wtp:
          wtp_id: "your value" # Required variable, string
          # admin: <value in [discovery, disable, enable, ...]>
          # allowaccess:
          #   - "https"
          #   - "ssh"
          #   - "snmp"
          #   - "http"
          #   - "telnet"
          # apcfg_profile: <list or string>
          # ble_major_id: <integer>
          # ble_minor_id: <integer>
          # bonjour_profile: <list or string>
          # coordinate_latitude: <string>
          # coordinate_longitude: <string>
          # firmware_provision: <string>
          # firmware_provision_latest: <value in [disable, once]>
          # image_download: <value in [disable, enable]>
          # index: <integer>
          # ip_fragment_preventing:
          #   - "tcp-mss-adjust"
          #   - "icmp-unreachable"
          # lan:
          #   port_esl_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port_esl_ssid: <list or string>
          #   port_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port_ssid: <list or string>
          #   port1_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port1_ssid: <list or string>
          #   port2_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port2_ssid: <list or string>
          #   port3_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port3_ssid: <list or string>
          #   port4_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port4_ssid: <list or string>
          #   port5_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port5_ssid: <list or string>
          #   port6_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port6_ssid: <list or string>
          #   port7_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port7_ssid: <list or string>
          #   port8_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
          #   port8_ssid: <list or string>
          # led_state: <value in [disable, enable]>
          # location: <string>
          # login_passwd: <list or string>
          # login_passwd_change: <value in [no, yes, default]>
          # mesh_bridge_enable: <value in [disable, enable, default]>
          # name: <string>
          # override_allowaccess: <value in [disable, enable]>
          # override_ip_fragment: <value in [disable, enable]>
          # override_lan: <value in [disable, enable]>
          # override_led_state: <value in [disable, enable]>
          # override_login_passwd_change: <value in [disable, enable]>
          # override_split_tunnel: <value in [disable, enable]>
          # override_wan_port_mode: <value in [disable, enable]>
          # purdue_level: <value in [1, 2, 3, ...]>
          # radio_1:
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   channel: <list or string>
          #   drma_manual_mode: <value in [ap, monitor, ncf, ...]>
          #   override_band: <value in [disable, enable]>
          #   override_channel: <value in [disable, enable]>
          #   override_txpower: <value in [disable, enable]>
          #   override_vaps: <value in [disable, enable]>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   radio_id: <integer>
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   override_analysis: <value in [disable, enable]>
          # radio_2:
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   channel: <list or string>
          #   drma_manual_mode: <value in [ap, monitor, ncf, ...]>
          #   override_band: <value in [disable, enable]>
          #   override_channel: <value in [disable, enable]>
          #   override_txpower: <value in [disable, enable]>
          #   override_vaps: <value in [disable, enable]>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   radio_id: <integer>
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   override_analysis: <value in [disable, enable]>
          # radio_3:
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   channel: <list or string>
          #   drma_manual_mode: <value in [ap, monitor, ncf, ...]>
          #   override_band: <value in [disable, enable]>
          #   override_channel: <value in [disable, enable]>
          #   override_txpower: <value in [disable, enable]>
          #   override_vaps: <value in [disable, enable]>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   radio_id: <integer>
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   override_analysis: <value in [disable, enable]>
          # radio_4:
          #   auto_power_high: <integer>
          #   auto_power_level: <value in [disable, enable]>
          #   auto_power_low: <integer>
          #   auto_power_target: <string>
          #   band:
          #     - "802.11a"
          #     - "802.11b"
          #     - "802.11g"
          #     - "802.11n"
          #     - "802.11n-5G"
          #     - "802.11n,g-only"
          #     - "802.11g-only"
          #     - "802.11n-only"
          #     - "802.11n-5G-only"
          #     - "802.11ac"
          #     - "802.11ac,n-only"
          #     - "802.11ac-only"
          #     - "802.11ax-5G"
          #     - "802.11ax,ac-only"
          #     - "802.11ax,ac,n-only"
          #     - "802.11ax-5G-only"
          #     - "802.11ax"
          #     - "802.11ax,n-only"
          #     - "802.11ax,n,g-only"
          #     - "802.11ax-only"
          #     - "802.11ac-2G"
          #     - "802.11ax-6G"
          #     - "802.11n-2G"
          #     - "802.11ac-5G"
          #     - "802.11ax-2G"
          #     - "802.11be-2G"
          #     - "802.11be-5G"
          #     - "802.11be-6G"
          #   channel: <list or string>
          #   drma_manual_mode: <value in [ap, monitor, ncf, ...]>
          #   override_band: <value in [disable, enable]>
          #   override_channel: <value in [disable, enable]>
          #   override_txpower: <value in [disable, enable]>
          #   override_vaps: <value in [disable, enable]>
          #   power_level: <integer>
          #   power_mode: <value in [dBm, percentage]>
          #   power_value: <integer>
          #   radio_id: <integer>
          #   vap_all: <value in [disable, enable, tunnel, ...]>
          #   vap1: <string>
          #   vap2: <string>
          #   vap3: <string>
          #   vap4: <string>
          #   vap5: <string>
          #   vap6: <string>
          #   vap7: <string>
          #   vap8: <string>
          #   vaps: <list or string>
          #   spectrum_analysis: <value in [disable, enable, scan-only]>
          #   override_analysis: <value in [disable, enable]>
          # region: <list or string>
          # region_x: <string>
          # region_y: <string>
          # split_tunneling_acl:
          #   - dest_ip: <list or string>
          #     id: <integer>
          # split_tunneling_acl_local_ap_subnet: <value in [disable, enable]>
          # split_tunneling_acl_path: <value in [tunnel, local]>
          # tun_mtu_downlink: <integer>
          # tun_mtu_uplink: <integer>
          # uuid: <string>
          # wan_port_mode: <value in [wan-lan, wan-only]>
          # wtp_mode: <value in [normal, remote]>
          # wtp_profile: <list or string>
          # comment: <string>
          # _prefer_img_ver: <string>
          # default_mesh_root: <value in [disable, enable]>
          # override_default_mesh_root: <value in [disable, enable]>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)