:source: fortios_wireless_controller_wtp.py :orphan: .. fortios_wireless_controller_wtp: fortios_wireless_controller_wtp -- Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate 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 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.16 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 Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate. fortinet.fortios.fortios_wireless_controller_wtp: vdom: "{{ vdom }}" state: "present" access_token: "" wireless_controller_wtp: admin: "discovered" allowaccess: "https" apcfg_profile: " (source wireless-controller.apcfg-profile.name)" ble_major_id: "0" ble_minor_id: "0" bonjour_profile: " (source wireless-controller.bonjour-profile.name)" comment: "Comment." coordinate_enable: "enable" coordinate_latitude: "" coordinate_longitude: "" coordinate_x: "" coordinate_y: "" default_mesh_root: "enable" firmware_provision: "" firmware_provision_latest: "disable" image_download: "enable" index: "0" 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)" led_state: "enable" location: "" login_passwd: "" login_passwd_change: "yes" mesh_bridge_enable: "default" name: "default_name_47" override_allowaccess: "enable" override_default_mesh_root: "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" purdue_level: "1" radio_1: auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" channel: - chan: "" drma_manual_mode: "ap" override_analysis: "enable" override_band: "enable" override_channel: "enable" override_txpower: "enable" override_vaps: "enable" power_level: "100" power_mode: "dBm" power_value: "27" radio_id: "2" spectrum_analysis: "enable" vap_all: "tunnel" vaps: - name: "default_name_78 (source wireless-controller.vap-group.name system.interface.name)" radio_2: auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" channel: - chan: "" drma_manual_mode: "ap" override_analysis: "enable" override_band: "enable" override_channel: "enable" override_txpower: "enable" override_vaps: "enable" power_level: "100" power_mode: "dBm" power_value: "27" radio_id: "2" spectrum_analysis: "enable" vap_all: "tunnel" vaps: - name: "default_name_100 (source wireless-controller.vap-group.name system.interface.name)" radio_3: auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" channel: - chan: "" drma_manual_mode: "ap" override_analysis: "enable" override_band: "enable" override_channel: "enable" override_txpower: "enable" override_vaps: "enable" power_level: "100" power_mode: "dBm" power_value: "27" radio_id: "2" spectrum_analysis: "enable" vap_all: "tunnel" vaps: - name: "default_name_122 (source wireless-controller.vap-group.name system.interface.name)" radio_4: auto_power_high: "17" auto_power_level: "enable" auto_power_low: "10" auto_power_target: "" band: "802.11a" channel: - chan: "" drma_manual_mode: "ap" override_analysis: "enable" override_band: "enable" override_channel: "enable" override_txpower: "enable" override_vaps: "enable" power_level: "100" power_mode: "dBm" power_value: "27" spectrum_analysis: "enable" vap_all: "tunnel" vaps: - name: "default_name_143 (source wireless-controller.vap-group.name system.interface.name)" region: " (source wireless-controller.region.name)" region_x: "" region_y: "" split_tunneling_acl: - dest_ip: "" id: "149" split_tunneling_acl_local_ap_subnet: "enable" split_tunneling_acl_path: "tunnel" tun_mtu_downlink: "0" tun_mtu_uplink: "0" uuid: "" wan_port_mode: "wan-lan" wtp_id: "" wtp_mode: "normal" wtp_profile: " (source wireless-controller.wtp-profile.name)" 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.