fortinet.fortios.fortios_switch_controller_security_policy_802_1x – Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_security_policy_802_1x.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_security_policy feature and 802_1x category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
switch_controller_security_policy_802_1x
dictionary
Configure 802.1x MAC Authentication Bypass (MAB) policies.
auth_fail_vlan
string
    Choices:
  • disable
  • enable
Enable to allow limited access to clients that cannot authenticate.
auth_fail_vlan_id
string
VLAN ID on which authentication failed. Source system.interface.name.
auth_fail_vlanid
integer
VLAN ID on which authentication failed.
authserver_timeout_period
integer
Authentication server timeout period (3 - 15 sec).
authserver_timeout_vlan
string
    Choices:
  • disable
  • enable
Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable.
authserver_timeout_vlanid
string
Authentication server timeout VLAN name. Source system.interface.name.
eap_auto_untagged_vlans
string
    Choices:
  • disable
  • enable
Enable/disable automatic inclusion of untagged VLANs.
eap_passthru
string
    Choices:
  • disable
  • enable
Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass through ports for more flexible authentication.
framevid_apply
string
    Choices:
  • disable
  • enable
Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN.
guest_auth_delay
integer
Guest authentication delay (1 - 900 sec).
guest_vlan
string
    Choices:
  • disable
  • enable
Enable the guest VLAN feature to allow limited access to non-802.1X-compliant clients.
guest_vlan_id
string
Guest VLAN name. Source system.interface.name.
guest_vlanid
integer
Guest VLAN ID.
mac_auth_bypass
string
    Choices:
  • disable
  • enable
Enable/disable MAB for this policy.
name
string / required
Policy name.
open_auth
string
    Choices:
  • disable
  • enable
Enable/disable open authentication for this policy.
policy_type
string
    Choices:
  • 802.1X
Policy type.
radius_timeout_overwrite
string
    Choices:
  • disable
  • enable
Enable to override the global RADIUS session timeout.
security_mode
string
    Choices:
  • 802.1X
  • 802.1X-mac-based
Port or MAC based 802.1X security mode.
user_group
list / elements=string
Name of user-group to assign to this MAC Authentication Bypass (MAB) policy.
name
string / required
Group name. Source user.group.name.
vdom
string
Default:
"root"
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure 802.1x MAC Authentication Bypass (MAB) policies.
    fortios_switch_controller_security_policy_802_1x:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_security_policy_802_1x:
        auth_fail_vlan: "disable"
        auth_fail_vlan_id: "<your_own_value> (source system.interface.name)"
        auth_fail_vlanid: "5"
        authserver_timeout_period: "6"
        authserver_timeout_vlan: "disable"
        authserver_timeout_vlanid: "<your_own_value> (source system.interface.name)"
        eap_auto_untagged_vlans: "disable"
        eap_passthru: "disable"
        framevid_apply: "disable"
        guest_auth_delay: "12"
        guest_vlan: "disable"
        guest_vlan_id: "<your_own_value> (source system.interface.name)"
        guest_vlanid: "15"
        mac_auth_bypass: "disable"
        name: "default_name_17"
        open_auth: "disable"
        policy_type: "802.1X"
        radius_timeout_overwrite: "disable"
        security_mode: "802.1X"
        user_group:
         -
            name: "default_name_23 (source user.group.name)"

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)