fortinet.fortimanager.fmgr_vap_dynamicmapping module – Configure Virtual Access Points

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_vap_dynamicmapping.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

vap

string / required

The parameter (vap) in requested url.

vap_dynamicmapping

dictionary

The top level parameters set.

80211k

string

Deprecated, please rename it to d80211k. Enable/disable 802.

Choices:

  • "disable"

  • "enable"

80211v

string

Deprecated, please rename it to d80211v. Enable/disable 802.

Choices:

  • "disable"

  • "enable"

_centmgmt

string

No description.

Choices:

  • "disable"

  • "enable"

_dhcp_svr_id

string

No description.

_intf_allowaccess

list / elements=string

No description.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "auto-ipsec"

  • "radius-acct"

  • "probe-response"

  • "capwap"

  • "dnp"

  • "ftm"

  • "fabric"

  • "speed-test"

_intf_device-access-list

string

Deprecated, please rename it to _intf_device_access_list.

_intf_device-identification

string

Deprecated, please rename it to _intf_device_identification.

Choices:

  • "disable"

  • "enable"

_intf_device-netscan

string

Deprecated, please rename it to _intf_device_netscan.

Choices:

  • "disable"

  • "enable"

_intf_dhcp-relay-ip

any

(list) Deprecated, please rename it to _intf_dhcp_relay_ip.

_intf_dhcp-relay-service

string

Deprecated, please rename it to _intf_dhcp_relay_service.

Choices:

  • "disable"

  • "enable"

_intf_dhcp-relay-type

string

Deprecated, please rename it to _intf_dhcp_relay_type.

Choices:

  • "regular"

  • "ipsec"

_intf_dhcp6-relay-ip

string

Deprecated, please rename it to _intf_dhcp6_relay_ip.

_intf_dhcp6-relay-service

string

Deprecated, please rename it to _intf_dhcp6_relay_service.

Choices:

  • "disable"

  • "enable"

_intf_dhcp6-relay-type

string

Deprecated, please rename it to _intf_dhcp6_relay_type.

Choices:

  • "regular"

_intf_ip

string

No description.

_intf_ip6-address

string

Deprecated, please rename it to _intf_ip6_address.

_intf_ip6-allowaccess

list / elements=string

Deprecated, please rename it to _intf_ip6_allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "any"

  • "fgfm"

  • "capwap"

_intf_listen-forticlient-connection

string

Deprecated, please rename it to _intf_listen_forticlient_connection.

Choices:

  • "disable"

  • "enable"

_is_factory_setting

string

No description.

Choices:

  • "disable"

  • "enable"

  • "ext"

_scope

list / elements=dictionary

No description.

name

string

No description.

vdom

string

No description.

access-control-list

string

Deprecated, please rename it to access_control_list.

acct-interim-interval

integer

Deprecated, please rename it to acct_interim_interval.

additional-akms

list / elements=string

Deprecated, please rename it to additional_akms.

Choices:

  • "akm6"

address-group

string

Deprecated, please rename it to address_group.

address-group-policy

string

Deprecated, please rename it to address_group_policy. Configure MAC address filtering policy for MAC addresses that are in…

Choices:

  • "disable"

  • "allow"

  • "deny"

alias

string

No description.

antivirus-profile

string

Deprecated, please rename it to antivirus_profile. AntiVirus profile name.

application-detection-engine

string

Deprecated, please rename it to application_detection_engine. Enable/disable application detection engine

Choices:

  • "disable"

  • "enable"

application-dscp-marking

string

Deprecated, please rename it to application_dscp_marking. Enable/disable application attribute based DSCP marking

Choices:

  • "disable"

  • "enable"

application-list

string

Deprecated, please rename it to application_list. Application control list name.

application-report-intv

integer

Deprecated, please rename it to application_report_intv. Application report interval

atf-weight

integer

Deprecated, please rename it to atf_weight.

auth

string

No description.

Choices:

  • "PSK"

  • "psk"

  • "RADIUS"

  • "radius"

  • "usergroup"

auth-cert

string

Deprecated, please rename it to auth_cert. HTTPS server certificate.

auth-portal-addr

string

Deprecated, please rename it to auth_portal_addr. Address of captive portal.

beacon-advertising

list / elements=string

Deprecated, please rename it to beacon_advertising.

Choices:

  • "name"

  • "model"

  • "serial-number"

broadcast-ssid

string

Deprecated, please rename it to broadcast_ssid.

Choices:

  • "disable"

  • "enable"

broadcast-suppression

list / elements=string

Deprecated, please rename it to broadcast_suppression.

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"

bss-color-partial

string

Deprecated, please rename it to bss_color_partial.

Choices:

  • "disable"

  • "enable"

bstm-disassociation-imminent

string

Deprecated, please rename it to bstm_disassociation_imminent. Enable/disable forcing of disassociation after the BSTM requ…

Choices:

  • "disable"

  • "enable"

bstm-load-balancing-disassoc-timer

integer

Deprecated, please rename it to bstm_load_balancing_disassoc_timer. Time interval for client to voluntarily leave AP befor…

bstm-rssi-disassoc-timer

integer

Deprecated, please rename it to bstm_rssi_disassoc_timer. Time interval for client to voluntarily leave AP before forcing …

captive-portal-ac-name

string

Deprecated, please rename it to captive_portal_ac_name.

captive-portal-auth-timeout

integer

Deprecated, please rename it to captive_portal_auth_timeout.

captive-portal-fw-accounting

string

Deprecated, please rename it to captive_portal_fw_accounting. Enable/disable RADIUS accounting for captive portal firewall…

Choices:

  • "disable"

  • "enable"

captive-portal-macauth-radius-secret

any

(list) Deprecated, please rename it to captive_portal_macauth_radius_secret.

captive-portal-macauth-radius-server

string

Deprecated, please rename it to captive_portal_macauth_radius_server.

captive-portal-radius-secret

any

(list) Deprecated, please rename it to captive_portal_radius_secret.

captive-portal-radius-server

string

Deprecated, please rename it to captive_portal_radius_server.

captive-portal-session-timeout-interval

integer

Deprecated, please rename it to captive_portal_session_timeout_interval.

client-count

integer

Deprecated, please rename it to client_count.

dhcp-address-enforcement

string

Deprecated, please rename it to dhcp_address_enforcement. Enable/disable DHCP address enforcement

Choices:

  • "disable"

  • "enable"

dhcp-lease-time

integer

Deprecated, please rename it to dhcp_lease_time.

dhcp-option43-insertion

string

Deprecated, please rename it to dhcp_option43_insertion.

Choices:

  • "disable"

  • "enable"

dhcp-option82-circuit-id-insertion

string

Deprecated, please rename it to dhcp_option82_circuit_id_insertion.

Choices:

  • "disable"

  • "style-1"

  • "style-2"

  • "style-3"

dhcp-option82-insertion

string

Deprecated, please rename it to dhcp_option82_insertion.

Choices:

  • "disable"

  • "enable"

dhcp-option82-remote-id-insertion

string

Deprecated, please rename it to dhcp_option82_remote_id_insertion.

Choices:

  • "disable"

  • "style-1"

dynamic-vlan

string

Deprecated, please rename it to dynamic_vlan.

Choices:

  • "disable"

  • "enable"

eap-reauth

string

Deprecated, please rename it to eap_reauth.

Choices:

  • "disable"

  • "enable"

eap-reauth-intv

integer

Deprecated, please rename it to eap_reauth_intv.

eapol-key-retries

string

Deprecated, please rename it to eapol_key_retries.

Choices:

  • "disable"

  • "enable"

encrypt

string

No description.

Choices:

  • "TKIP"

  • "AES"

  • "TKIP-AES"

external-fast-roaming

string

Deprecated, please rename it to external_fast_roaming.

Choices:

  • "disable"

  • "enable"

external-logout

string

Deprecated, please rename it to external_logout.

external-web

string

Deprecated, please rename it to external_web.

external-web-format

string

Deprecated, please rename it to external_web_format.

Choices:

  • "auto-detect"

  • "no-query-string"

  • "partial-query-string"

fast-bss-transition

string

Deprecated, please rename it to fast_bss_transition.

Choices:

  • "disable"

  • "enable"

fast-roaming

string

Deprecated, please rename it to fast_roaming.

Choices:

  • "disable"

  • "enable"

ft-mobility-domain

integer

Deprecated, please rename it to ft_mobility_domain.

ft-over-ds

string

Deprecated, please rename it to ft_over_ds.

Choices:

  • "disable"

  • "enable"

ft-r0-key-lifetime

integer

Deprecated, please rename it to ft_r0_key_lifetime.

gas-comeback-delay

integer

Deprecated, please rename it to gas_comeback_delay. GAS comeback delay

gas-fragmentation-limit

integer

Deprecated, please rename it to gas_fragmentation_limit. GAS fragmentation limit

gtk-rekey

string

Deprecated, please rename it to gtk_rekey.

Choices:

  • "disable"

  • "enable"

gtk-rekey-intv

integer

Deprecated, please rename it to gtk_rekey_intv.

high-efficiency

string

Deprecated, please rename it to high_efficiency.

Choices:

  • "disable"

  • "enable"

hotspot20-profile

string

Deprecated, please rename it to hotspot20_profile.

igmp-snooping

string

Deprecated, please rename it to igmp_snooping. Enable/disable IGMP snooping.

Choices:

  • "disable"

  • "enable"

intra-vap-privacy

string

Deprecated, please rename it to intra_vap_privacy.

Choices:

  • "disable"

  • "enable"

ip

string

No description.

ips-sensor

string

Deprecated, please rename it to ips_sensor. IPS sensor name.

ipv6-rules

list / elements=string

Deprecated, please rename it to ipv6_rules.

Choices:

  • "drop-icmp6ra"

  • "drop-icmp6rs"

  • "drop-llmnr6"

  • "drop-icmp6mld2"

  • "drop-dhcp6s"

  • "drop-dhcp6c"

  • "ndp-proxy"

  • "drop-ns-dad"

  • "drop-ns-nondad"

key

any

(list) No description.

keyindex

integer

No description.

l3-roaming

string

Deprecated, please rename it to l3_roaming. Enable/disable layer 3 roaming

Choices:

  • "disable"

  • "enable"

l3-roaming-mode

string

Deprecated, please rename it to l3_roaming_mode. Select the way that layer 3 roaming traffic is passed

Choices:

  • "direct"

  • "indirect"

ldpc

string

No description.

Choices:

  • "disable"

  • "tx"

  • "rx"

  • "rxtx"

local-authentication

string

Deprecated, please rename it to local_authentication.

Choices:

  • "disable"

  • "enable"

local-bridging

string

Deprecated, please rename it to local_bridging.

Choices:

  • "disable"

  • "enable"

local-lan

string

Deprecated, please rename it to local_lan.

Choices:

  • "deny"

  • "allow"

local-standalone

string

Deprecated, please rename it to local_standalone.

Choices:

  • "disable"

  • "enable"

local-standalone-dns

string

Deprecated, please rename it to local_standalone_dns. Enable/disable AP local standalone DNS.

Choices:

  • "disable"

  • "enable"

local-standalone-dns-ip

any

(list) Deprecated, please rename it to local_standalone_dns_ip.

local-standalone-nat

string

Deprecated, please rename it to local_standalone_nat.

Choices:

  • "disable"

  • "enable"

local-switching

string

Deprecated, please rename it to local_switching.

Choices:

  • "disable"

  • "enable"

mac-auth-bypass

string

Deprecated, please rename it to mac_auth_bypass.

Choices:

  • "disable"

  • "enable"

mac-called-station-delimiter

string

Deprecated, please rename it to mac_called_station_delimiter. MAC called station delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

mac-calling-station-delimiter

string

Deprecated, please rename it to mac_calling_station_delimiter. MAC calling station delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

mac-case

string

Deprecated, please rename it to mac_case. MAC case

Choices:

  • "uppercase"

  • "lowercase"

mac-filter

string

Deprecated, please rename it to mac_filter.

Choices:

  • "disable"

  • "enable"

mac-filter-policy-other

string

Deprecated, please rename it to mac_filter_policy_other.

Choices:

  • "deny"

  • "allow"

mac-password-delimiter

string

Deprecated, please rename it to mac_password_delimiter. MAC authentication password delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

mac-username-delimiter

string

Deprecated, please rename it to mac_username_delimiter. MAC authentication username delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

max-clients

integer

Deprecated, please rename it to max_clients.

max-clients-ap

integer

Deprecated, please rename it to max_clients_ap.

mbo

string

Enable/disable Multiband Operation

Choices:

  • "disable"

  • "enable"

mbo-cell-data-conn-pref

string

Deprecated, please rename it to mbo_cell_data_conn_pref. MBO cell data connection preference

Choices:

  • "excluded"

  • "prefer-not"

  • "prefer-use"

me-disable-thresh

integer

Deprecated, please rename it to me_disable_thresh.

mesh-backhaul

string

Deprecated, please rename it to mesh_backhaul.

Choices:

  • "disable"

  • "enable"

mpsk

string

No description.

Choices:

  • "disable"

  • "enable"

mpsk-concurrent-clients

integer

Deprecated, please rename it to mpsk_concurrent_clients.

mpsk-profile

string

Deprecated, please rename it to mpsk_profile.

mu-mimo

string

Deprecated, please rename it to mu_mimo.

Choices:

  • "disable"

  • "enable"

multicast-enhance

string

Deprecated, please rename it to multicast_enhance.

Choices:

  • "disable"

  • "enable"

multicast-rate

string

Deprecated, please rename it to multicast_rate.

Choices:

  • "0"

  • "6000"

  • "12000"

  • "24000"

nac

string

Enable/disable network access control.

Choices:

  • "disable"

  • "enable"

nac-profile

string

Deprecated, please rename it to nac_profile. NAC profile name.

neighbor-report-dual-band

string

Deprecated, please rename it to neighbor_report_dual_band. Enable/disable dual-band neighbor report

Choices:

  • "disable"

  • "enable"

okc

string

No description.

Choices:

  • "disable"

  • "enable"

osen

string

Enable/disable OSEN as part of key management

Choices:

  • "disable"

  • "enable"

owe-groups

list / elements=string

Deprecated, please rename it to owe_groups.

Choices:

  • "19"

  • "20"

  • "21"

owe-transition

string

Deprecated, please rename it to owe_transition.

Choices:

  • "disable"

  • "enable"

owe-transition-ssid

string

Deprecated, please rename it to owe_transition_ssid.

passphrase

any

(list) No description.

pmf

string

No description.

Choices:

  • "disable"

  • "enable"

  • "optional"

pmf-assoc-comeback-timeout

integer

Deprecated, please rename it to pmf_assoc_comeback_timeout.

pmf-sa-query-retry-timeout

integer

Deprecated, please rename it to pmf_sa_query_retry_timeout.

port-macauth

string

Deprecated, please rename it to port_macauth. Enable/disable LAN port MAC authentication

Choices:

  • "disable"

  • "radius"

  • "address-group"

port-macauth-reauth-timeout

integer

Deprecated, please rename it to port_macauth_reauth_timeout. LAN port MAC authentication re-authentication timeout value

port-macauth-timeout

integer

Deprecated, please rename it to port_macauth_timeout. LAN port MAC authentication idle timeout value

portal-message-override-group

string

Deprecated, please rename it to portal_message_override_group.

portal-type

string

Deprecated, please rename it to portal_type.

Choices:

  • "auth"

  • "auth+disclaimer"

  • "disclaimer"

  • "email-collect"

  • "cmcc"

  • "cmcc-macauth"

  • "auth-mac"

  • "external-auth"

  • "external-macauth"

primary-wag-profile

string

Deprecated, please rename it to primary_wag_profile.

probe-resp-suppression

string

Deprecated, please rename it to probe_resp_suppression.

Choices:

  • "disable"

  • "enable"

probe-resp-threshold

string

Deprecated, please rename it to probe_resp_threshold.

ptk-rekey

string

Deprecated, please rename it to ptk_rekey.

Choices:

  • "disable"

  • "enable"

ptk-rekey-intv

integer

Deprecated, please rename it to ptk_rekey_intv.

qos-profile

string

Deprecated, please rename it to qos_profile.

quarantine

string

No description.

Choices:

  • "disable"

  • "enable"

radio-2g-threshold

string

Deprecated, please rename it to radio_2g_threshold.

radio-5g-threshold

string

Deprecated, please rename it to radio_5g_threshold.

radio-sensitivity

string

Deprecated, please rename it to radio_sensitivity.

Choices:

  • "disable"

  • "enable"

radius-mac-auth

string

Deprecated, please rename it to radius_mac_auth.

Choices:

  • "disable"

  • "enable"

radius-mac-auth-block-interval

integer

Deprecated, please rename it to radius_mac_auth_block_interval. Dont send RADIUS MAC auth request again if the client has …

radius-mac-auth-server

string

Deprecated, please rename it to radius_mac_auth_server.

radius-mac-auth-usergroups

any

(list) Deprecated, please rename it to radius_mac_auth_usergroups.

radius-mac-mpsk-auth

string

Deprecated, please rename it to radius_mac_mpsk_auth. Enable/disable RADIUS-based MAC authentication of clients for MPSK a…

Choices:

  • "disable"

  • "enable"

radius-mac-mpsk-timeout

integer

Deprecated, please rename it to radius_mac_mpsk_timeout. RADIUS MAC MPSK cache timeout interval

radius-server

string

Deprecated, please rename it to radius_server.

rates-11a

list / elements=string

Deprecated, please rename it to rates_11a.

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"

rates-11ac-mcs-map

string

Deprecated, please rename it to rates_11ac_mcs_map. Comma separated list of max supported VHT MCS for spatial streams 1 th…

rates-11ac-ss12

list / elements=string

Deprecated, please rename it to rates_11ac_ss12.

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"

rates-11ac-ss34

list / elements=string

Deprecated, please rename it to rates_11ac_ss34.

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"

rates-11ax-mcs-map

string

Deprecated, please rename it to rates_11ax_mcs_map. Comma separated list of max supported HE MCS for spatial streams 1 thr…

rates-11ax-ss12

list / elements=string

Deprecated, please rename it to rates_11ax_ss12.

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"

rates-11ax-ss34

list / elements=string

Deprecated, please rename it to rates_11ax_ss34.

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"

rates-11bg

list / elements=string

Deprecated, please rename it to rates_11bg.

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"

rates-11n-ss12

list / elements=string

Deprecated, please rename it to rates_11n_ss12.

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"

rates-11n-ss34

list / elements=string

Deprecated, please rename it to rates_11n_ss34.

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"

roaming-acct-interim-update

string

Deprecated, please rename it to roaming_acct_interim_update. Enable/disable using accounting interim update instead of acc…

Choices:

  • "disable"

  • "enable"

sae-groups

list / elements=string

Deprecated, please rename it to sae_groups.

Choices:

  • "1"

  • "2"

  • "5"

  • "14"

  • "15"

  • "16"

  • "17"

  • "18"

  • "19"

  • "20"

  • "21"

  • "27"

  • "28"

  • "29"

  • "30"

  • "31"

sae-h2e-only

string

Deprecated, please rename it to sae_h2e_only. Use hash-to-element-only mechanism for PWE derivation

Choices:

  • "disable"

  • "enable"

sae-hnp-only

string

Deprecated, please rename it to sae_hnp_only. Use hunting-and-pecking-only mechanism for PWE derivation

Choices:

  • "disable"

  • "enable"

sae-password

any

(list) Deprecated, please rename it to sae_password.

sae-pk

string

Deprecated, please rename it to sae_pk. Enable/disable WPA3 SAE-PK

Choices:

  • "disable"

  • "enable"

sae-private-key

string

Deprecated, please rename it to sae_private_key. Private key used for WPA3 SAE-PK authentication.

scan-botnet-connections

string

Deprecated, please rename it to scan_botnet_connections. Block or monitor connections to Botnet servers or disable Botnet …

Choices:

  • "disable"

  • "block"

  • "monitor"

schedule

any

(list or str) No description.

secondary-wag-profile

string

Deprecated, please rename it to secondary_wag_profile.

security

string

No description.

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"

security-exempt-list

string

Deprecated, please rename it to security_exempt_list.

security-obsolete-option

string

Deprecated, please rename it to security_obsolete_option.

Choices:

  • "disable"

  • "enable"

security-redirect-url

string

Deprecated, please rename it to security_redirect_url.

selected-usergroups

any

(list or str) Deprecated, please rename it to selected_usergroups.

split-tunneling

string

Deprecated, please rename it to split_tunneling.

Choices:

  • "disable"

  • "enable"

ssid

string

No description.

sticky-client-remove

string

Deprecated, please rename it to sticky_client_remove.

Choices:

  • "disable"

  • "enable"

sticky-client-threshold-2g

string

Deprecated, please rename it to sticky_client_threshold_2g.

sticky-client-threshold-5g

string

Deprecated, please rename it to sticky_client_threshold_5g.

sticky-client-threshold-6g

string

Deprecated, please rename it to sticky_client_threshold_6g. Minimum signal level/threshold in dBm required for the 6G clie…

target-wake-time

string

Deprecated, please rename it to target_wake_time.

Choices:

  • "disable"

  • "enable"

tkip-counter-measure

string

Deprecated, please rename it to tkip_counter_measure.

Choices:

  • "disable"

  • "enable"

tunnel-echo-interval

integer

Deprecated, please rename it to tunnel_echo_interval.

tunnel-fallback-interval

integer

Deprecated, please rename it to tunnel_fallback_interval.

usergroup

any

(list or str) No description.

utm-log

string

Deprecated, please rename it to utm_log. Enable/disable UTM logging.

Choices:

  • "disable"

  • "enable"

utm-profile

string

Deprecated, please rename it to utm_profile.

utm-status

string

Deprecated, please rename it to utm_status. Enable to add one or more security profiles

Choices:

  • "disable"

  • "enable"

vdom

any

(list or str) No description.

vlan-auto

string

Deprecated, please rename it to vlan_auto.

Choices:

  • "disable"

  • "enable"

vlan-pooling

string

Deprecated, please rename it to vlan_pooling.

Choices:

  • "wtp-group"

  • "round-robin"

  • "hash"

  • "disable"

vlanid

integer

No description.

voice-enterprise

string

Deprecated, please rename it to voice_enterprise.

Choices:

  • "disable"

  • "enable"

webfilter-profile

string

Deprecated, please rename it to webfilter_profile. WebFilter profile name.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Virtual Access Points
      fortinet.fortimanager.fmgr_vap_dynamicmapping:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        vap: <your own value>
        state: present # <value in [present, absent]>
        vap_dynamicmapping:
          _centmgmt: <value in [disable, enable]>
          _dhcp_svr_id: <string>
          _intf_allowaccess:
            - https
            - ping
            - ssh
            - snmp
            - http
            - telnet
            - fgfm
            - auto-ipsec
            - radius-acct
            - probe-response
            - capwap
            - dnp
            - ftm
            - fabric
            - speed-test
          _intf_device_identification: <value in [disable, enable]>
          _intf_device_netscan: <value in [disable, enable]>
          _intf_dhcp_relay_ip: <list or string>
          _intf_dhcp_relay_service: <value in [disable, enable]>
          _intf_dhcp_relay_type: <value in [regular, ipsec]>
          _intf_dhcp6_relay_ip: <string>
          _intf_dhcp6_relay_service: <value in [disable, enable]>
          _intf_dhcp6_relay_type: <value in [regular]>
          _intf_ip: <string>
          _intf_ip6_address: <string>
          _intf_ip6_allowaccess:
            - https
            - ping
            - ssh
            - snmp
            - http
            - telnet
            - any
            - fgfm
            - capwap
          _intf_listen_forticlient_connection: <value in [disable, enable]>
          _scope:
            -
              name: <string>
              vdom: <string>
          acct_interim_interval: <integer>
          address_group: <string>
          alias: <string>
          atf_weight: <integer>
          auth: <value in [PSK, psk, RADIUS, ...]>
          broadcast_ssid: <value in [disable, enable]>
          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: <string>
          captive_portal_macauth_radius_secret: <list or string>
          captive_portal_macauth_radius_server: <string>
          captive_portal_radius_secret: <list or string>
          captive_portal_radius_server: <string>
          captive_portal_session_timeout_interval: <integer>
          client_count: <integer>
          dhcp_lease_time: <integer>
          dhcp_option82_circuit_id_insertion: <value in [disable, style-1, style-2, ...]>
          dhcp_option82_insertion: <value in [disable, enable]>
          dhcp_option82_remote_id_insertion: <value in [disable, style-1]>
          dynamic_vlan: <value in [disable, enable]>
          eap_reauth: <value in [disable, enable]>
          eap_reauth_intv: <integer>
          eapol_key_retries: <value in [disable, enable]>
          encrypt: <value in [TKIP, AES, TKIP-AES]>
          external_fast_roaming: <value in [disable, enable]>
          external_logout: <string>
          external_web: <string>
          fast_bss_transition: <value in [disable, enable]>
          fast_roaming: <value in [disable, enable]>
          ft_mobility_domain: <integer>
          ft_over_ds: <value in [disable, enable]>
          ft_r0_key_lifetime: <integer>
          gtk_rekey: <value in [disable, enable]>
          gtk_rekey_intv: <integer>
          hotspot20_profile: <string>
          intra_vap_privacy: <value in [disable, enable]>
          ip: <string>
          key: <list or string>
          keyindex: <integer>
          ldpc: <value in [disable, tx, rx, ...]>
          local_authentication: <value in [disable, enable]>
          local_bridging: <value in [disable, enable]>
          local_lan: <value in [deny, allow]>
          local_standalone: <value in [disable, enable]>
          local_standalone_nat: <value in [disable, enable]>
          local_switching: <value in [disable, enable]>
          mac_auth_bypass: <value in [disable, enable]>
          mac_filter: <value in [disable, enable]>
          mac_filter_policy_other: <value in [deny, allow]>
          max_clients: <integer>
          max_clients_ap: <integer>
          me_disable_thresh: <integer>
          mesh_backhaul: <value in [disable, enable]>
          mpsk: <value in [disable, enable]>
          mpsk_concurrent_clients: <integer>
          multicast_enhance: <value in [disable, enable]>
          multicast_rate: <value in [0, 6000, 12000, ...]>
          okc: <value in [disable, enable]>
          owe_groups:
            - 19
            - 20
            - 21
          owe_transition: <value in [disable, enable]>
          owe_transition_ssid: <string>
          passphrase: <list or string>
          pmf: <value in [disable, enable, optional]>
          pmf_assoc_comeback_timeout: <integer>
          pmf_sa_query_retry_timeout: <integer>
          portal_message_override_group: <string>
          portal_type: <value in [auth, auth+disclaimer, disclaimer, ...]>
          probe_resp_suppression: <value in [disable, enable]>
          probe_resp_threshold: <string>
          ptk_rekey: <value in [disable, enable]>
          ptk_rekey_intv: <integer>
          qos_profile: <string>
          quarantine: <value in [disable, enable]>
          radio_2g_threshold: <string>
          radio_5g_threshold: <string>
          radio_sensitivity: <value in [disable, enable]>
          radius_mac_auth: <value in [disable, enable]>
          radius_mac_auth_server: <string>
          radius_mac_auth_usergroups: <list or string>
          radius_server: <string>
          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: <list or string>
          schedule: <list or string>
          security: <value in [None, WEP64, wep64, ...]>
          security_exempt_list: <string>
          security_obsolete_option: <value in [disable, enable]>
          security_redirect_url: <string>
          selected_usergroups: <list or string>
          split_tunneling: <value in [disable, enable]>
          ssid: <string>
          tkip_counter_measure: <value in [disable, enable]>
          usergroup: <list or string>
          utm_profile: <string>
          vdom: <list or string>
          vlan_auto: <value in [disable, enable]>
          vlan_pooling: <value in [wtp-group, round-robin, hash, ...]>
          vlanid: <integer>
          voice_enterprise: <value in [disable, enable]>
          mu_mimo: <value in [disable, enable]>
          _intf_device_access_list: <string>
          external_web_format: <value in [auto-detect, no-query-string, partial-query-string]>
          high_efficiency: <value in [disable, enable]>
          primary_wag_profile: <string>
          secondary_wag_profile: <string>
          target_wake_time: <value in [disable, enable]>
          tunnel_echo_interval: <integer>
          tunnel_fallback_interval: <integer>
          access_control_list: <string>
          captive_portal_auth_timeout: <integer>
          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: <value in [disable, enable]>
          sticky_client_threshold_2g: <string>
          sticky_client_threshold_5g: <string>
          bss_color_partial: <value in [disable, enable]>
          dhcp_option43_insertion: <value in [disable, enable]>
          mpsk_profile: <string>
          igmp_snooping: <value in [disable, enable]>
          port_macauth: <value in [disable, radius, address-group]>
          port_macauth_reauth_timeout: <integer>
          port_macauth_timeout: <integer>
          additional_akms:
            - akm6
          bstm_disassociation_imminent: <value in [disable, enable]>
          bstm_load_balancing_disassoc_timer: <integer>
          bstm_rssi_disassoc_timer: <integer>
          dhcp_address_enforcement: <value in [disable, enable]>
          gas_comeback_delay: <integer>
          gas_fragmentation_limit: <integer>
          mac_called_station_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          mac_calling_station_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          mac_case: <value in [uppercase, lowercase]>
          mac_password_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          mac_username_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          mbo: <value in [disable, enable]>
          mbo_cell_data_conn_pref: <value in [excluded, prefer-not, prefer-use]>
          nac: <value in [disable, enable]>
          nac_profile: <string>
          neighbor_report_dual_band: <value in [disable, enable]>
          address_group_policy: <value in [disable, allow, deny]>
          antivirus_profile: <string>
          application_detection_engine: <value in [disable, enable]>
          application_list: <string>
          application_report_intv: <integer>
          auth_cert: <string>
          auth_portal_addr: <string>
          beacon_advertising:
            - name
            - model
            - serial-number
          ips_sensor: <string>
          l3_roaming: <value in [disable, enable]>
          local_standalone_dns: <value in [disable, enable]>
          local_standalone_dns_ip: <list or string>
          osen: <value in [disable, enable]>
          radius_mac_mpsk_auth: <value in [disable, enable]>
          radius_mac_mpsk_timeout: <integer>
          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: <value in [disable, block, monitor]>
          utm_log: <value in [disable, enable]>
          utm_status: <value in [disable, enable]>
          webfilter_profile: <string>
          sae_h2e_only: <value in [disable, enable]>
          sae_pk: <value in [disable, enable]>
          sae_private_key: <string>
          sticky_client_threshold_6g: <string>
          application_dscp_marking: <value in [disable, enable]>
          l3_roaming_mode: <value in [direct, indirect]>
          rates_11ac_mcs_map: <string>
          rates_11ax_mcs_map: <string>
          captive_portal_fw_accounting: <value in [disable, enable]>
          radius_mac_auth_block_interval: <integer>
          _is_factory_setting: <value in [disable, enable, ext]>
          d80211k: <value in [disable, enable]>
          d80211v: <value in [disable, enable]>
          roaming_acct_interim_update: <value in [disable, enable]>
          sae_hnp_only: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)