fortinet.fortios.fortios_wireless_controller_wtp module – Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.4).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_wtp.
New in fortinet.fortios 2.0.0
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.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
|
Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate. |
|
Configure how the FortiGate operating as a wireless controller discovers and manages this WTP, AP or FortiAP. Choices:
|
|
Control management access to the managed WTP, FortiAP, or AP. Separate entries with a space. Choices:
|
|
AP local configuration profile name. Source wireless-controller.apcfg-profile.name. |
|
Override BLE Major ID. |
|
Override BLE Minor ID. |
|
Bonjour profile name. Source wireless-controller.bonjour-profile.name. |
|
Enable/disable WTP coordinates (X,Y axis). Choices:
|
|
WTP latitude coordinate. |
|
WTP longitude coordinate. |
|
X axis coordinate. |
|
Y axis coordinate. |
|
Firmware version to provision to this FortiAP on bootup (major.minor.build, i.e. 6.2.1234). |
|
Enable/disable one-time automatic provisioning of the latest firmware version. Choices:
|
|
Enable/disable WTP image download. Choices:
|
|
Index (0 - 4294967295). |
|
Method(s) by which IP fragmentation is prevented for control and data packets through CAPWAP tunnel . Choices:
|
|
WTP LAN port mapping. |
|
LAN port 1 mode. Choices:
|
|
Bridge LAN port 1 to SSID. Source system.interface.name. |
|
LAN port 2 mode. Choices:
|
|
Bridge LAN port 2 to SSID. Source system.interface.name. |
|
LAN port 3 mode. Choices:
|
|
Bridge LAN port 3 to SSID. Source system.interface.name. |
|
LAN port 4 mode. Choices:
|
|
Bridge LAN port 4 to SSID. Source system.interface.name. |
|
LAN port 5 mode. Choices:
|
|
Bridge LAN port 5 to SSID. Source system.interface.name. |
|
LAN port 6 mode. Choices:
|
|
Bridge LAN port 6 to SSID. Source system.interface.name. |
|
LAN port 7 mode. Choices:
|
|
Bridge LAN port 7 to SSID. Source system.interface.name. |
|
LAN port 8 mode. Choices:
|
|
Bridge LAN port 8 to SSID. Source system.interface.name. |
|
ESL port mode. Choices:
|
|
Bridge ESL port to SSID. Source system.interface.name. |
|
LAN port mode. Choices:
|
|
Bridge LAN port to SSID. Source system.interface.name. |
|
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. Choices:
|
|
Field for describing the physical location of the WTP, AP or FortiAP. |
|
Set the managed WTP, FortiAP, or AP”s administrator password. |
|
Change or reset the administrator password of a managed WTP, FortiAP or AP (yes, default, or no). Choices:
|
|
Enable/disable mesh Ethernet bridge when WTP is configured as a mesh branch/leaf AP. Choices:
|
|
WTP, AP or FortiAP configuration name. |
|
Enable to override the WTP profile management access configuration. Choices:
|
|
Enable/disable overriding the WTP profile IP fragment prevention setting. Choices:
|
|
Enable to override the WTP profile LAN port setting. Choices:
|
|
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. Choices:
|
|
Enable to override the WTP profile login-password (administrator password) setting. Choices:
|
|
Enable/disable overriding the WTP profile split tunneling setting. Choices:
|
|
Enable/disable overriding the wan-port-mode in the WTP profile. Choices:
|
|
Configuration options for radio 1. |
|
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference . Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Target of automatic transmit power adjustment in dBm (-95 to -20). |
|
WiFi band that Radio 1 operates on. Choices:
|
|
Selected list of wireless radio channels. |
|
Channel number. |
|
Radio mode to be used for DRMA manual mode . Choices:
|
|
Enable to override the WTP profile spectrum analysis configuration. Choices:
|
|
Enable to override the WTP profile band setting. Choices:
|
|
Enable to override WTP profile channel settings. Choices:
|
|
Enable to override the WTP profile power level configuration. Choices:
|
|
Enable to override WTP profile Virtual Access Point (VAP) settings. Choices:
|
|
Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). |
|
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. Choices:
|
|
Radio EIRP power in dBm (1 - 33). |
|
radio-id |
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP . Choices:
|
|
Manually selected list of Virtual Access Points (VAPs). |
|
Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. |
|
Configuration options for radio 2. |
|
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference . Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Target of automatic transmit power adjustment in dBm (-95 to -20). |
|
WiFi band that Radio 2 operates on. Choices:
|
|
Selected list of wireless radio channels. |
|
Channel number. |
|
Radio mode to be used for DRMA manual mode . Choices:
|
|
Enable to override the WTP profile spectrum analysis configuration. Choices:
|
|
Enable to override the WTP profile band setting. Choices:
|
|
Enable to override WTP profile channel settings. Choices:
|
|
Enable to override the WTP profile power level configuration. Choices:
|
|
Enable to override WTP profile Virtual Access Point (VAP) settings. Choices:
|
|
Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). |
|
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. Choices:
|
|
Radio EIRP power in dBm (1 - 33). |
|
radio-id |
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP . Choices:
|
|
Manually selected list of Virtual Access Points (VAPs). |
|
Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. |
|
Configuration options for radio 3. |
|
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference . Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Target of automatic transmit power adjustment in dBm (-95 to -20). |
|
WiFi band that Radio 3 operates on. Choices:
|
|
Selected list of wireless radio channels. |
|
Channel number. |
|
Radio mode to be used for DRMA manual mode . Choices:
|
|
Enable to override the WTP profile spectrum analysis configuration. Choices:
|
|
Enable to override the WTP profile band setting. Choices:
|
|
Enable to override WTP profile channel settings. Choices:
|
|
Enable to override the WTP profile power level configuration. Choices:
|
|
Enable to override WTP profile Virtual Access Point (VAP) settings. Choices:
|
|
Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). |
|
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. Choices:
|
|
Radio EIRP power in dBm (1 - 33). |
|
radio-id |
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP . Choices:
|
|
Manually selected list of Virtual Access Points (VAPs). |
|
Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. |
|
Configuration options for radio 4. |
|
The upper bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Enable/disable automatic power-level adjustment to prevent co-channel interference . Choices:
|
|
The lower bound of automatic transmit power adjustment in dBm (the actual range of transmit power depends on the AP platform type). |
|
Target of automatic transmit power adjustment in dBm (-95 to -20). |
|
WiFi band that Radio 4 operates on. Choices:
|
|
Selected list of wireless radio channels. |
|
Channel number. |
|
Radio mode to be used for DRMA manual mode . Choices:
|
|
Enable to override the WTP profile spectrum analysis configuration. Choices:
|
|
Enable to override the WTP profile band setting. Choices:
|
|
Enable to override WTP profile channel settings. Choices:
|
|
Enable to override the WTP profile power level configuration. Choices:
|
|
Enable to override WTP profile Virtual Access Point (VAP) settings. Choices:
|
|
Radio EIRP power level as a percentage of the maximum EIRP power (0 - 100). |
|
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. Choices:
|
|
Radio EIRP power in dBm (1 - 33). |
|
Enable/disable spectrum analysis to find interference that would negatively impact wireless performance. Choices:
|
|
Configure method for assigning SSIDs to this FortiAP . Choices:
|
|
Manually selected list of Virtual Access Points (VAPs). |
|
Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name system.interface.name. |
|
Region name WTP is associated with. Source wireless-controller.region.name. |
|
Relative horizontal region coordinate (between 0 and 1). |
|
Relative vertical region coordinate (between 0 and 1). |
|
Split tunneling ACL filter list. |
|
Destination IP and mask for the split-tunneling subnet. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling ACL . Choices:
|
|
Split tunneling ACL path is local/tunnel. Choices:
|
|
The MTU of downlink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). |
|
The maximum transmission unit (MTU) of uplink CAPWAP tunnel (576 - 1500 bytes or 0; 0 means the local MTU of FortiAP; ). |
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable/disable using the FortiAP WAN port as a LAN port. Choices:
|
|
WTP ID. |
|
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. Choices:
|
|
WTP profile name to apply to this WTP, AP or FortiAP. Source wireless-controller.wtp-profile.name. |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure 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)"
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"
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_74 (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_96 (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_118 (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_139 (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: "145"
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)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |