fortios_wireless_controller_wtp – Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.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 - Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- admin - Configure how the FortiGate operating as a wireless controller discovers and manages this WTP, AP or FortiAP. type: str choices: discovered, disable, enable
- allowaccess - Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space. type: str choices: https, ssh, snmp
- apcfg_profile - AP local configuration profile name. Source wireless-controller.apcfg-profile.name. type: str
- bonjour_profile - Bonjour profile name. Source wireless-controller.bonjour-profile.name. type: str
- coordinate_latitude - WTP latitude coordinate. type: str
- coordinate_longitude - WTP longitude coordinate. type: str
- firmware_provision - Firmware version to provision to this FortiAP on bootup (major.minor.build, i.e. 6.2.1234). type: str
- image_download - Enable/disable WTP image download. type: str choices: enable, disable
- index - Index (0 - 4294967295). type: int
- ip_fragment_preventing - Method(s) by which IP fragmentation is prevented for control and data packets through CAPWAP tunnel . 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 system.interface.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 system.interface.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 system.interface.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 system.interface.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 system.interface.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 system.interface.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 system.interface.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 system.interface.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 system.interface.name. type: str
- led_state - 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 choices: enable, disable
- location - Field for describing the physical location of the WTP, AP or FortiAP. type: str
- 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
- mesh_bridge_enable - Enable/disable mesh Ethernet bridge when WTP is configured as a mesh branch/leaf AP. type: str choices: default, enable, disable
- name - WTP, AP or FortiAP configuration name. type: str
- override_allowaccess - Enable to override the WTP profile management access configuration. type: str choices: enable, disable
- override_ip_fragment - Enable/disable overriding the WTP profile IP fragment prevention setting. type: str choices: enable, disable
- override_lan - Enable to override the WTP profile LAN port setting. type: str choices: enable, disable
- override_led_state - 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 choices: enable, disable
- override_login_passwd_change - Enable to override the WTP profile login-password (administrator password) setting. type: str choices: enable, disable
- override_split_tunnel - Enable/disable overriding the WTP profile split tunneling setting. type: str choices: enable, disable
- override_wan_port_mode - Enable/disable overriding the wan-port-mode in the WTP profile. type: str choices: enable, disable
- radio_1 - Configuration options for radio 1. type: dict
- 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
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
- 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
- band - WiFi band that Radio 1 operates on. type: str 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
- channel - Selected list of wireless radio channels. type: list
- chan - Channel number. type: str required: True
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
- power_level - Radio power level as a percentage of the maximum transmit power (0 - 100). type: int
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
- 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 system.interface.name. type: str required: True
- radio_2 - Configuration options for radio 2. type: dict
- 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
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
- 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
- band - WiFi band that Radio 2 operates on. type: str 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
- channel - Selected list of wireless radio channels. type: list
- chan - Channel number. type: str required: True
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
- power_level - Radio power level as a percentage of the maximum transmit power (0 - 100). type: int
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
- 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 system.interface.name. type: str required: True
- radio_3 - Configuration options for radio 3. type: dict
- 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
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
- 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
- band - WiFi band that Radio 3 operates on. type: str 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
- channel - Selected list of wireless radio channels. type: list
- chan - Channel number. type: str required: True
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
- power_level - Radio power level as a percentage of the maximum transmit power (0 - 100). type: int
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
- 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 system.interface.name. type: str required: True
- radio_4 - Configuration options for radio 4. type: dict
- 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
- auto_power_level - Enable/disable automatic power-level adjustment to prevent co-channel interference . type: str choices: enable, disable
- 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
- band - WiFi band that Radio 4 operates on. type: str 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
- channel - Selected list of wireless radio channels. type: list
- chan - Channel number. type: str required: True
- override_analysis - Enable to override the WTP profile spectrum analysis configuration. type: str choices: enable, disable
- override_band - Enable to override the WTP profile band setting. type: str choices: enable, disable
- override_channel - Enable to override WTP profile channel settings. type: str choices: enable, disable
- override_txpower - Enable to override the WTP profile power level configuration. type: str choices: enable, disable
- override_vaps - Enable to override WTP profile Virtual Access Point (VAP) settings. type: str choices: enable, disable
- power_level - Radio power level as a percentage of the maximum transmit power (0 - 100). type: int
- spectrum_analysis - Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. type: str choices: enable, scan-only, disable
- 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 system.interface.name. type: str required: True
- region - Region name WTP is associated with. Source wireless-controller.region.name. type: str
- region_x - Relative horizontal region coordinate (between 0 and 1). type: str
- region_y - Relative vertical region coordinate (between 0 and 1). 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 - The MTU of downlink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). type: int
- tun_mtu_uplink - The maximum transmission unit (MTU) of uplink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). type: int
- wan_port_mode - Enable/disable using the FortiAP WAN port as a LAN port. type: str choices: wan-lan, wan-only
- wtp_id - WTP ID. type: str
- wtp_mode - 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 choices: normal, remote
- wtp_profile - WTP profile name to apply to this WTP, AP or FortiAP. Source wireless-controller.wtp-profile.name. type: str
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 Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
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)"
bonjour_profile: "<your_own_value> (source wireless-controller.bonjour-profile.name)"
coordinate_latitude: "<your_own_value>"
coordinate_longitude: "<your_own_value>"
firmware_provision: "<your_own_value>"
image_download: "enable"
index: "11"
ip_fragment_preventing: "tcp-mss-adjust"
lan:
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_37"
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"
radio_1:
auto_power_high: "46"
auto_power_level: "enable"
auto_power_low: "48"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "57"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_61 (source wireless-controller.vap-group.name system.interface.name)"
radio_2:
auto_power_high: "63"
auto_power_level: "enable"
auto_power_low: "65"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "74"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_78 (source wireless-controller.vap-group.name system.interface.name)"
radio_3:
auto_power_high: "80"
auto_power_level: "enable"
auto_power_low: "82"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "91"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_95 (source wireless-controller.vap-group.name system.interface.name)"
radio_4:
auto_power_high: "97"
auto_power_level: "enable"
auto_power_low: "99"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "108"
spectrum_analysis: "enable"
vap_all: "enable"
vaps:
-
name: "default_name_112 (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: "118"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
tun_mtu_downlink: "121"
tun_mtu_uplink: "122"
wan_port_mode: "wan-lan"
wtp_id: "<your_own_value>"
wtp_mode: "normal"
wtp_profile: "<your_own_value> (source wireless-controller.wtp-profile.name)"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- 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