:source: fmgd_wireless_wtp.py
:orphan:
.. _fmgd_wireless_wtp:
fmgd_wireless_wtp -- Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- allowaccess Control management access to the managed wtp, fortiap, or ap. type: list choices: [https, ssh, snmp, http, telnet]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- apcfg_profile (Alias name: apcfg-profile) Ap local configuration profile name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ble_major_id (Alias name: ble-major-id) Override ble major id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ble_minor_id (Alias name: ble-minor-id) Override ble minor id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bonjour_profile (Alias name: bonjour-profile) Bonjour profile name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- coordinate_latitude (Alias name: coordinate-latitude) Wtp latitude coordinate. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- coordinate_longitude (Alias name: coordinate-longitude) Wtp longitude coordinate. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- firmware_provision (Alias name: firmware-provision) Firmware version to provision to this fortiap on bootup (major. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- image_download (Alias name: image-download) Enable/disable wtp image download. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- index Index. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lan Lan. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port_esl_ssid (Alias name: port-esl-ssid) Bridge esl port to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port_mode (Alias name: port-mode) Lan port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port_ssid (Alias name: port-ssid) Bridge lan port to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port1_mode (Alias name: port1-mode) Lan port 1 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port1_ssid (Alias name: port1-ssid) Bridge lan port 1 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port2_mode (Alias name: port2-mode) Lan port 2 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port2_ssid (Alias name: port2-ssid) Bridge lan port 2 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port3_mode (Alias name: port3-mode) Lan port 3 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port3_ssid (Alias name: port3-ssid) Bridge lan port 3 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port4_mode (Alias name: port4-mode) Lan port 4 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port4_ssid (Alias name: port4-ssid) Bridge lan port 4 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port5_mode (Alias name: port5-mode) Lan port 5 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port5_ssid (Alias name: port5-ssid) Bridge lan port 5 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port6_mode (Alias name: port6-mode) Lan port 6 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port6_ssid (Alias name: port6-ssid) Bridge lan port 6 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port7_mode (Alias name: port7-mode) Lan port 7 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port7_ssid (Alias name: port7-ssid) Bridge lan port 7 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port8_mode (Alias name: port8-mode) Lan port 8 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port8_ssid (Alias name: port8-ssid) Bridge lan port 8 to ssid. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- led_state (Alias name: led-state) Enable to allow the fortiaps leds to light. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- location Field for describing the physical location of the wtp, ap or fortiap. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- login_passwd (Alias name: login-passwd) Set the managed wtp, fortiap, or aps administrator password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Wtp, ap or fortiap configuration name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_allowaccess (Alias name: override-allowaccess) Enable to override the wtp profile management access configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_ip_fragment (Alias name: override-ip-fragment) Enable/disable overriding the wtp profile ip fragment prevention setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_lan (Alias name: override-lan) Enable to override the wtp profile lan port setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_split_tunnel (Alias name: override-split-tunnel) Enable/disable overriding the wtp profile split tunneling setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.4.3 -> latest
- radio_1 (Alias name: radio-1) Radio 1. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vaps Manually selected list of virtual access points (vaps). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_2 (Alias name: radio-2) Radio 2. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vaps Manually selected list of virtual access points (vaps). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_3 (Alias name: radio-3) Radio 3. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vaps Manually selected list of virtual access points (vaps). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_4 (Alias name: radio-4) Radio 4. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_power_target (Alias name: auto-power-target) Target of automatic transmit power adjustment in dbm (-95 to -20, default = -70). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- channel Selected list of wireless radio channels. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_band (Alias name: override-band) Enable to override the wtp profile band setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_channel (Alias name: override-channel) Enable to override wtp profile channel settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_txpower (Alias name: override-txpower) Enable to override the wtp profile power level configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_vaps (Alias name: override-vaps) Enable to override wtp profile virtual access point (vap) settings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- power_value (Alias name: power-value) Radio eirp power in dbm (1 - 33, default = 27). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap1 Virtual access point (vap) for wlan id 1 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap2 Virtual access point (vap) for wlan id 2 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap3 Virtual access point (vap) for wlan id 3 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap4 Virtual access point (vap) for wlan id 4 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap5 Virtual access point (vap) for wlan id 5 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap6 Virtual access point (vap) for wlan id 6 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap7 Virtual access point (vap) for wlan id 7 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vap8 Virtual access point (vap) for wlan id 8 type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vaps Manually selected list of virtual access points (vaps). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_analysis (Alias name: override-analysis) Enable to override the wtp profile spectrum analysis configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- region Region name wtp is associated with. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- region_x (Alias name: region-x) Relative horizontal region coordinate (between 0 and 1). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- region_y (Alias name: region-y) Relative vertical region coordinate (between 0 and 1). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- split_tunneling_acl (Alias name: split-tunneling-acl) Split tunneling acl. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dest_ip (Alias name: dest-ip) Destination ip and mask for the split-tunneling subnet. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- split_tunneling_acl_path (Alias name: split-tunneling-acl-path) Split tunneling acl path is local/tunnel. type: str choices: [tunnel, local]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wtp_id (Alias name: wtp-id) Wtp id. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wtp_mode (Alias name: wtp-mode) Wtp, ap, or fortiap operating mode (default = normal). type: str choices: [normal, remote]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wtp_profile (Alias name: wtp-profile) Wtp profile name to apply to this wtp, ap or fortiap. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- comment Comment. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- _prefer_img_ver (Alias name: _prefer-img-ver) Prefer img ver. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
- 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...
Supported Version Ranges: v7.6.4 -> latest
- 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...
Supported Version Ranges: v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- 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:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
wireless_wtp:
wtp_id: "your value" # Required variable, string
# admin:
# allowaccess:
# - "https"
# - "ssh"
# - "snmp"
# - "http"
# - "telnet"
# apcfg_profile:
# ble_major_id:
# ble_minor_id:
# bonjour_profile:
# coordinate_latitude:
# coordinate_longitude:
# firmware_provision:
# firmware_provision_latest:
# image_download:
# index:
# ip_fragment_preventing:
# - "tcp-mss-adjust"
# - "icmp-unreachable"
# lan:
# port_esl_mode:
# port_esl_ssid:
# port_mode:
# port_ssid:
# port1_mode:
# port1_ssid:
# port2_mode:
# port2_ssid:
# port3_mode:
# port3_ssid:
# port4_mode:
# port4_ssid:
# port5_mode:
# port5_ssid:
# port6_mode:
# port6_ssid:
# port7_mode:
# port7_ssid:
# port8_mode:
# port8_ssid:
# led_state:
# location:
# login_passwd:
# login_passwd_change:
# mesh_bridge_enable:
# name:
# override_allowaccess:
# override_ip_fragment:
# override_lan:
# override_led_state:
# override_login_passwd_change:
# override_split_tunnel:
# override_wan_port_mode:
# purdue_level:
# radio_1:
# auto_power_high:
# auto_power_level:
# auto_power_low:
# auto_power_target:
# 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:
# drma_manual_mode:
# override_band:
# override_channel:
# override_txpower:
# override_vaps:
# power_level:
# power_mode:
# power_value:
# radio_id:
# vap_all:
# vap1:
# vap2:
# vap3:
# vap4:
# vap5:
# vap6:
# vap7:
# vap8:
# vaps:
# spectrum_analysis:
# override_analysis:
# radio_2:
# auto_power_high:
# auto_power_level:
# auto_power_low:
# auto_power_target:
# 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:
# drma_manual_mode:
# override_band:
# override_channel:
# override_txpower:
# override_vaps:
# power_level:
# power_mode:
# power_value:
# radio_id:
# vap_all:
# vap1:
# vap2:
# vap3:
# vap4:
# vap5:
# vap6:
# vap7:
# vap8:
# vaps:
# spectrum_analysis:
# override_analysis:
# radio_3:
# auto_power_high:
# auto_power_level:
# auto_power_low:
# auto_power_target:
# 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:
# drma_manual_mode:
# override_band:
# override_channel:
# override_txpower:
# override_vaps:
# power_level:
# power_mode:
# power_value:
# radio_id:
# vap_all:
# vap1:
# vap2:
# vap3:
# vap4:
# vap5:
# vap6:
# vap7:
# vap8:
# vaps:
# spectrum_analysis:
# override_analysis:
# radio_4:
# auto_power_high:
# auto_power_level:
# auto_power_low:
# auto_power_target:
# 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:
# drma_manual_mode:
# override_band:
# override_channel:
# override_txpower:
# override_vaps:
# power_level:
# power_mode:
# power_value:
# radio_id:
# vap_all:
# vap1:
# vap2:
# vap3:
# vap4:
# vap5:
# vap6:
# vap7:
# vap8:
# vaps:
# spectrum_analysis:
# override_analysis:
# region:
# region_x:
# region_y:
# split_tunneling_acl:
# - dest_ip:
# id:
# split_tunneling_acl_local_ap_subnet:
# split_tunneling_acl_path:
# tun_mtu_downlink:
# tun_mtu_uplink:
# uuid:
# wan_port_mode:
# wtp_mode:
# wtp_profile:
# comment:
# _prefer_img_ver:
# default_mesh_root:
# override_default_mesh_root:
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:
.. raw:: html
- 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)