:source: fmgd_wireless_vap.py :orphan: .. _fmgd_wireless_vap: fmgd_wireless_vap -- Configure Virtual Access Points (VAPs). ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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 Virtual Access Points fortinet.fmgdevice.fmgd_wireless_vap: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # wireless_vap: name: "your value" # Required variable, string # d80211k: # d80211v: # _centmgmt: # _dhcp_svr_id: # _intf_allowaccess: # - "https" # - "ping" # - "ssh" # - "snmp" # - "http" # - "telnet" # - "fgfm" # - "radius-acct" # - "probe-response" # - "capwap" # - "dnp" # - "ftm" # - "fabric" # - "speed-test" # _intf_device_access_list: # _intf_device_identification: # _intf_device_netscan: # _intf_dhcp_relay_ip: # _intf_dhcp_relay_service: # _intf_dhcp_relay_type: # _intf_dhcp6_relay_ip: # _intf_dhcp6_relay_service: # _intf_dhcp6_relay_type: # _intf_ip: # _intf_ip6_address: # _intf_ip6_allowaccess: # - "https" # - "ping" # - "ssh" # - "snmp" # - "http" # - "telnet" # - "any" # - "fgfm" # - "capwap" # _intf_listen_forticlient_connection: # _is_factory_setting: # access_control_list: # additional_akms: # - "akm6" # - "akm24" # address_group: # address_group_policy: # akm24_only: # alias: # antivirus_profile: # application_detection_engine: # application_dscp_marking: # application_list: # application_report_intv: # atf_weight: # auth: # auth_cert: # auth_portal_addr: # beacon_advertising: # - "name" # - "model" # - "serial-number" # beacon_protection: # broadcast_ssid: # broadcast_suppression: # - "dhcp" # - "arp" # - "dhcp2" # - "arp2" # - "netbios-ns" # - "netbios-ds" # - "arp3" # - "dhcp-up" # - "dhcp-down" # - "arp-known" # - "arp-unknown" # - "arp-reply" # - "ipv6" # - "dhcp-starvation" # - "arp-poison" # - "all-other-mc" # - "all-other-bc" # - "arp-proxy" # - "dhcp-ucast" # bss_color_partial: # bstm_disassociation_imminent: # bstm_load_balancing_disassoc_timer: # bstm_rssi_disassoc_timer: # captive_portal: # captive_portal_ac_name: # captive_portal_auth_timeout: # captive_portal_fw_accounting: # dhcp_address_enforcement: # dhcp_lease_time: # dhcp_option43_insertion: # dhcp_option82_circuit_id_insertion: # dhcp_option82_insertion: # dhcp_option82_remote_id_insertion: # dynamic_vlan: # dynamic_mapping: # - d80211k: # d80211v: # _centmgmt: # _dhcp_svr_id: # _intf_allowaccess: # - "https" # - "ping" # - "ssh" # - "snmp" # - "http" # - "telnet" # - "fgfm" # - "radius-acct" # - "probe-response" # - "capwap" # - "dnp" # - "ftm" # - "fabric" # - "speed-test" # _intf_device_access_list: # _intf_device_identification: # _intf_device_netscan: # _intf_dhcp_relay_ip: # _intf_dhcp_relay_service: # _intf_dhcp_relay_type: # _intf_dhcp6_relay_ip: # _intf_dhcp6_relay_service: # _intf_dhcp6_relay_type: # _intf_ip: # _intf_ip6_address: # _intf_ip6_allowaccess: # - "https" # - "ping" # - "ssh" # - "snmp" # - "http" # - "telnet" # - "any" # - "fgfm" # - "capwap" # _intf_listen_forticlient_connection: # _is_factory_setting: # _scope: # - name: # vdom: # access_control_list: # acct_interim_interval: # additional_akms: # - "akm6" # - "akm24" # address_group: # address_group_policy: # akm24_only: # alias: # antivirus_profile: # application_detection_engine: # application_dscp_marking: # application_list: # application_report_intv: # atf_weight: # auth: # auth_cert: # auth_portal_addr: # beacon_advertising: # - "name" # - "model" # - "serial-number" # beacon_protection: # broadcast_ssid: # broadcast_suppression: # - "dhcp" # - "arp" # - "dhcp2" # - "arp2" # - "netbios-ns" # - "netbios-ds" # - "arp3" # - "dhcp-up" # - "dhcp-down" # - "arp-known" # - "arp-unknown" # - "arp-reply" # - "ipv6" # - "dhcp-starvation" # - "arp-poison" # - "all-other-mc" # - "all-other-bc" # - "arp-proxy" # - "dhcp-ucast" # bss_color_partial: # bstm_disassociation_imminent: # bstm_load_balancing_disassoc_timer: # bstm_rssi_disassoc_timer: # captive_portal: # captive_portal_ac_name: # captive_portal_auth_timeout: # captive_portal_fw_accounting: # captive_portal_macauth_radius_secret: # captive_portal_macauth_radius_server: # captive_portal_radius_secret: # captive_portal_radius_server: # captive_portal_session_timeout_interval: # client_count: # dhcp_address_enforcement: # dhcp_lease_time: # dhcp_option43_insertion: # dhcp_option82_circuit_id_insertion: # dhcp_option82_insertion: # dhcp_option82_remote_id_insertion: # dynamic_vlan: # eap_reauth: # eap_reauth_intv: # eapol_key_retries: # encrypt: # external_fast_roaming: # external_logout: # external_web: # external_web_format: # fast_bss_transition: # fast_roaming: # ft_mobility_domain: # ft_over_ds: # ft_r0_key_lifetime: # gas_comeback_delay: # gas_fragmentation_limit: # gtk_rekey: # gtk_rekey_intv: # high_efficiency: # hotspot20_profile: # igmp_snooping: # intra_vap_privacy: # ip: # ips_sensor: # ipv6_rules: # - "drop-icmp6ra" # - "drop-icmp6rs" # - "drop-llmnr6" # - "drop-icmp6mld2" # - "drop-dhcp6s" # - "drop-dhcp6c" # - "ndp-proxy" # - "drop-ns-dad" # - "drop-ns-nondad" # key: # keyindex: # l3_roaming: # l3_roaming_mode: # ldpc: # local_authentication: # local_bridging: # local_lan: # local_standalone: # local_standalone_dns: # local_standalone_dns_ip: # local_standalone_nat: # local_switching: # mac_auth_bypass: # mac_called_station_delimiter: # mac_calling_station_delimiter: # mac_case: # mac_filter: # mac_filter_policy_other: # mac_password_delimiter: # mac_username_delimiter: # max_clients: # max_clients_ap: # mbo: # mbo_cell_data_conn_pref: # me_disable_thresh: # mesh_backhaul: # mpsk: # mpsk_concurrent_clients: # mpsk_profile: # mu_mimo: # multicast_enhance: # multicast_rate: # nac: # nac_profile: # nas_filter_rule: # neighbor_report_dual_band: # okc: # osen: # owe_groups: # - "19" # - "20" # - "21" # owe_transition: # owe_transition_ssid: # passphrase: # pmf: # pmf_assoc_comeback_timeout: # pmf_sa_query_retry_timeout: # port_macauth: # port_macauth_reauth_timeout: # port_macauth_timeout: # portal_message_override_group: # portal_type: # primary_wag_profile: # probe_resp_suppression: # probe_resp_threshold: # ptk_rekey: # ptk_rekey_intv: # qos_profile: # quarantine: # radio_2g_threshold: # radio_5g_threshold: # radio_sensitivity: # radius_mac_auth: # radius_mac_auth_block_interval: # radius_mac_auth_server: # radius_mac_auth_usergroups: # radius_mac_mpsk_auth: # radius_mac_mpsk_timeout: # radius_server: # rates_11a: # - "1" # - "1-basic" # - "2" # - "2-basic" # - "5.5" # - "5.5-basic" # - "6" # - "6-basic" # - "9" # - "9-basic" # - "12" # - "12-basic" # - "18" # - "18-basic" # - "24" # - "24-basic" # - "36" # - "36-basic" # - "48" # - "48-basic" # - "54" # - "54-basic" # - "11" # - "11-basic" # rates_11ac_mcs_map: # rates_11ac_ss12: # - "mcs0/1" # - "mcs1/1" # - "mcs2/1" # - "mcs3/1" # - "mcs4/1" # - "mcs5/1" # - "mcs6/1" # - "mcs7/1" # - "mcs8/1" # - "mcs9/1" # - "mcs0/2" # - "mcs1/2" # - "mcs2/2" # - "mcs3/2" # - "mcs4/2" # - "mcs5/2" # - "mcs6/2" # - "mcs7/2" # - "mcs8/2" # - "mcs9/2" # - "mcs10/1" # - "mcs11/1" # - "mcs10/2" # - "mcs11/2" # rates_11ac_ss34: # - "mcs0/3" # - "mcs1/3" # - "mcs2/3" # - "mcs3/3" # - "mcs4/3" # - "mcs5/3" # - "mcs6/3" # - "mcs7/3" # - "mcs8/3" # - "mcs9/3" # - "mcs0/4" # - "mcs1/4" # - "mcs2/4" # - "mcs3/4" # - "mcs4/4" # - "mcs5/4" # - "mcs6/4" # - "mcs7/4" # - "mcs8/4" # - "mcs9/4" # - "mcs10/3" # - "mcs11/3" # - "mcs10/4" # - "mcs11/4" # rates_11ax_mcs_map: # rates_11ax_ss12: # - "mcs0/1" # - "mcs1/1" # - "mcs2/1" # - "mcs3/1" # - "mcs4/1" # - "mcs5/1" # - "mcs6/1" # - "mcs7/1" # - "mcs8/1" # - "mcs9/1" # - "mcs10/1" # - "mcs11/1" # - "mcs0/2" # - "mcs1/2" # - "mcs2/2" # - "mcs3/2" # - "mcs4/2" # - "mcs5/2" # - "mcs6/2" # - "mcs7/2" # - "mcs8/2" # - "mcs9/2" # - "mcs10/2" # - "mcs11/2" # rates_11ax_ss34: # - "mcs0/3" # - "mcs1/3" # - "mcs2/3" # - "mcs3/3" # - "mcs4/3" # - "mcs5/3" # - "mcs6/3" # - "mcs7/3" # - "mcs8/3" # - "mcs9/3" # - "mcs10/3" # - "mcs11/3" # - "mcs0/4" # - "mcs1/4" # - "mcs2/4" # - "mcs3/4" # - "mcs4/4" # - "mcs5/4" # - "mcs6/4" # - "mcs7/4" # - "mcs8/4" # - "mcs9/4" # - "mcs10/4" # - "mcs11/4" # rates_11be_mcs_map: # rates_11be_mcs_map_160: # rates_11be_mcs_map_320: # rates_11bg: # - "1" # - "1-basic" # - "2" # - "2-basic" # - "5.5" # - "5.5-basic" # - "6" # - "6-basic" # - "9" # - "9-basic" # - "12" # - "12-basic" # - "18" # - "18-basic" # - "24" # - "24-basic" # - "36" # - "36-basic" # - "48" # - "48-basic" # - "54" # - "54-basic" # - "11" # - "11-basic" # rates_11n_ss12: # - "mcs0/1" # - "mcs1/1" # - "mcs2/1" # - "mcs3/1" # - "mcs4/1" # - "mcs5/1" # - "mcs6/1" # - "mcs7/1" # - "mcs8/2" # - "mcs9/2" # - "mcs10/2" # - "mcs11/2" # - "mcs12/2" # - "mcs13/2" # - "mcs14/2" # - "mcs15/2" # rates_11n_ss34: # - "mcs16/3" # - "mcs17/3" # - "mcs18/3" # - "mcs19/3" # - "mcs20/3" # - "mcs21/3" # - "mcs22/3" # - "mcs23/3" # - "mcs24/4" # - "mcs25/4" # - "mcs26/4" # - "mcs27/4" # - "mcs28/4" # - "mcs29/4" # - "mcs30/4" # - "mcs31/4" # roaming_acct_interim_update: # sae_groups: # - "1" # - "2" # - "5" # - "14" # - "15" # - "16" # - "17" # - "18" # - "19" # - "20" # - "21" # - "27" # - "28" # - "29" # - "30" # - "31" # sae_h2e_only: # sae_hnp_only: # sae_password: # sae_pk: # sae_private_key: # scan_botnet_connections: # schedule: # secondary_wag_profile: # security: # security_exempt_list: # security_obsolete_option: # security_redirect_url: # selected_usergroups: # split_tunneling: # ssid: # sticky_client_remove: # sticky_client_threshold_2g: # sticky_client_threshold_5g: # sticky_client_threshold_6g: # target_wake_time: # tkip_counter_measure: # tunnel_echo_interval: # tunnel_fallback_interval: # usergroup: # utm_log: # utm_profile: # utm_status: # vdom: # vlan_auto: # vlan_pooling: # vlanid: # voice_enterprise: # webfilter_profile: # _intf_ip_managed_by_fortiipam: # _intf_managed_subnetwork_size: # domain_name_stripping: # local_lan_partition: # _intf_role: # called_station_id_type: # external_pre_auth: # pre_auth: # _intf_ip6_send_adv: # ip6_prefix_list: # - autonomous_flag: # dnssl: # onlink_flag: # preferred_life_time: # prefix: # rdnss: # valid_life_time: # _intf_vrf: # captive_network_assistant_bypass: # mlo: # eap_reauth: # eap_reauth_intv: # eapol_key_retries: # encrypt: # external_fast_roaming: # external_logout: # external_web: # external_web_format: # fast_bss_transition: # fast_roaming: # ft_mobility_domain: # ft_over_ds: # ft_r0_key_lifetime: # gas_comeback_delay: # gas_fragmentation_limit: # gtk_rekey: # gtk_rekey_intv: # high_efficiency: # hotspot20_profile: # igmp_snooping: # intra_vap_privacy: # ip: # ips_sensor: # ipv6_rules: # - "drop-icmp6ra" # - "drop-icmp6rs" # - "drop-llmnr6" # - "drop-icmp6mld2" # - "drop-dhcp6s" # - "drop-dhcp6c" # - "ndp-proxy" # - "drop-ns-dad" # - "drop-ns-nondad" # key: # keyindex: # l3_roaming: # l3_roaming_mode: # ldpc: # local_authentication: # local_bridging: # local_lan: # local_standalone: # local_standalone_dns: # local_standalone_dns_ip: # local_standalone_nat: # mac_auth_bypass: # mac_called_station_delimiter: # mac_calling_station_delimiter: # mac_case: # mac_password_delimiter: # mac_username_delimiter: # max_clients: # max_clients_ap: # mbo: # mbo_cell_data_conn_pref: # me_disable_thresh: # mesh_backhaul: # mpsk_profile: # mu_mimo: # multicast_enhance: # multicast_rate: # nac: # nac_profile: # nas_filter_rule: # neighbor_report_dual_band: # okc: # osen: # owe_groups: # - "19" # - "20" # - "21" # owe_transition: # owe_transition_ssid: # passphrase: # pmf: # pmf_assoc_comeback_timeout: # pmf_sa_query_retry_timeout: # port_macauth: # port_macauth_reauth_timeout: # port_macauth_timeout: # portal_message_override_group: # portal_message_overrides: # auth_disclaimer_page: # auth_login_failed_page: # auth_login_page: # auth_reject_page: # portal_type: # primary_wag_profile: # probe_resp_suppression: # probe_resp_threshold: # ptk_rekey: # ptk_rekey_intv: # qos_profile: # quarantine: # radio_2g_threshold: # radio_5g_threshold: # radio_sensitivity: # radius_mac_auth: # radius_mac_auth_block_interval: # radius_mac_auth_server: # radius_mac_auth_usergroups: # radius_mac_mpsk_auth: # radius_mac_mpsk_timeout: # radius_server: # rates_11a: # - "1" # - "1-basic" # - "2" # - "2-basic" # - "5.5" # - "5.5-basic" # - "6" # - "6-basic" # - "9" # - "9-basic" # - "12" # - "12-basic" # - "18" # - "18-basic" # - "24" # - "24-basic" # - "36" # - "36-basic" # - "48" # - "48-basic" # - "54" # - "54-basic" # - "11" # - "11-basic" # rates_11ac_mcs_map: # rates_11ax_mcs_map: # rates_11be_mcs_map: # rates_11be_mcs_map_160: # rates_11be_mcs_map_320: # rates_11bg: # - "1" # - "1-basic" # - "2" # - "2-basic" # - "5.5" # - "5.5-basic" # - "6" # - "6-basic" # - "9" # - "9-basic" # - "12" # - "12-basic" # - "18" # - "18-basic" # - "24" # - "24-basic" # - "36" # - "36-basic" # - "48" # - "48-basic" # - "54" # - "54-basic" # - "11" # - "11-basic" # rates_11n_ss12: # - "mcs0/1" # - "mcs1/1" # - "mcs2/1" # - "mcs3/1" # - "mcs4/1" # - "mcs5/1" # - "mcs6/1" # - "mcs7/1" # - "mcs8/2" # - "mcs9/2" # - "mcs10/2" # - "mcs11/2" # - "mcs12/2" # - "mcs13/2" # - "mcs14/2" # - "mcs15/2" # rates_11n_ss34: # - "mcs16/3" # - "mcs17/3" # - "mcs18/3" # - "mcs19/3" # - "mcs20/3" # - "mcs21/3" # - "mcs22/3" # - "mcs23/3" # - "mcs24/4" # - "mcs25/4" # - "mcs26/4" # - "mcs27/4" # - "mcs28/4" # - "mcs29/4" # - "mcs30/4" # - "mcs31/4" # roaming_acct_interim_update: # sae_groups: # - "1" # - "2" # - "5" # - "14" # - "15" # - "16" # - "17" # - "18" # - "19" # - "20" # - "21" # - "27" # - "28" # - "29" # - "30" # - "31" # sae_h2e_only: # sae_hnp_only: # sae_password: # sae_pk: # sae_private_key: # scan_botnet_connections: # schedule: # secondary_wag_profile: # security: # security_exempt_list: # security_obsolete_option: # security_redirect_url: # selected_usergroups: # split_tunneling: # ssid: # sticky_client_remove: # sticky_client_threshold_2g: # sticky_client_threshold_5g: # sticky_client_threshold_6g: # target_wake_time: # tkip_counter_measure: # tunnel_echo_interval: # tunnel_fallback_interval: # usergroup: # utm_log: # utm_profile: # utm_status: # vlan_auto: # vlan_name: # - name: # vlan_id: # vlan_pool: # - _wtp_group: # id: # wtp_group: # vlan_pooling: # vlanid: # voice_enterprise: # webfilter_profile: # mac_filter_policy_other: # mac_filter: # rates_11ax_ss12: # - "mcs0/1" # - "mcs1/1" # - "mcs2/1" # - "mcs3/1" # - "mcs4/1" # - "mcs5/1" # - "mcs6/1" # - "mcs7/1" # - "mcs8/1" # - "mcs9/1" # - "mcs10/1" # - "mcs11/1" # - "mcs0/2" # - "mcs1/2" # - "mcs2/2" # - "mcs3/2" # - "mcs4/2" # - "mcs5/2" # - "mcs6/2" # - "mcs7/2" # - "mcs8/2" # - "mcs9/2" # - "mcs10/2" # - "mcs11/2" # rates_11ac_ss34: # - "mcs0/3" # - "mcs1/3" # - "mcs2/3" # - "mcs3/3" # - "mcs4/3" # - "mcs5/3" # - "mcs6/3" # - "mcs7/3" # - "mcs8/3" # - "mcs9/3" # - "mcs0/4" # - "mcs1/4" # - "mcs2/4" # - "mcs3/4" # - "mcs4/4" # - "mcs5/4" # - "mcs6/4" # - "mcs7/4" # - "mcs8/4" # - "mcs9/4" # - "mcs10/3" # - "mcs11/3" # - "mcs10/4" # - "mcs11/4" # rates_11ax_ss34: # - "mcs0/3" # - "mcs1/3" # - "mcs2/3" # - "mcs3/3" # - "mcs4/3" # - "mcs5/3" # - "mcs6/3" # - "mcs7/3" # - "mcs8/3" # - "mcs9/3" # - "mcs10/3" # - "mcs11/3" # - "mcs0/4" # - "mcs1/4" # - "mcs2/4" # - "mcs3/4" # - "mcs4/4" # - "mcs5/4" # - "mcs6/4" # - "mcs7/4" # - "mcs8/4" # - "mcs9/4" # - "mcs10/4" # - "mcs11/4" # rates_11ac_ss12: # - "mcs0/1" # - "mcs1/1" # - "mcs2/1" # - "mcs3/1" # - "mcs4/1" # - "mcs5/1" # - "mcs6/1" # - "mcs7/1" # - "mcs8/1" # - "mcs9/1" # - "mcs0/2" # - "mcs1/2" # - "mcs2/2" # - "mcs3/2" # - "mcs4/2" # - "mcs5/2" # - "mcs6/2" # - "mcs7/2" # - "mcs8/2" # - "mcs9/2" # - "mcs10/1" # - "mcs11/1" # - "mcs10/2" # - "mcs11/2" # mac_filter_list: # - id: # mac: # mac_filter_policy: # mpsk_key: # - comment: # concurrent_clients: # key_name: # mpsk_schedules: # passphrase: # mpsk: # mpsk_concurrent_clients: # acct_interim_interval: # captive_portal_radius_server: # captive_portal_session_timeout_interval: # captive_portal_radius_secret: # captive_portal_macauth_radius_secret: # captive_portal_macauth_radius_server: # _intf_ip_managed_by_fortiipam: # _intf_managed_subnetwork_size: # domain_name_stripping: # local_lan_partition: # _intf_role: # called_station_id_type: # external_pre_auth: # pre_auth: # _intf_ip6_send_adv: # ip6_prefix_list: # - autonomous_flag: # dnssl: # onlink_flag: # preferred_life_time: # prefix: # rdnss: # valid_life_time: # _intf_vrf: # captive_network_assistant_bypass: # mlo: 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)