Try SpotterConfigure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet's FortiOS and FortiGate.
| "added in version" 2.8 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.8.20
This module is able to configure a FortiGate or FortiOS 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.2
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
fortios_wireless_controller_wtp:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
wireless_controller_wtp:
state: "present"
admin: "discovered"
allowaccess: "telnet"
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>"
image-download: "enable"
index: "12"
ip-fragment-preventing: "tcp-mss-adjust"
lan:
port-mode: "offline"
port-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port1-mode: "offline"
port1-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port2-mode: "offline"
port2-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port3-mode: "offline"
port3-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port4-mode: "offline"
port4-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port5-mode: "offline"
port5-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port6-mode: "offline"
port6-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port7-mode: "offline"
port7-ssid: "<your_own_value> (source wireless-controller.vap.name)"
port8-mode: "offline"
port8-ssid: "<your_own_value> (source wireless-controller.vap.name)"
led-state: "enable"
location: "<your_own_value>"
login-passwd: "<your_own_value>"
login-passwd-change: "yes"
mesh-bridge-enable: "default"
name: "default_name_38"
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: "47"
auto-power-level: "enable"
auto-power-low: "49"
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: "58"
radio-id: "59"
spectrum-analysis: "enable"
vap-all: "enable"
vaps:
-
name: "default_name_63 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
radio-2:
auto-power-high: "65"
auto-power-level: "enable"
auto-power-low: "67"
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: "76"
radio-id: "77"
spectrum-analysis: "enable"
vap-all: "enable"
vaps:
-
name: "default_name_81 (source wireless-controller.vap-group.name wireless-controller.vap.name)"
split-tunneling-acl:
-
dest-ip: "<your_own_value>"
id: "84"
split-tunneling-acl-local-ap-subnet: "enable"
split-tunneling-acl-path: "tunnel"
tun-mtu-downlink: "87"
tun-mtu-uplink: "88"
wan-port-mode: "wan-lan"
wtp-id: "<your_own_value>"
wtp-mode: "normal"
wtp-profile: "<your_own_value> (source wireless-controller.wtp-profile.name)"
host:
description:
- FortiOS or FortiGate ip address.
required: true
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.
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol
type: bool
password:
default: ''
description:
- FortiOS or FortiGate password.
username:
description:
- FortiOS or FortiGate username.
required: true
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.
allowaccess:
choices:
- telnet
- http
- https
- ssh
description:
- Control management access to the managed WTP, FortiAP, or AP. Separate entries
with a space.
bonjour-profile:
description:
- Bonjour profile name. Source wireless-controller.bonjour-profile.name.
coordinate-enable:
choices:
- enable
- disable
description:
- Enable/disable WTP coordinates (X,Y axis).
coordinate-latitude:
description:
- WTP latitude coordinate.
coordinate-longitude:
description:
- WTP longitude coordinate.
coordinate-x:
description:
- X axis coordinate.
coordinate-y:
description:
- Y axis coordinate.
image-download:
choices:
- enable
- disable
description:
- Enable/disable WTP image download.
index:
description:
- Index (0 - 4294967295).
ip-fragment-preventing:
choices:
- tcp-mss-adjust
- icmp-unreachable
description:
- Method by which IP fragmentation is prevented for CAPWAP tunneled control and
data packets (default = tcp-mss-adjust).
lan:
description:
- WTP LAN port mapping.
suboptions:
port-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port mode.
port-ssid:
description:
- Bridge LAN port to SSID. Source wireless-controller.vap.name.
port1-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 1 mode.
port1-ssid:
description:
- Bridge LAN port 1 to SSID. Source wireless-controller.vap.name.
port2-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 2 mode.
port2-ssid:
description:
- Bridge LAN port 2 to SSID. Source wireless-controller.vap.name.
port3-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 3 mode.
port3-ssid:
description:
- Bridge LAN port 3 to SSID. Source wireless-controller.vap.name.
port4-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 4 mode.
port4-ssid:
description:
- Bridge LAN port 4 to SSID. Source wireless-controller.vap.name.
port5-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 5 mode.
port5-ssid:
description:
- Bridge LAN port 5 to SSID. Source wireless-controller.vap.name.
port6-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 6 mode.
port6-ssid:
description:
- Bridge LAN port 6 to SSID. Source wireless-controller.vap.name.
port7-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 7 mode.
port7-ssid:
description:
- Bridge LAN port 7 to SSID. Source wireless-controller.vap.name.
port8-mode:
choices:
- offline
- nat-to-wan
- bridge-to-wan
- bridge-to-ssid
description:
- LAN port 8 mode.
port8-ssid:
description:
- Bridge LAN port 8 to SSID. Source wireless-controller.vap.name.
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.
location:
description:
- Field for describing the physical location of the WTP, AP or FortiAP.
login-passwd:
description:
- Set the managed WTP, FortiAP, or AP's administrator password.
login-passwd-change:
choices:
- true
- default
- false
description:
- Change or reset the administrator password of a managed WTP, FortiAP or AP (yes,
default, or no, default = no).
mesh-bridge-enable:
choices:
- default
- enable
- disable
description:
- Enable/disable mesh Ethernet bridge when WTP is configured as a mesh branch/leaf
AP.
name:
description:
- WTP, AP or FortiAP configuration name.
override-allowaccess:
choices:
- enable
- disable
description:
- Enable to override the WTP profile management access configuration.
override-ip-fragment:
choices:
- enable
- disable
description:
- Enable/disable overriding the WTP profile IP fragment prevention setting.
override-lan:
choices:
- enable
- disable
description:
- Enable to override the WTP profile LAN port setting.
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.
override-login-passwd-change:
choices:
- enable
- disable
description:
- Enable to override the WTP profile login-password (administrator password) setting.
override-split-tunnel:
choices:
- enable
- disable
description:
- Enable/disable overriding the WTP profile split tunneling setting.
override-wan-port-mode:
choices:
- enable
- disable
description:
- Enable/disable overriding the wan-port-mode in the WTP profile.
radio-1:
description:
- Configuration options for radio 1.
suboptions:
auto-power-high:
description:
- Automatic transmission power high limit in decibels (dB) of the measured
power referenced to one milliwatt (mW), or dBm (10 - 17 dBm, default = 17).
auto-power-level:
choices:
- enable
- disable
description:
- Enable/disable automatic power-level adjustment to prevent co-channel interference
(default = enable).
auto-power-low:
description:
- Automatic transmission power low limit in dBm (the actual range of transmit
power depends on the AP platform type).
band:
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
description:
- WiFi band that Radio 1 operates on.
channel:
description:
- Selected list of wireless radio channels.
suboptions:
chan:
description:
- Channel number.
required: true
override-analysis:
choices:
- enable
- disable
description:
- Enable to override the WTP profile spectrum analysis configuration.
override-band:
choices:
- enable
- disable
description:
- Enable to override the WTP profile band setting.
override-channel:
choices:
- enable
- disable
description:
- Enable to override WTP profile channel settings.
override-txpower:
choices:
- enable
- disable
description:
- Enable to override the WTP profile power level configuration.
override-vaps:
choices:
- enable
- disable
description:
- Enable to override WTP profile Virtual Access Point (VAP) settings.
power-level:
description:
- Radio power level as a percentage of the maximum transmit power (0 - 100,
default = 100).
radio-id:
description:
- radio-id
spectrum-analysis:
choices:
- enable
- disable
description:
- Enable/disable spectrum analysis to find interference that would negatively
impact wireless performance.
vap-all:
choices:
- enable
- disable
description:
- Enable/disable the automatic inheritance of all Virtual Access Points (VAPs)
(default = enable).
vaps:
description:
- Manually selected list of Virtual Access Points (VAPs).
suboptions:
name:
description:
- Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name
wireless-controller.vap.name.
required: true
radio-2:
description:
- Configuration options for radio 2.
suboptions:
auto-power-high:
description:
- Automatic transmission power high limit in decibels (dB) of the measured
power referenced to one milliwatt (mW), or dBm (10 - 17 dBm, default = 17).
auto-power-level:
choices:
- enable
- disable
description:
- Enable/disable automatic power-level adjustment to prevent co-channel interference
(default = enable).
auto-power-low:
description:
- Automatic transmission power low limit in dBm (the actual range of transmit
power depends on the AP platform type).
band:
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
description:
- WiFi band that Radio 1 operates on.
channel:
description:
- Selected list of wireless radio channels.
suboptions:
chan:
description:
- Channel number.
required: true
override-analysis:
choices:
- enable
- disable
description:
- Enable to override the WTP profile spectrum analysis configuration.
override-band:
choices:
- enable
- disable
description:
- Enable to override the WTP profile band setting.
override-channel:
choices:
- enable
- disable
description:
- Enable to override WTP profile channel settings.
override-txpower:
choices:
- enable
- disable
description:
- Enable to override the WTP profile power level configuration.
override-vaps:
choices:
- enable
- disable
description:
- Enable to override WTP profile Virtual Access Point (VAP) settings.
power-level:
description:
- Radio power level as a percentage of the maximum transmit power (0 - 100,
default = 100).
radio-id:
description:
- radio-id
spectrum-analysis:
choices:
- enable
- disable
description:
- Enable/disable spectrum analysis to find interference that would negatively
impact wireless performance.
vap-all:
choices:
- enable
- disable
description:
- Enable/disable the automatic inheritance of all Virtual Access Points (VAPs)
(default = enable).
vaps:
description:
- Manually selected list of Virtual Access Points (VAPs).
suboptions:
name:
description:
- Virtual Access Point (VAP) name. Source wireless-controller.vap-group.name
wireless-controller.vap.name.
required: true
split-tunneling-acl:
description:
- Split tunneling ACL filter list.
suboptions:
dest-ip:
description:
- Destination IP and mask for the split-tunneling subnet.
id:
description:
- ID.
required: true
split-tunneling-acl-local-ap-subnet:
choices:
- enable
- disable
description:
- Enable/disable automatically adding local subnetwork of FortiAP to split-tunneling
ACL (default = disable).
split-tunneling-acl-path:
choices:
- tunnel
- local
description:
- Split tunneling ACL path is local/tunnel.
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object
tun-mtu-downlink:
description:
- Downlink tunnel MTU in octets. Set the value to either 0 (by default), 576,
or 1500.
tun-mtu-uplink:
description:
- Uplink tunnel maximum transmission unit (MTU) in octets (eight-bit bytes). Set
the value to either 0 (by default), 576, or 1500.
wan-port-mode:
choices:
- wan-lan
- wan-only
description:
- Enable/disable using the FortiAP WAN port as a LAN port.
wtp-id:
description:
- WTP ID.
required: true
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.
wtp-profile:
description:
- WTP profile name to apply to this WTP, AP or FortiAP. Source wireless-controller.wtp-profile.name.
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