:source: fmgr_vap_dynamicmapping.py
:orphan:
.. _fmgr_vap_dynamicmapping:
fmgr_vap_dynamicmapping -- Configure Virtual Access Points (VAPs).
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. 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
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- vap - The parameter in requested url type: str required: true
- vap_dynamicmapping - Configure Virtual Access Points type: dict
- _centmgmt Centmgmt. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- _dhcp_svr_id Dhcp svr id. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_allowaccess Intf allowaccess. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test]
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_device_identification (Alias name: _intf_device-identification) Intf device identification. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_device_netscan (Alias name: _intf_device-netscan) Intf device netscan. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_dhcp_relay_ip (Alias name: _intf_dhcp-relay-ip) Intf dhcp relay ip. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_dhcp_relay_service (Alias name: _intf_dhcp-relay-service) Intf dhcp relay service. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_dhcp_relay_type (Alias name: _intf_dhcp-relay-type) Intf dhcp relay type. type: str choices: [regular, ipsec] default: regular
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_dhcp6_relay_ip (Alias name: _intf_dhcp6-relay-ip) Intf dhcp6 relay ip. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_dhcp6_relay_service (Alias name: _intf_dhcp6-relay-service) Intf dhcp6 relay service. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_dhcp6_relay_type (Alias name: _intf_dhcp6-relay-type) Intf dhcp6 relay type. type: str choices: [regular] default: regular
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_ip Intf ip. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_ip6_address (Alias name: _intf_ip6-address) Intf ip6 address. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_ip6_allowaccess (Alias name: _intf_ip6-allowaccess) Intf ip6 allowaccess. type: list choices: [https, ping, ssh, snmp, http, telnet, any, fgfm, capwap]
more...
Supported Version Ranges: v6.0.0 -> latest
- _intf_listen_forticlient_connection (Alias name: _intf_listen-forticlient-connection) Intf listen forticlient connection. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v6.0.0 -> latest
- _scope Scope. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- acct_interim_interval (Alias name: acct-interim-interval) Acct interim interval. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- address_group (Alias name: address-group) Address group. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- alias Alias. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- atf_weight (Alias name: atf-weight) Atf weight. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- auth Auth. type: str choices: [PSK, psk, RADIUS, radius, usergroup]
more...
Supported Version Ranges: v6.0.0 -> latest
- broadcast_ssid (Alias name: broadcast-ssid) Broadcast ssid. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- broadcast_suppression (Alias name: broadcast-suppression) Broadcast suppression. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_ac_name (Alias name: captive-portal-ac-name) Captive portal ac name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_macauth_radius_secret (Alias name: captive-portal-macauth-radius-secret) Captive portal macauth radius secret. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_macauth_radius_server (Alias name: captive-portal-macauth-radius-server) Captive portal macauth radius server. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_radius_secret (Alias name: captive-portal-radius-secret) Captive portal radius secret. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_radius_server (Alias name: captive-portal-radius-server) Captive portal radius server. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- captive_portal_session_timeout_interval (Alias name: captive-portal-session-timeout-interval) Captive portal session timeout interval. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- client_count (Alias name: client-count) Client count. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- dhcp_lease_time (Alias name: dhcp-lease-time) Dhcp lease time. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- dhcp_option82_circuit_id_insertion (Alias name: dhcp-option82-circuit-id-insertion) Dhcp option82 circuit id insertion. type: str choices: [disable, style-1, style-2, style-3]
more...
Supported Version Ranges: v6.0.0 -> latest
- dhcp_option82_insertion (Alias name: dhcp-option82-insertion) Dhcp option82 insertion. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- dhcp_option82_remote_id_insertion (Alias name: dhcp-option82-remote-id-insertion) Dhcp option82 remote id insertion. type: str choices: [disable, style-1]
more...
Supported Version Ranges: v6.0.0 -> latest
- dynamic_vlan (Alias name: dynamic-vlan) Dynamic vlan. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- eap_reauth (Alias name: eap-reauth) Eap reauth. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- eap_reauth_intv (Alias name: eap-reauth-intv) Eap reauth intv. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- eapol_key_retries (Alias name: eapol-key-retries) Eapol key retries. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- encrypt Encrypt. type: str choices: [TKIP, AES, TKIP-AES]
more...
Supported Version Ranges: v6.0.0 -> latest
- external_fast_roaming (Alias name: external-fast-roaming) External fast roaming. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- external_logout (Alias name: external-logout) External logout. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- external_web (Alias name: external-web) External web. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- fast_bss_transition (Alias name: fast-bss-transition) Fast bss transition. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- fast_roaming (Alias name: fast-roaming) Fast roaming. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ft_mobility_domain (Alias name: ft-mobility-domain) Ft mobility domain. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ft_over_ds (Alias name: ft-over-ds) Ft over ds. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ft_r0_key_lifetime (Alias name: ft-r0-key-lifetime) Ft r0 key lifetime. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- gtk_rekey (Alias name: gtk-rekey) Gtk rekey. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- gtk_rekey_intv (Alias name: gtk-rekey-intv) Gtk rekey intv. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- hotspot20_profile (Alias name: hotspot20-profile) Hotspot20 profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- intra_vap_privacy (Alias name: intra-vap-privacy) Intra vap privacy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ip Ip. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- key Key. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- keyindex Keyindex. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ldpc Ldpc. type: str choices: [disable, tx, rx, rxtx]
more...
Supported Version Ranges: v6.0.0 -> latest
- local_authentication (Alias name: local-authentication) Local authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- local_bridging (Alias name: local-bridging) Local bridging. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- local_lan (Alias name: local-lan) Local lan. type: str choices: [deny, allow]
more...
Supported Version Ranges: v6.0.0 -> latest
- local_standalone (Alias name: local-standalone) Local standalone. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- local_standalone_nat (Alias name: local-standalone-nat) Local standalone nat. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- local_switching (Alias name: local-switching) Local switching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mac_auth_bypass (Alias name: mac-auth-bypass) Mac auth bypass. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mac_filter (Alias name: mac-filter) Mac filter. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mac_filter_policy_other (Alias name: mac-filter-policy-other) Mac filter policy other. type: str choices: [deny, allow]
more...
Supported Version Ranges: v6.0.0 -> latest
- max_clients (Alias name: max-clients) Max clients. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- max_clients_ap (Alias name: max-clients-ap) Max clients ap. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- me_disable_thresh (Alias name: me-disable-thresh) Me disable thresh. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- mesh_backhaul (Alias name: mesh-backhaul) Mesh backhaul. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mpsk Mpsk. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mpsk_concurrent_clients (Alias name: mpsk-concurrent-clients) Mpsk concurrent clients. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- multicast_enhance (Alias name: multicast-enhance) Multicast enhance. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- multicast_rate (Alias name: multicast-rate) Multicast rate. type: str choices: [0, 6000, 12000, 24000]
more...
Supported Version Ranges: v6.0.0 -> latest
- okc Okc. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- owe_groups (Alias name: owe-groups) Owe groups. type: list choices: [19, 20, 21]
more...
Supported Version Ranges: v6.0.0 -> latest
- owe_transition (Alias name: owe-transition) Owe transition. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- owe_transition_ssid (Alias name: owe-transition-ssid) Owe transition ssid. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- passphrase Passphrase. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- pmf Pmf. type: str choices: [disable, enable, optional]
more...
Supported Version Ranges: v6.0.0 -> latest
- pmf_assoc_comeback_timeout (Alias name: pmf-assoc-comeback-timeout) Pmf assoc comeback timeout. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- pmf_sa_query_retry_timeout (Alias name: pmf-sa-query-retry-timeout) Pmf sa query retry timeout. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- portal_message_override_group (Alias name: portal-message-override-group) Portal message override group. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- portal_type (Alias name: portal-type) Portal type. type: str choices: [auth, auth+disclaimer, disclaimer, email-collect, cmcc, cmcc-macauth, auth-mac, external-auth, external-macauth]
more...
Supported Version Ranges: v6.0.0 -> latest
- probe_resp_suppression (Alias name: probe-resp-suppression) Probe resp suppression. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- probe_resp_threshold (Alias name: probe-resp-threshold) Probe resp threshold. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- ptk_rekey (Alias name: ptk-rekey) Ptk rekey. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ptk_rekey_intv (Alias name: ptk-rekey-intv) Ptk rekey intv. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- qos_profile (Alias name: qos-profile) Qos profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- quarantine Quarantine. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- radio_2g_threshold (Alias name: radio-2g-threshold) Radio 2g threshold. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- radio_5g_threshold (Alias name: radio-5g-threshold) Radio 5g threshold. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- radio_sensitivity (Alias name: radio-sensitivity) Radio sensitivity. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- radius_mac_auth (Alias name: radius-mac-auth) Radius mac auth. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- radius_mac_auth_server (Alias name: radius-mac-auth-server) Radius mac auth server. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- radius_mac_auth_usergroups (Alias name: radius-mac-auth-usergroups) Radius mac auth usergroups. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- radius_server (Alias name: radius-server) Radius server. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- rates_11a (Alias name: rates-11a) Rates 11a. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- rates_11ac_ss12 (Alias name: rates-11ac-ss12) Rates 11ac ss12. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- rates_11ac_ss34 (Alias name: rates-11ac-ss34) Rates 11ac ss34. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- rates_11bg (Alias name: rates-11bg) Rates 11bg. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- rates_11n_ss12 (Alias name: rates-11n-ss12) Rates 11n ss12. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- rates_11n_ss34 (Alias name: rates-11n-ss34) Rates 11n ss34. type: list choices: [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]
more...
Supported Version Ranges: v6.0.0 -> latest
- sae_groups (Alias name: sae-groups) Sae groups. type: list choices: [1, 2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 27, 28, 29, 30, 31]
more...
Supported Version Ranges: v6.0.0 -> latest
- sae_password (Alias name: sae-password) Sae password. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- schedule Schedule. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- security Security. type: str choices: [None, WEP64, wep64, WEP128, wep128, WPA_PSK, WPA_RADIUS, WPA, WPA2, WPA2_AUTO, open, wpa-personal, wpa-enterprise, captive-portal, wpa-only-personal, wpa-only-enterprise, wpa2-only-personal, wpa2-only-enterprise, wpa-personal+captive-portal, wpa-only-personal+captive-portal, wpa2-only-personal+captive-portal, osen, wpa3-enterprise, sae, sae-transition, owe, wpa3-sae, wpa3-sae-transition, wpa3-only-enterprise, wpa3-enterprise-transition]
more...
Supported Version Ranges: v6.0.0 -> latest
- security_exempt_list (Alias name: security-exempt-list) Security exempt list. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- security_obsolete_option (Alias name: security-obsolete-option) Security obsolete option. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- security_redirect_url (Alias name: security-redirect-url) Security redirect url. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- selected_usergroups (Alias name: selected-usergroups) Selected usergroups. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- split_tunneling (Alias name: split-tunneling) Split tunneling. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ssid Ssid. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- tkip_counter_measure (Alias name: tkip-counter-measure) Tkip counter measure. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- usergroup Usergroup. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- utm_profile (Alias name: utm-profile) Utm profile. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vdom Vdom. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- vlan_auto (Alias name: vlan-auto) Vlan auto. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- vlan_pooling (Alias name: vlan-pooling) Vlan pooling. type: str choices: [wtp-group, round-robin, hash, disable]
more...
Supported Version Ranges: v6.0.0 -> latest
- vlanid Vlanid. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- voice_enterprise (Alias name: voice-enterprise) Voice enterprise. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- mu_mimo (Alias name: mu-mimo) Mu mimo. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.1 -> latest
- _intf_device_access_list (Alias name: _intf_device-access-list) Intf device access list. type: str
more...
Supported Version Ranges: v6.2.2 -> latest
- external_web_format (Alias name: external-web-format) External web format. type: str choices: [auto-detect, no-query-string, partial-query-string]
more...
Supported Version Ranges: v6.2.2 -> latest
- high_efficiency (Alias name: high-efficiency) High efficiency. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> latest
- primary_wag_profile (Alias name: primary-wag-profile) Primary wag profile. type: str
more...
Supported Version Ranges: v6.2.2 -> latest
- secondary_wag_profile (Alias name: secondary-wag-profile) Secondary wag profile. type: str
more...
Supported Version Ranges: v6.2.2 -> latest
- target_wake_time (Alias name: target-wake-time) Target wake time. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.2 -> latest
- tunnel_echo_interval (Alias name: tunnel-echo-interval) Tunnel echo interval. type: int
more...
Supported Version Ranges: v6.2.2 -> latest
- tunnel_fallback_interval (Alias name: tunnel-fallback-interval) Tunnel fallback interval. type: int
more...
Supported Version Ranges: v6.2.2 -> latest
- access_control_list (Alias name: access-control-list) Access control list. type: str
more...
Supported Version Ranges: v6.4.0 -> latest
- captive_portal_auth_timeout (Alias name: captive-portal-auth-timeout) Captive portal auth timeout. type: int
more...
Supported Version Ranges: v6.4.0 -> latest
- ipv6_rules (Alias name: ipv6-rules) Ipv6 rules. type: list choices: [drop-icmp6ra, drop-icmp6rs, drop-llmnr6, drop-icmp6mld2, drop-dhcp6s, drop-dhcp6c, ndp-proxy, drop-ns-dad, drop-ns-nondad]
more...
Supported Version Ranges: v6.4.0 -> latest
- sticky_client_remove (Alias name: sticky-client-remove) Sticky client remove. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.0 -> latest
- sticky_client_threshold_2g (Alias name: sticky-client-threshold-2g) Sticky client threshold 2g. type: str
more...
Supported Version Ranges: v6.4.0 -> latest
- sticky_client_threshold_5g (Alias name: sticky-client-threshold-5g) Sticky client threshold 5g. type: str
more...
Supported Version Ranges: v6.4.0 -> latest
- bss_color_partial (Alias name: bss-color-partial) Bss color partial. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.2 -> latest
- dhcp_option43_insertion (Alias name: dhcp-option43-insertion) Dhcp option43 insertion. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.1 -> latest
- mpsk_profile (Alias name: mpsk-profile) Mpsk profile. type: str
more...
Supported Version Ranges: v6.4.2 -> latest
- igmp_snooping (Alias name: igmp-snooping) Enable/disable igmp snooping. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.3 -> latest
- port_macauth (Alias name: port-macauth) Enable/disable lan port mac authentication (default = disable). type: str choices: [disable, radius, address-group]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.3 -> latest
- port_macauth_reauth_timeout (Alias name: port-macauth-reauth-timeout) Lan port mac authentication re-authentication timeout value (default = 7200 sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.3 -> latest
- port_macauth_timeout (Alias name: port-macauth-timeout) Lan port mac authentication idle timeout value (default = 600 sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.3 -> latest
- additional_akms (Alias name: additional-akms) Additional akms. type: list choices: [akm6, akm24]
more...
Supported Version Ranges: v7.0.0 -> latest
- bstm_disassociation_imminent (Alias name: bstm-disassociation-imminent) Enable/disable forcing of disassociation after the bstm request timer has been reached (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- bstm_load_balancing_disassoc_timer (Alias name: bstm-load-balancing-disassoc-timer) Time interval for client to voluntarily leave ap before forcing a disassociation due to ap load-balancing (0 to 30, default = 10). type: int
more...
Supported Version Ranges: v7.0.0 -> latest
- bstm_rssi_disassoc_timer (Alias name: bstm-rssi-disassoc-timer) Time interval for client to voluntarily leave ap before forcing a disassociation due to low rssi (0 to 2000, default = 200). type: int
more...
Supported Version Ranges: v7.0.0 -> latest
- dhcp_address_enforcement (Alias name: dhcp-address-enforcement) Enable/disable dhcp address enforcement (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- gas_comeback_delay (Alias name: gas-comeback-delay) Gas comeback delay (0 or 100 - 10000 milliseconds, default = 500). type: int
more...
Supported Version Ranges: v7.0.0 -> latest
- gas_fragmentation_limit (Alias name: gas-fragmentation-limit) Gas fragmentation limit (512 - 4096, default = 1024). type: int
more...
Supported Version Ranges: v7.0.0 -> latest
- mac_called_station_delimiter (Alias name: mac-called-station-delimiter) Mac called station delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.0.0 -> latest
- mac_calling_station_delimiter (Alias name: mac-calling-station-delimiter) Mac calling station delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.0.0 -> latest
- mac_case (Alias name: mac-case) Mac case (default = uppercase). type: str choices: [uppercase, lowercase]
more...
Supported Version Ranges: v7.0.0 -> latest
- mac_password_delimiter (Alias name: mac-password-delimiter) Mac authentication password delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.0.0 -> latest
- mac_username_delimiter (Alias name: mac-username-delimiter) Mac authentication username delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.0.0 -> latest
- mbo Enable/disable multiband operation (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- mbo_cell_data_conn_pref (Alias name: mbo-cell-data-conn-pref) Mbo cell data connection preference (0, 1, or 255, default = 1). type: str choices: [excluded, prefer-not, prefer-use]
more...
Supported Version Ranges: v7.0.0 -> latest
- nac Enable/disable network access control. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- nac_profile (Alias name: nac-profile) Nac profile name. type: str
more...
Supported Version Ranges: v7.0.0 -> latest
- neighbor_report_dual_band (Alias name: neighbor-report-dual-band) Enable/disable dual-band neighbor report (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.0 -> latest
- address_group_policy (Alias name: address-group-policy) Configure mac address filtering policy for mac addresses that are in the address-group. type: str choices: [disable, allow, deny]
more...
Supported Version Ranges: v7.2.0 -> latest
- antivirus_profile (Alias name: antivirus-profile) Antivirus profile name. type: str
more...
Supported Version Ranges: v7.0.1 -> latest
- application_detection_engine (Alias name: application-detection-engine) Enable/disable application detection engine (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.0 -> latest
- application_list (Alias name: application-list) Application control list name. type: str
more...
Supported Version Ranges: v7.0.1 -> latest
- application_report_intv (Alias name: application-report-intv) Application report interval (30 - 864000 sec, default = 120). type: int
more...
Supported Version Ranges: v7.2.0 -> latest
- auth_cert (Alias name: auth-cert) Https server certificate. type: str
more...
Supported Version Ranges: v7.0.3 -> latest
- auth_portal_addr (Alias name: auth-portal-addr) Address of captive portal. type: str
more...
Supported Version Ranges: v7.0.3 -> latest
- beacon_advertising (Alias name: beacon-advertising) Fortinet beacon advertising ie data (default = empty). type: list choices: [name, model, serial-number]
more...
Supported Version Ranges: v7.0.2 -> latest
- ips_sensor (Alias name: ips-sensor) Ips sensor name. type: str
more...
Supported Version Ranges: v7.0.1 -> latest
- l3_roaming (Alias name: l3-roaming) Enable/disable layer 3 roaming (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.0 -> latest
- local_standalone_dns (Alias name: local-standalone-dns) Enable/disable ap local standalone dns. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.1 -> latest
- local_standalone_dns_ip (Alias name: local-standalone-dns-ip) Ipv4 addresses for the local standalone dns. type: list
more...
Supported Version Ranges: v7.0.1 -> latest
- osen Enable/disable osen as part of key management (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.2 -> latest
- radius_mac_mpsk_auth (Alias name: radius-mac-mpsk-auth) Enable/disable radius-based mac authentication of clients for mpsk authentication (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.2 -> latest
- radius_mac_mpsk_timeout (Alias name: radius-mac-mpsk-timeout) Radius mac mpsk cache timeout interval (1800 - 864000, default = 86400). type: int
more...
Supported Version Ranges: v7.0.2 -> latest
- rates_11ax_ss12 (Alias name: rates-11ax-ss12) Allowed data rates for 802. type: list choices: [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]
more...
Supported Version Ranges: v7.0.2 -> latest
- rates_11ax_ss34 (Alias name: rates-11ax-ss34) Allowed data rates for 802. type: list choices: [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]
more...
Supported Version Ranges: v7.0.2 -> latest
- scan_botnet_connections (Alias name: scan-botnet-connections) Block or monitor connections to botnet servers or disable botnet scanning. type: str choices: [disable, block, monitor]
more...
Supported Version Ranges: v7.0.1 -> latest
- utm_log (Alias name: utm-log) Enable/disable utm logging. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.1 -> latest
- utm_status (Alias name: utm-status) Enable to add one or more security profiles (av, ips, etc. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.1 -> latest
- webfilter_profile (Alias name: webfilter-profile) Webfilter profile name. type: str
more...
Supported Version Ranges: v7.0.1 -> latest
- sae_h2e_only (Alias name: sae-h2e-only) Use hash-to-element-only mechanism for pwe derivation (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.5 -> v7.0.16, v7.2.1 -> latest
- sae_pk (Alias name: sae-pk) Enable/disable wpa3 sae-pk (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.5 -> v7.0.16, v7.2.1 -> latest
- sae_private_key (Alias name: sae-private-key) Private key used for wpa3 sae-pk authentication. type: str
more...
Supported Version Ranges: v7.0.5 -> v7.0.16, v7.2.1 -> latest
- sticky_client_threshold_6g (Alias name: sticky-client-threshold-6g) Minimum signal level/threshold in dbm required for the 6g client to be serviced by the ap (-95 to -20, default = -76). type: str
more...
Supported Version Ranges: v7.0.5 -> v7.0.16, v7.2.1 -> latest
- application_dscp_marking (Alias name: application-dscp-marking) Enable/disable application attribute based dscp marking (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- l3_roaming_mode (Alias name: l3-roaming-mode) Select the way that layer 3 roaming traffic is passed (default = direct). type: str choices: [direct, indirect]
more...
Supported Version Ranges: v7.2.1 -> latest
- rates_11ac_mcs_map (Alias name: rates-11ac-mcs-map) Comma separated list of max supported vht mcs for spatial streams 1 through 8. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- rates_11ax_mcs_map (Alias name: rates-11ax-mcs-map) Comma separated list of max supported he mcs for spatial streams 1 through 8. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- captive_portal_fw_accounting (Alias name: captive-portal-fw-accounting) Enable/disable radius accounting for captive portal firewall authentication session. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.2 -> latest
- radius_mac_auth_block_interval (Alias name: radius-mac-auth-block-interval) Dont send radius mac auth request again if the client has been rejected within specific interval (0 or 30 - 864000 seconds, default = 0, 0 to disable blocking). type: int
more...
Supported Version Ranges: v7.2.2 -> latest
- _is_factory_setting Is factory setting. type: str choices: [disable, enable, ext] default: disable
more...
Supported Version Ranges: v7.4.0 -> latest
- d80211k (Alias name: 80211k) Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.2 -> latest
- d80211v (Alias name: 80211v) Enable/disable 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.2 -> latest
- roaming_acct_interim_update (Alias name: roaming-acct-interim-update) Enable/disable using accounting interim update instead of accounting start/stop on roaming for wpa-enterprise security. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.2 -> latest
- sae_hnp_only (Alias name: sae-hnp-only) Use hunting-and-pecking-only mechanism for pwe derivation (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.2 -> latest
- akm24_only (Alias name: akm24-only) Wpa3 sae using group-dependent hash only (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- beacon_protection (Alias name: beacon-protection) Enable/disable beacon protection support (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- captive_portal (Alias name: captive-portal) Enable/disable captive portal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- nas_filter_rule (Alias name: nas-filter-rule) Enable/disable nas filter rule support (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- rates_11be_mcs_map (Alias name: rates-11be-mcs-map) Comma separated list of max nss that supports eht-mcs 0-9, 10-11, 12-13 for 20mhz/40mhz/80mhz bandwidth. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- rates_11be_mcs_map_160 (Alias name: rates-11be-mcs-map-160) Comma separated list of max nss that supports eht-mcs 0-9, 10-11, 12-13 for 160mhz bandwidth. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- rates_11be_mcs_map_320 (Alias name: rates-11be-mcs-map-320) Comma separated list of max nss that supports eht-mcs 0-9, 10-11, 12-13 for 320mhz bandwidth. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- _intf_ip_managed_by_fortiipam (Alias name: _intf_ip-managed-by-fortiipam) Intf ip managed by fortiipam. type: str choices: [disable, enable, inherit-global]
more...
Supported Version Ranges: v7.6.0 -> latest
- _intf_managed_subnetwork_size (Alias name: _intf_managed-subnetwork-size) Intf managed subnetwork size. type: str choices: [32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536] default: 256
more...
Supported Version Ranges: v7.6.0 -> latest
- domain_name_stripping (Alias name: domain-name-stripping) Enable/disable stripping domain name from identity (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- local_lan_partition (Alias name: local-lan-partition) Enable/disable segregating client traffic to local lan side (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- _intf_role Intf role. type: str choices: [lan, wan, dmz, undefined] default: lan
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.6 -> v7.4.10, v7.6.2 -> latest
- called_station_id_type (Alias name: called-station-id-type) The format type of radius attribute called-station-id (default = mac). type: str choices: [mac, ip, apname]
more...
Supported Version Ranges: v7.6.2 -> latest
- external_pre_auth (Alias name: external-pre-auth) Enable/disable pre-authentication with external aps not managed by the fortigate (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- pre_auth (Alias name: pre-auth) Enable/disable pre-authentication, where supported by clients (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- _intf_ip6_send_adv (Alias name: _intf_ip6-send-adv) Intf ip6 send adv. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- ip6_prefix_list (Alias name: ip6-prefix-list) Ip6 prefix list. type: list
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- autonomous_flag (Alias name: autonomous-flag) Autonomous flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- dnssl Dnssl. type: list
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- onlink_flag (Alias name: onlink-flag) Onlink flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- preferred_life_time (Alias name: preferred-life-time) Preferred life time. type: int
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- prefix Prefix. type: str
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- rdnss Rdnss. type: list
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- valid_life_time (Alias name: valid-life-time) Valid life time. type: int
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- _intf_vrf Intf vrf. type: int default: 0
more...
Supported Version Ranges: v7.6.3 -> latest
- captive_network_assistant_bypass (Alias name: captive-network-assistant-bypass) Enable/disable captive network assistant bypass. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- mlo Enable/disable wifi7 multi-link-operation (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.5 -> latest
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 Virtual Access Points
fortinet.fortimanager.fmgr_vap_dynamicmapping:
# workspace_locking_adom:
adom:
vap:
state: present #
vap_dynamicmapping:
_scope: # Required variable, list of device
- name:
vdom:
# _centmgmt:
# _dhcp_svr_id:
# _intf_allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm",
# "auto-ipsec", "radius-acct", "probe-response", "capwap", "dnp",
# "ftm", "fabric", "speed-test"]
# _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:
# acct_interim_interval:
# address_group:
# alias:
# atf_weight:
# auth:
# 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"]
# captive_portal_ac_name:
# 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_lease_time:
# 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:
# fast_bss_transition:
# fast_roaming:
# ft_mobility_domain:
# ft_over_ds:
# ft_r0_key_lifetime:
# gtk_rekey:
# gtk_rekey_intv:
# hotspot20_profile:
# intra_vap_privacy:
# ip:
# key:
# keyindex:
# ldpc:
# local_authentication:
# local_bridging:
# local_lan:
# local_standalone:
# local_standalone_nat:
# local_switching:
# mac_auth_bypass:
# mac_filter:
# mac_filter_policy_other:
# max_clients:
# max_clients_ap:
# me_disable_thresh:
# mesh_backhaul:
# mpsk:
# mpsk_concurrent_clients:
# multicast_enhance:
# multicast_rate:
# okc:
# owe_groups: ["19", "20", "21"]
# owe_transition:
# owe_transition_ssid:
# passphrase:
# pmf:
# pmf_assoc_comeback_timeout:
# pmf_sa_query_retry_timeout:
# portal_message_override_group:
# portal_type:
# 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_server:
# radius_mac_auth_usergroups:
# 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_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_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"]
# sae_groups: ["1", "2", "5", "14", "15", "16", "17", "18", "19", "20", "21", "27",
# "28", "29", "30", "31"]
# sae_password:
# schedule:
# security:
# security_exempt_list:
# security_obsolete_option:
# security_redirect_url:
# selected_usergroups:
# split_tunneling:
# ssid:
# tkip_counter_measure:
# usergroup:
# utm_profile:
# vdom:
# vlan_auto:
# vlan_pooling:
# vlanid:
# voice_enterprise:
# mu_mimo:
# _intf_device_access_list:
# external_web_format:
# high_efficiency:
# primary_wag_profile:
# secondary_wag_profile:
# target_wake_time:
# tunnel_echo_interval:
# tunnel_fallback_interval:
# access_control_list:
# captive_portal_auth_timeout:
# ipv6_rules: ["drop-icmp6ra", "drop-icmp6rs", "drop-llmnr6", "drop-icmp6mld2",
# "drop-dhcp6s", "drop-dhcp6c", "ndp-proxy", "drop-ns-dad",
# "drop-ns-nondad"]
# sticky_client_remove:
# sticky_client_threshold_2g:
# sticky_client_threshold_5g:
# bss_color_partial:
# dhcp_option43_insertion:
# mpsk_profile:
# igmp_snooping:
# port_macauth:
# port_macauth_reauth_timeout:
# port_macauth_timeout:
# additional_akms: ["akm6", "akm24"]
# bstm_disassociation_imminent:
# bstm_load_balancing_disassoc_timer:
# bstm_rssi_disassoc_timer:
# dhcp_address_enforcement:
# gas_comeback_delay:
# gas_fragmentation_limit:
# mac_called_station_delimiter:
# mac_calling_station_delimiter:
# mac_case:
# mac_password_delimiter:
# mac_username_delimiter:
# mbo:
# mbo_cell_data_conn_pref:
# nac:
# nac_profile:
# neighbor_report_dual_band:
# address_group_policy:
# antivirus_profile:
# application_detection_engine:
# application_list:
# application_report_intv:
# auth_cert:
# auth_portal_addr:
# beacon_advertising: ["name", "model", "serial-number"]
# ips_sensor:
# l3_roaming:
# local_standalone_dns:
# local_standalone_dns_ip:
# osen:
# radius_mac_mpsk_auth:
# radius_mac_mpsk_timeout:
# 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"]
# scan_botnet_connections:
# utm_log:
# utm_status:
# webfilter_profile:
# sae_h2e_only:
# sae_pk:
# sae_private_key:
# sticky_client_threshold_6g:
# application_dscp_marking:
# l3_roaming_mode:
# rates_11ac_mcs_map:
# rates_11ax_mcs_map:
# captive_portal_fw_accounting:
# radius_mac_auth_block_interval:
# _is_factory_setting:
# d80211k:
# d80211v:
# roaming_acct_interim_update:
# sae_hnp_only:
# akm24_only:
# beacon_protection:
# captive_portal:
# nas_filter_rule:
# rates_11be_mcs_map:
# rates_11be_mcs_map_160:
# rates_11be_mcs_map_320:
# _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)