:source: fortios_wireless_controller_vap.py :orphan: .. fortios_wireless_controller_vap: fortios_wireless_controller_vap -- Configure Virtual Access Points (VAPs) 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 vap 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 Virtual Access Points (VAPs). fortinet.fortios.fortios_wireless_controller_vap: vdom: "{{ vdom }}" state: "present" access_token: "" wireless_controller_vap: access_control_list: " (source wireless-controller.access-control-list.name)" acct_interim_interval: "43200" additional_akms: "akm6" address_group: " (source firewall.addrgrp.name)" address_group_policy: "disable" akm24_only: "disable" alias: "" antivirus_profile: " (source antivirus.profile.name)" application_detection_engine: "enable" application_dscp_marking: "enable" application_list: " (source application.list.name)" application_report_intv: "120" atf_weight: "20" auth: "radius" auth_cert: " (source vpn.certificate.local.name)" auth_portal_addr: "" beacon_advertising: "name" beacon_protection: "disable" broadcast_ssid: "enable" broadcast_suppression: "dhcp-up" bss_color_partial: "enable" bstm_disassociation_imminent: "enable" bstm_load_balancing_disassoc_timer: "10" bstm_rssi_disassoc_timer: "200" called_station_id_type: "mac" captive_network_assistant_bypass: "enable" captive_portal: "enable" captive_portal_ac_name: "" captive_portal_auth_timeout: "0" captive_portal_fw_accounting: "enable" captive_portal_macauth_radius_secret: "" captive_portal_macauth_radius_server: "" captive_portal_radius_secret: "" captive_portal_radius_server: "" captive_portal_session_timeout_interval: "432000" dhcp_address_enforcement: "enable" dhcp_lease_time: "2400" dhcp_option43_insertion: "enable" dhcp_option82_circuit_id_insertion: "style-1" dhcp_option82_insertion: "enable" dhcp_option82_remote_id_insertion: "style-1" domain_name_stripping: "disable" dynamic_vlan: "enable" eap_reauth: "enable" eap_reauth_intv: "86400" eapol_key_retries: "disable" encrypt: "TKIP" external_fast_roaming: "enable" external_logout: "" external_pre_auth: "enable" external_web: "" external_web_format: "auto-detect" fast_bss_transition: "disable" fast_roaming: "enable" ft_mobility_domain: "1000" ft_over_ds: "disable" ft_r0_key_lifetime: "480" gas_comeback_delay: "500" gas_fragmentation_limit: "1024" gtk_rekey: "enable" gtk_rekey_intv: "86400" high_efficiency: "enable" hotspot20_profile: " (source wireless-controller.hotspot20.hs-profile.name)" igmp_snooping: "enable" intra_vap_privacy: "enable" ip: "" ips_sensor: " (source ips.sensor.name)" ipv6_rules: "drop-icmp6ra" key: "" keyindex: "1" l3_roaming: "enable" l3_roaming_mode: "direct" ldpc: "disable" local_authentication: "enable" local_bridging: "enable" local_lan: "allow" local_lan_partition: "enable" local_standalone: "enable" local_standalone_dns: "enable" local_standalone_dns_ip: "" local_standalone_nat: "enable" mac_auth_bypass: "enable" mac_called_station_delimiter: "hyphen" mac_calling_station_delimiter: "hyphen" mac_case: "uppercase" mac_filter: "enable" mac_filter_list: - id: "90" mac: "" mac_filter_policy: "allow" mac_filter_policy_other: "allow" mac_password_delimiter: "hyphen" mac_username_delimiter: "hyphen" max_clients: "0" max_clients_ap: "0" mbo: "disable" mbo_cell_data_conn_pref: "excluded" me_disable_thresh: "32" mesh_backhaul: "enable" mlo: "disable" mpsk: "enable" mpsk_concurrent_clients: "32767" mpsk_key: - comment: "Comment." concurrent_clients: "" key_name: "" mpsk_schedules: - name: "default_name_110 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)" passphrase: "" mpsk_profile: " (source wireless-controller.mpsk-profile.name)" mu_mimo: "enable" multicast_enhance: "enable" multicast_rate: "0" nac: "enable" nac_profile: " (source wireless-controller.nac-profile.name)" name: "default_name_118" nas_filter_rule: "enable" neighbor_report_dual_band: "disable" okc: "disable" osen: "enable" owe_groups: "19" owe_transition: "disable" owe_transition_ssid: "" passphrase: "" pmf: "disable" pmf_assoc_comeback_timeout: "1" pmf_sa_query_retry_timeout: "2" port_macauth: "disable" port_macauth_reauth_timeout: "7200" port_macauth_timeout: "600" portal_message_override_group: " (source system.replacemsg-group.name)" portal_message_overrides: auth_disclaimer_page: "" auth_login_failed_page: "" auth_login_page: "" auth_reject_page: "" portal_type: "auth" pre_auth: "enable" primary_wag_profile: " (source wireless-controller.wag-profile.name)" probe_resp_suppression: "enable" probe_resp_threshold: "" ptk_rekey: "enable" ptk_rekey_intv: "86400" qos_profile: " (source wireless-controller.qos-profile.name)" quarantine: "enable" radio_2g_threshold: "" radio_5g_threshold: "" radio_sensitivity: "enable" radius_mac_auth: "enable" radius_mac_auth_block_interval: "0" radius_mac_auth_server: " (source user.radius.name)" radius_mac_auth_usergroups: - name: "default_name_155 (source user.group.name)" radius_mac_mpsk_auth: "enable" radius_mac_mpsk_timeout: "86400" radius_server: " (source user.radius.name)" rates_11a: "6" rates_11ac_mcs_map: "" rates_11ac_ss12: "mcs0/1" rates_11ac_ss34: "mcs0/3" rates_11ax_mcs_map: "" rates_11ax_ss12: "mcs0/1" rates_11ax_ss34: "mcs0/3" rates_11be_mcs_map: "" rates_11be_mcs_map_160: "" rates_11be_mcs_map_320: "" rates_11bg: "1" rates_11n_ss12: "mcs0/1" rates_11n_ss34: "mcs16/3" roaming_acct_interim_update: "enable" sae_groups: "19" sae_h2e_only: "enable" sae_hnp_only: "enable" sae_password: "" sae_pk: "enable" sae_private_key: "" scan_botnet_connections: "disable" schedule: - name: "default_name_181 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)" secondary_wag_profile: " (source wireless-controller.wag-profile.name)" security: "open" security_exempt_list: " (source user.security-exempt-list.name)" security_obsolete_option: "enable" security_redirect_url: "" selected_usergroups: - name: "default_name_188 (source user.group.name)" set_80211k: "disable" set_80211v: "disable" split_tunneling: "enable" ssid: "" sticky_client_remove: "enable" sticky_client_threshold_2g: "" sticky_client_threshold_5g: "" sticky_client_threshold_6g: "" target_wake_time: "enable" tkip_counter_measure: "enable" tunnel_echo_interval: "300" tunnel_fallback_interval: "7200" usergroup: - name: "default_name_202 (source user.group.name)" utm_log: "enable" utm_profile: " (source wireless-controller.utm-profile.name)" utm_status: "enable" vdom: " (source system.vdom.name)" vlan_auto: "enable" vlan_name: - name: "default_name_209" vlan_id: "" vlan_pool: - id: "212" wtp_group: " (source wireless-controller.wtp-group.name)" vlan_pooling: "wtp-group" vlanid: "0" voice_enterprise: "disable" webfilter_profile: " (source webfilter.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.