:source: fortios_wireless_controller_wtp_profile.py :orphan: .. fortios_wireless_controller_wtp_profile: fortios_wireless_controller_wtp_profile -- Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet's FortiOS and FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 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_profile 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.15 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. fortinet.fortios.fortios_wireless_controller_wtp_profile: vdom: "{{ vdom }}" state: "present" access_token: "" wireless_controller_wtp_profile: admin_auth_tacacs_plus: " (source user.tacacs+.name)" admin_restrict_local: "enable" allowaccess: "https" ap_country: "--" ap_handoff: "enable" apcfg_auto_cert: "enable" apcfg_auto_cert_auto_regen_days: "30" apcfg_auto_cert_crypto_algo: "rsa-1024" apcfg_auto_cert_enroll_protocol: "none" apcfg_auto_cert_est_ca_id: "" apcfg_auto_cert_est_http_password: "" apcfg_auto_cert_est_http_username: "" apcfg_auto_cert_est_https_ca: " (source vpn.certificate.ca.name)" apcfg_auto_cert_est_server: "" apcfg_auto_cert_est_subject: "" apcfg_auto_cert_est_subject_alt_name: "" apcfg_auto_cert_scep_ca_id: "" apcfg_auto_cert_scep_ec_name: "secp256r1" apcfg_auto_cert_scep_https_ca: " (source vpn.certificate.ca.name)" apcfg_auto_cert_scep_keysize: "1024" apcfg_auto_cert_scep_keytype: "rsa" apcfg_auto_cert_scep_password: "" apcfg_auto_cert_scep_sub_fully_dn: "" apcfg_auto_cert_scep_subject_alt_name: "" apcfg_auto_cert_scep_url: "" apcfg_mesh: "enable" apcfg_mesh_ap_type: "ethernet" apcfg_mesh_eth_bridge: "enable" apcfg_mesh_ssid: " (source wireless-controller.vap.name)" apcfg_profile: " (source wireless-controller.apcfg-profile.name)" ble_profile: " (source wireless-controller.ble-profile.name)" bonjour_profile: " (source wireless-controller.bonjour-profile.name)" comment: "Comment." console_login: "enable" control_message_offload: "ebp-frame" default_mesh_root: "enable" deny_mac_list: - id: "40" mac: "" dtls_in_kernel: "enable" dtls_policy: "clear-text" energy_efficient_ethernet: "enable" esl_ses_dongle: apc_addr_type: "fqdn" apc_fqdn: "" apc_ip: "" apc_port: "0" coex_level: "none" compliance_level: "compliance-level-2" esl_channel: "-1" output_power: "a" scd_enable: "enable" tls_cert_verification: "enable" tls_fqdn_verification: "enable" ext_info_enable: "enable" frequency_handoff: "enable" handoff_roaming: "enable" handoff_rssi: "25" handoff_sta_thresh: "0" indoor_outdoor_deployment: "platform-determined" ip_fragment_preventing: "tcp-mss-adjust" lan: port_esl_mode: "offline" port_esl_ssid: " (source system.interface.name)" port_mode: "offline" port_ssid: " (source system.interface.name)" port1_mode: "offline" port1_ssid: " (source system.interface.name)" port2_mode: "offline" port2_ssid: " (source system.interface.name)" port3_mode: "offline" port3_ssid: " (source system.interface.name)" port4_mode: "offline" port4_ssid: " (source system.interface.name)" port5_mode: "offline" port5_ssid: " (source system.interface.name)" port6_mode: "offline" port6_ssid: " (source system.interface.name)" port7_mode: "offline" port7_ssid: " (source system.interface.name)" port8_mode: "offline" port8_ssid: " (source system.interface.name)" lbs: aeroscout: "enable" aeroscout_ap_mac: "bssid" aeroscout_mmu_report: "enable" aeroscout_mu: "enable" aeroscout_mu_factor: "20" aeroscout_mu_timeout: "5" aeroscout_server_ip: "" aeroscout_server_port: "0" ble_rtls: "none" ble_rtls_accumulation_interval: "2" ble_rtls_asset_addrgrp_list: " (source firewall.addrgrp.name)" ble_rtls_asset_uuid_list1: "" ble_rtls_asset_uuid_list2: "" ble_rtls_asset_uuid_list3: "" ble_rtls_asset_uuid_list4: "" ble_rtls_protocol: "WSS" ble_rtls_reporting_interval: "2" ble_rtls_server_fqdn: "" ble_rtls_server_path: "" ble_rtls_server_port: "443" ble_rtls_server_token: "" ekahau_blink_mode: "enable" ekahau_tag: "" erc_server_ip: "" erc_server_port: "8569" fortipresence: "foreign" fortipresence_ble: "enable" fortipresence_frequency: "30" fortipresence_port: "3000" fortipresence_project: "" fortipresence_rogue: "enable" fortipresence_secret: "" fortipresence_server: "" fortipresence_server_addr_type: "ipv4" fortipresence_server_fqdn: "" fortipresence_unassoc: "enable" polestar: "enable" polestar_accumulation_interval: "2" polestar_asset_addrgrp_list: " (source firewall.addrgrp.name)" polestar_asset_uuid_list1: "" polestar_asset_uuid_list2: "" polestar_asset_uuid_list3: "" polestar_asset_uuid_list4: "" polestar_protocol: "WSS" polestar_reporting_interval: "2" polestar_server_fqdn: "" polestar_server_path: "" polestar_server_port: "443" polestar_server_token: "" station_locate: "enable" led_schedules: - name: "default_name_137 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)" led_state: "enable" lldp: "enable" login_passwd: "" login_passwd_change: "yes" lw_profile: " (source wireless-controller.lw-profile.name)" max_clients: "0" name: "default_name_144" platform: ddscan: "enable" mode: "single-5G" type: "AP-11N" poe_mode: "auto" radio_1: ai_darrp_support: "enable" airtime_fairness: "enable" amsdu: "enable" ap_handoff: "enable" ap_sniffer_addr: "" ap_sniffer_bufsize: "16" ap_sniffer_chan: "36" ap_sniffer_chan_width: "320MHz" ap_sniffer_ctl: "enable" ap_sniffer_data: "enable" ap_sniffer_mgmt_beacon: "enable" ap_sniffer_mgmt_other: "enable" ap_sniffer_mgmt_probe: "enable" arrp_profile: " (source wireless-controller.arrp-profile.name)" auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" band_5g_type: "5g-full" bandwidth_admission_control: "enable" bandwidth_capacity: "2000" beacon_interval: "100" bss_color: "0" bss_color_mode: "auto" call_admission_control: "enable" call_capacity: "10" channel: - chan: "" channel_bonding: "320MHz" channel_bonding_ext: "320MHz-1" channel_utilization: "enable" coexistence: "enable" darrp: "enable" drma: "disable" drma_sensitivity: "low" dtim: "1" frag_threshold: "2346" frequency_handoff: "enable" iperf_protocol: "udp" iperf_server_port: "5001" max_clients: "0" max_distance: "0" mimo_mode: "default" mode: "disabled" optional_antenna: "none" optional_antenna_gain: "" power_level: "100" power_mode: "dBm" power_value: "27" powersave_optimize: "tim" protection_mode: "rtscts" radio_id: "2" rts_threshold: "2346" sam_bssid: "" sam_ca_certificate: " (source vpn.certificate.ca.name)" sam_captive_portal: "enable" sam_client_certificate: " (source vpn.certificate.local.name)" sam_cwp_failure_string: "" sam_cwp_match_string: "" sam_cwp_password: "" sam_cwp_success_string: "" sam_cwp_test_url: "" sam_cwp_username: "" sam_eap_method: "both" sam_password: "" sam_private_key: " (source vpn.certificate.local.name)" sam_private_key_password: "" sam_report_intv: "0" sam_security_type: "open" sam_server: "" sam_server_fqdn: "" sam_server_ip: "" sam_server_type: "ip" sam_ssid: "" sam_test: "ping" sam_username: "" set_80211d: "enable" set_80211mc: "enable" short_guard_interval: "enable" spectrum_analysis: "enable" transmit_optimize: "disable" vap_all: "tunnel" vaps: - name: "default_name_235 (source wireless-controller.vap-group.name system.interface.name)" wids_profile: " (source wireless-controller.wids-profile.name)" zero_wait_dfs: "enable" radio_2: ai_darrp_support: "enable" airtime_fairness: "enable" amsdu: "enable" ap_handoff: "enable" ap_sniffer_addr: "" ap_sniffer_bufsize: "16" ap_sniffer_chan: "6" ap_sniffer_chan_width: "320MHz" ap_sniffer_ctl: "enable" ap_sniffer_data: "enable" ap_sniffer_mgmt_beacon: "enable" ap_sniffer_mgmt_other: "enable" ap_sniffer_mgmt_probe: "enable" arrp_profile: " (source wireless-controller.arrp-profile.name)" auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" band_5g_type: "5g-full" bandwidth_admission_control: "enable" bandwidth_capacity: "2000" beacon_interval: "100" bss_color: "0" bss_color_mode: "auto" call_admission_control: "enable" call_capacity: "10" channel: - chan: "" channel_bonding: "320MHz" channel_bonding_ext: "320MHz-1" channel_utilization: "enable" coexistence: "enable" darrp: "enable" drma: "disable" drma_sensitivity: "low" dtim: "1" frag_threshold: "2346" frequency_handoff: "enable" iperf_protocol: "udp" iperf_server_port: "5001" max_clients: "0" max_distance: "0" mimo_mode: "default" mode: "disabled" optional_antenna: "none" optional_antenna_gain: "" power_level: "100" power_mode: "dBm" power_value: "27" powersave_optimize: "tim" protection_mode: "rtscts" radio_id: "2" rts_threshold: "2346" sam_bssid: "" sam_ca_certificate: " (source vpn.certificate.ca.name)" sam_captive_portal: "enable" sam_client_certificate: " (source vpn.certificate.local.name)" sam_cwp_failure_string: "" sam_cwp_match_string: "" sam_cwp_password: "" sam_cwp_success_string: "" sam_cwp_test_url: "" sam_cwp_username: "" sam_eap_method: "both" sam_password: "" sam_private_key: " (source vpn.certificate.local.name)" sam_private_key_password: "" sam_report_intv: "0" sam_security_type: "open" sam_server: "" sam_server_fqdn: "" sam_server_ip: "" sam_server_type: "ip" sam_ssid: "" sam_test: "ping" sam_username: "" set_80211d: "enable" set_80211mc: "enable" short_guard_interval: "enable" spectrum_analysis: "enable" transmit_optimize: "disable" vap_all: "tunnel" vaps: - name: "default_name_323 (source wireless-controller.vap-group.name system.interface.name)" wids_profile: " (source wireless-controller.wids-profile.name)" zero_wait_dfs: "enable" radio_3: ai_darrp_support: "enable" airtime_fairness: "enable" amsdu: "enable" ap_handoff: "enable" ap_sniffer_addr: "" ap_sniffer_bufsize: "16" ap_sniffer_chan: "37" ap_sniffer_chan_width: "320MHz" ap_sniffer_ctl: "enable" ap_sniffer_data: "enable" ap_sniffer_mgmt_beacon: "enable" ap_sniffer_mgmt_other: "enable" ap_sniffer_mgmt_probe: "enable" arrp_profile: " (source wireless-controller.arrp-profile.name)" auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" band_5g_type: "5g-full" bandwidth_admission_control: "enable" bandwidth_capacity: "2000" beacon_interval: "100" bss_color: "0" bss_color_mode: "auto" call_admission_control: "enable" call_capacity: "10" channel: - chan: "" channel_bonding: "320MHz" channel_bonding_ext: "320MHz-1" channel_utilization: "enable" coexistence: "enable" darrp: "enable" drma: "disable" drma_sensitivity: "low" dtim: "1" frag_threshold: "2346" frequency_handoff: "enable" iperf_protocol: "udp" iperf_server_port: "5001" max_clients: "0" max_distance: "0" mimo_mode: "default" mode: "disabled" optional_antenna: "none" optional_antenna_gain: "" power_level: "100" power_mode: "dBm" power_value: "27" powersave_optimize: "tim" protection_mode: "rtscts" radio_id: "2" rts_threshold: "2346" sam_bssid: "" sam_ca_certificate: " (source vpn.certificate.ca.name)" sam_captive_portal: "enable" sam_client_certificate: " (source vpn.certificate.local.name)" sam_cwp_failure_string: "" sam_cwp_match_string: "" sam_cwp_password: "" sam_cwp_success_string: "" sam_cwp_test_url: "" sam_cwp_username: "" sam_eap_method: "both" sam_password: "" sam_private_key: " (source vpn.certificate.local.name)" sam_private_key_password: "" sam_report_intv: "0" sam_security_type: "open" sam_server: "" sam_server_fqdn: "" sam_server_ip: "" sam_server_type: "ip" sam_ssid: "" sam_test: "ping" sam_username: "" set_80211d: "enable" set_80211mc: "enable" short_guard_interval: "enable" spectrum_analysis: "enable" transmit_optimize: "disable" vap_all: "tunnel" vaps: - name: "default_name_411 (source wireless-controller.vap-group.name system.interface.name)" wids_profile: " (source wireless-controller.wids-profile.name)" zero_wait_dfs: "enable" radio_4: ai_darrp_support: "enable" airtime_fairness: "enable" amsdu: "enable" ap_handoff: "enable" ap_sniffer_addr: "" ap_sniffer_bufsize: "16" ap_sniffer_chan: "6" ap_sniffer_chan_width: "320MHz" ap_sniffer_ctl: "enable" ap_sniffer_data: "enable" ap_sniffer_mgmt_beacon: "enable" ap_sniffer_mgmt_other: "enable" ap_sniffer_mgmt_probe: "enable" arrp_profile: " (source wireless-controller.arrp-profile.name)" auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" band_5g_type: "5g-full" bandwidth_admission_control: "enable" bandwidth_capacity: "2000" beacon_interval: "100" bss_color: "0" bss_color_mode: "auto" call_admission_control: "enable" call_capacity: "10" channel: - chan: "" channel_bonding: "320MHz" channel_bonding_ext: "320MHz-1" channel_utilization: "enable" coexistence: "enable" darrp: "enable" drma: "disable" drma_sensitivity: "low" dtim: "1" frag_threshold: "2346" frequency_handoff: "enable" iperf_protocol: "udp" iperf_server_port: "5001" max_clients: "0" max_distance: "0" mimo_mode: "default" mode: "disabled" optional_antenna: "none" optional_antenna_gain: "" power_level: "100" power_mode: "dBm" power_value: "27" powersave_optimize: "tim" protection_mode: "rtscts" rts_threshold: "2346" sam_bssid: "" sam_ca_certificate: " (source vpn.certificate.ca.name)" sam_captive_portal: "enable" sam_client_certificate: " (source vpn.certificate.local.name)" sam_cwp_failure_string: "" sam_cwp_match_string: "" sam_cwp_password: "" sam_cwp_success_string: "" sam_cwp_test_url: "" sam_cwp_username: "" sam_eap_method: "both" sam_password: "" sam_private_key: " (source vpn.certificate.local.name)" sam_private_key_password: "" sam_report_intv: "0" sam_security_type: "open" sam_server: "" sam_server_fqdn: "" sam_server_ip: "" sam_server_type: "ip" sam_ssid: "" sam_test: "ping" sam_username: "" set_80211d: "enable" set_80211mc: "enable" short_guard_interval: "enable" spectrum_analysis: "enable" transmit_optimize: "disable" vap_all: "tunnel" vaps: - name: "default_name_498 (source wireless-controller.vap-group.name system.interface.name)" wids_profile: " (source wireless-controller.wids-profile.name)" zero_wait_dfs: "enable" split_tunneling_acl: - dest_ip: "" id: "503" split_tunneling_acl_local_ap_subnet: "enable" split_tunneling_acl_path: "tunnel" syslog_profile: " (source wireless-controller.syslog-profile.name)" tun_mtu_downlink: "0" tun_mtu_uplink: "0" unii_4_5ghz_band: "enable" usb_port: "enable" wan_port_auth: "none" wan_port_auth_macsec: "enable" wan_port_auth_methods: "all" wan_port_auth_password: "" wan_port_auth_usrname: "" wan_port_mode: "wan-lan" 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
  • 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
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.