:source: fmgr_wtpprofile.py :orphan: .. _fmgr_wtpprofile: fmgr_wtpprofile -- Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. warning:: Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case). - Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name`` - New argument name starting in 3.0.0: ``var_name`` FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg. .. 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: v6.0.0 -> latest

Parameters ---------- .. raw:: html 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 tasks: - name: Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms. fortinet.fortimanager.fmgr_wtpprofile: # workspace_locking_adom: adom: state: present # wtpprofile: name: "your value" # Required variable, string # allowaccess: ["https", "ssh", "snmp", "http", "telnet"] # ap_country: # ble_profile: # comment: # control_message_offload: ["ebp-frame", "aeroscout-tag", "ap-list", "sta-list", # "sta-cap-list", "stats", "aeroscout-mu", "sta-health", # "spectral-analysis"] # deny_mac_list: # - id: # mac: # dtls_in_kernel: # dtls_policy: ["clear-text", "dtls-enabled", "ipsec-vpn", "ipsec-sn-vpn"] # energy_efficient_ethernet: # ext_info_enable: # handoff_roaming: # handoff_rssi: # handoff_sta_thresh: # ip_fragment_preventing: ["tcp-mss-adjust", "icmp-unreachable"] # led_schedules: # led_state: # lldp: # login_passwd: # login_passwd_change: # max_clients: # poe_mode: # split_tunneling_acl: # - dest_ip: # id: # split_tunneling_acl_local_ap_subnet: # split_tunneling_acl_path: # tun_mtu_downlink: # tun_mtu_uplink: # wan_port_mode: # snmp: # ap_handoff: # apcfg_profile: # frequency_handoff: # 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: # lbs: # aeroscout: # aeroscout_ap_mac: # aeroscout_mmu_report: # aeroscout_mu: # aeroscout_mu_factor: # aeroscout_mu_timeout: # aeroscout_server_ip: # aeroscout_server_port: # ekahau_blink_mode: # ekahau_tag: # erc_server_ip: # erc_server_port: # fortipresence: # fortipresence_ble: # fortipresence_frequency: # fortipresence_port: # fortipresence_project: # fortipresence_rogue: # fortipresence_secret: # fortipresence_server: # fortipresence_unassoc: # station_locate: # fortipresence_server_addr_type: # fortipresence_server_fqdn: # polestar: # polestar_accumulation_interval: # polestar_asset_addrgrp_list: # polestar_asset_uuid_list1: # polestar_asset_uuid_list2: # polestar_asset_uuid_list3: # polestar_asset_uuid_list4: # polestar_protocol: # polestar_reporting_interval: # polestar_server_fqdn: # polestar_server_path: # polestar_server_port: # polestar_server_token: # ble_rtls: # ble_rtls_accumulation_interval: # ble_rtls_asset_addrgrp_list: # ble_rtls_asset_uuid_list1: # ble_rtls_asset_uuid_list2: # ble_rtls_asset_uuid_list3: # ble_rtls_asset_uuid_list4: # ble_rtls_protocol: # ble_rtls_reporting_interval: # ble_rtls_server_fqdn: # ble_rtls_server_path: # ble_rtls_server_port: # ble_rtls_server_token: # platform: # ddscan: # mode: # type: # _local_platform_str: # radio_1: # airtime_fairness: # amsdu: # ap_sniffer_addr: # ap_sniffer_bufsize: # ap_sniffer_chan: # ap_sniffer_ctl: # ap_sniffer_data: # ap_sniffer_mgmt_beacon: # ap_sniffer_mgmt_other: # ap_sniffer_mgmt_probe: # auto_power_high: # auto_power_level: # auto_power_low: # auto_power_target: # band: # band_5g_type: # bandwidth_admission_control: # bandwidth_capacity: # beacon_interval: # bss_color: # call_admission_control: # call_capacity: # channel: # channel_bonding: # channel_utilization: # coexistence: # darrp: # drma: # drma_sensitivity: # dtim: # frag_threshold: # max_clients: # max_distance: # mode: # power_level: # powersave_optimize: ["tim", "ac-vo", "no-obss-scan", "no-11b-rate", # "client-rate-follow"] # protection_mode: # radio_id: # rts_threshold: # short_guard_interval: # spectrum_analysis: # transmit_optimize: ["disable", "power-save", "aggr-limit", "retry-limit", # "send-bar"] # vap_all: # vap1: # vap2: # vap3: # vap4: # vap5: # vap6: # vap7: # vap8: # vaps: # wids_profile: # zero_wait_dfs: # frequency_handoff: # ap_handoff: # iperf_protocol: # iperf_server_port: # power_mode: # power_value: # sam_bssid: # sam_captive_portal: # sam_password: # sam_report_intv: # sam_security_type: # sam_server: # sam_ssid: # sam_test: # sam_username: # arrp_profile: # bss_color_mode: # sam_cwp_failure_string: # sam_cwp_match_string: # sam_cwp_password: # sam_cwp_success_string: # sam_cwp_test_url: # sam_cwp_username: # sam_server_fqdn: # sam_server_ip: # sam_server_type: # d80211d: # optional_antenna: # mimo_mode: # optional_antenna_gain: # sam_ca_certificate: # sam_client_certificate: # sam_eap_method: # sam_private_key: # sam_private_key_password: # channel_bonding_ext: # d80211mc: # ap_sniffer_chan_width: # ai_darrp_support: # radio_2: # airtime_fairness: # amsdu: # ap_sniffer_addr: # ap_sniffer_bufsize: # ap_sniffer_chan: # ap_sniffer_ctl: # ap_sniffer_data: # ap_sniffer_mgmt_beacon: # ap_sniffer_mgmt_other: # ap_sniffer_mgmt_probe: # auto_power_high: # auto_power_level: # auto_power_low: # auto_power_target: # band: # band_5g_type: # bandwidth_admission_control: # bandwidth_capacity: # beacon_interval: # bss_color: # call_admission_control: # call_capacity: # channel: # channel_bonding: # channel_utilization: # coexistence: # darrp: # drma: # drma_sensitivity: # dtim: # frag_threshold: # max_clients: # max_distance: # mode: # power_level: # powersave_optimize: ["tim", "ac-vo", "no-obss-scan", "no-11b-rate", # "client-rate-follow"] # protection_mode: # radio_id: # rts_threshold: # short_guard_interval: # spectrum_analysis: # transmit_optimize: ["disable", "power-save", "aggr-limit", "retry-limit", # "send-bar"] # vap_all: # vap1: # vap2: # vap3: # vap4: # vap5: # vap6: # vap7: # vap8: # vaps: # wids_profile: # zero_wait_dfs: # frequency_handoff: # ap_handoff: # iperf_protocol: # iperf_server_port: # power_mode: # power_value: # sam_bssid: # sam_captive_portal: # sam_password: # sam_report_intv: # sam_security_type: # sam_server: # sam_ssid: # sam_test: # sam_username: # arrp_profile: # bss_color_mode: # sam_cwp_failure_string: # sam_cwp_match_string: # sam_cwp_password: # sam_cwp_success_string: # sam_cwp_test_url: # sam_cwp_username: # sam_server_fqdn: # sam_server_ip: # sam_server_type: # d80211d: # optional_antenna: # mimo_mode: # optional_antenna_gain: # sam_ca_certificate: # sam_client_certificate: # sam_eap_method: # sam_private_key: # sam_private_key_password: # channel_bonding_ext: # d80211mc: # ap_sniffer_chan_width: # ai_darrp_support: # radio_3: # airtime_fairness: # amsdu: # ap_sniffer_addr: # ap_sniffer_bufsize: # ap_sniffer_chan: # ap_sniffer_ctl: # ap_sniffer_data: # ap_sniffer_mgmt_beacon: # ap_sniffer_mgmt_other: # ap_sniffer_mgmt_probe: # auto_power_high: # auto_power_level: # auto_power_low: # auto_power_target: # band: # band_5g_type: # bandwidth_admission_control: # bandwidth_capacity: # beacon_interval: # bss_color: # call_admission_control: # call_capacity: # channel: # channel_bonding: # channel_utilization: # coexistence: # darrp: # drma: # drma_sensitivity: # dtim: # frag_threshold: # max_clients: # max_distance: # mode: # power_level: # powersave_optimize: ["tim", "ac-vo", "no-obss-scan", "no-11b-rate", # "client-rate-follow"] # protection_mode: # radio_id: # rts_threshold: # short_guard_interval: # spectrum_analysis: # transmit_optimize: ["disable", "power-save", "aggr-limit", "retry-limit", # "send-bar"] # vap_all: # vap1: # vap2: # vap3: # vap4: # vap5: # vap6: # vap7: # vap8: # vaps: # wids_profile: # zero_wait_dfs: # frequency_handoff: # ap_handoff: # iperf_protocol: # iperf_server_port: # power_mode: # power_value: # sam_bssid: # sam_captive_portal: # sam_password: # sam_report_intv: # sam_security_type: # sam_server: # sam_ssid: # sam_test: # sam_username: # arrp_profile: # bss_color_mode: # sam_cwp_failure_string: # sam_cwp_match_string: # sam_cwp_password: # sam_cwp_success_string: # sam_cwp_test_url: # sam_cwp_username: # sam_server_fqdn: # sam_server_ip: # sam_server_type: # d80211d: # optional_antenna: # mimo_mode: # optional_antenna_gain: # sam_ca_certificate: # sam_client_certificate: # sam_eap_method: # sam_private_key: # sam_private_key_password: # channel_bonding_ext: # d80211mc: # ap_sniffer_chan_width: # ai_darrp_support: # radio_4: # airtime_fairness: # amsdu: # ap_sniffer_addr: # ap_sniffer_bufsize: # ap_sniffer_chan: # ap_sniffer_ctl: # ap_sniffer_data: # ap_sniffer_mgmt_beacon: # ap_sniffer_mgmt_other: # ap_sniffer_mgmt_probe: # auto_power_high: # auto_power_level: # auto_power_low: # auto_power_target: # band: # band_5g_type: # bandwidth_admission_control: # bandwidth_capacity: # beacon_interval: # bss_color: # call_admission_control: # call_capacity: # channel: # channel_bonding: # channel_utilization: # coexistence: # darrp: # drma: # drma_sensitivity: # dtim: # frag_threshold: # max_clients: # max_distance: # mode: # power_level: # powersave_optimize: ["tim", "ac-vo", "no-obss-scan", "no-11b-rate", # "client-rate-follow"] # protection_mode: # radio_id: # rts_threshold: # short_guard_interval: # spectrum_analysis: # transmit_optimize: ["disable", "power-save", "aggr-limit", "retry-limit", # "send-bar"] # vap_all: # vap1: # vap2: # vap3: # vap4: # vap5: # vap6: # vap7: # vap8: # vaps: # wids_profile: # zero_wait_dfs: # frequency_handoff: # ap_handoff: # iperf_protocol: # iperf_server_port: # power_mode: # power_value: # sam_bssid: # sam_captive_portal: # sam_password: # sam_report_intv: # sam_security_type: # sam_server: # sam_ssid: # sam_test: # sam_username: # arrp_profile: # bss_color_mode: # sam_cwp_failure_string: # sam_cwp_match_string: # sam_cwp_password: # sam_cwp_success_string: # sam_cwp_test_url: # sam_cwp_username: # sam_server_fqdn: # sam_server_ip: # sam_server_type: # d80211d: # optional_antenna: # mimo_mode: # optional_antenna_gain: # sam_ca_certificate: # sam_client_certificate: # sam_eap_method: # sam_private_key: # sam_private_key_password: # channel_bonding_ext: # d80211mc: # ap_sniffer_chan_width: # ai_darrp_support: # console_login: # esl_ses_dongle: # apc_addr_type: # apc_fqdn: # apc_ip: # apc_port: # coex_level: # compliance_level: # esl_channel: # output_power: # scd_enable: # tls_cert_verification: # tls_fqdn_verification: # indoor_outdoor_deployment: # syslog_profile: # wan_port_auth: # wan_port_auth_methods: # wan_port_auth_password: # wan_port_auth_usrname: # _is_factory_setting: # unii_4_5ghz_band: # bonjour_profile: # wan_port_auth_macsec: # usb_port: # admin_auth_tacacs_: # admin_restrict_local: # apcfg_mesh: # apcfg_mesh_ap_type: # apcfg_mesh_eth_bridge: # apcfg_mesh_passwd: # apcfg_mesh_ssid: # default_mesh_root: # apcfg_auto_cert: # apcfg_auto_cert_auto_regen_days: # apcfg_auto_cert_crypto_algo: # apcfg_auto_cert_enroll_protocol: # apcfg_auto_cert_est_ca_id: # apcfg_auto_cert_est_http_password: # apcfg_auto_cert_est_http_username: # apcfg_auto_cert_est_https_ca: # 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: # apcfg_auto_cert_scep_https_ca: # apcfg_auto_cert_scep_keysize: # apcfg_auto_cert_scep_keytype: # apcfg_auto_cert_scep_password: # apcfg_auto_cert_scep_sub_fully_dn: # apcfg_auto_cert_scep_subject_alt_name: # apcfg_auto_cert_scep_url: # lw_profile: 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)