: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 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)