fortinet.fortios.fortios_switch_controller_security_policy_802_1x module – Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_security_policy_802_1x.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure 802.1x MAC Authentication Bypass (MAB) policies. |
|
Enable to allow limited access to clients that cannot authenticate. Choices:
|
|
VLAN ID on which authentication failed. Source system.interface.name. |
|
VLAN ID on which authentication failed. |
|
Configure authentication order. Choices:
|
|
Configure authentication priority. Choices:
|
|
Authentication server timeout period (3 - 15 sec). |
|
Configure timeout option for the tagged VLAN which allows limited access when the authentication server is unavailable. Choices:
|
|
Tagged VLAN name for which the timeout option is applied to (only one VLAN ID). Source system.interface.name. |
|
Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable. Choices:
|
|
Authentication server timeout VLAN name. Source system.interface.name. |
|
Enable/disable dynamic access control list on this interface. Choices:
|
|
Enable/disable automatic inclusion of untagged VLANs. Choices:
|
|
Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass through ports for more flexible authentication. Choices:
|
|
Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN. Choices:
|
|
Guest authentication delay (1 - 900 sec). |
|
Enable the guest VLAN feature to allow limited access to non-802.1X-compliant clients. Choices:
|
|
Guest VLAN name. Source system.interface.name. |
|
Guest VLAN ID. |
|
Enable/disable MAB for this policy. Choices:
|
|
Policy name. |
|
Enable/disable open authentication for this policy. Choices:
|
|
Policy type. Choices:
|
|
Enable to override the global RADIUS session timeout. Choices:
|
|
Port or MAC based 802.1X security mode. Choices:
|
|
Name of user-group to assign to this MAC Authentication Bypass (MAB) policy. |
|
Group name. Source user.group.name. |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure 802.1x MAC Authentication Bypass (MAB) policies.
fortinet.fortios.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: "32767"
auth_order: "dot1x-mab"
auth_priority: "legacy"
authserver_timeout_period: "3"
authserver_timeout_tagged: "disable"
authserver_timeout_tagged_vlanid: "<your_own_value> (source system.interface.name)"
authserver_timeout_vlan: "disable"
authserver_timeout_vlanid: "<your_own_value> (source system.interface.name)"
dacl: "disable"
eap_auto_untagged_vlans: "disable"
eap_passthru: "disable"
framevid_apply: "disable"
guest_auth_delay: "30"
guest_vlan: "disable"
guest_vlan_id: "<your_own_value> (source system.interface.name)"
guest_vlanid: "32767"
mac_auth_bypass: "disable"
name: "default_name_22"
open_auth: "disable"
policy_type: "802.1X"
radius_timeout_overwrite: "disable"
security_mode: "802.1X"
user_group:
-
name: "default_name_28 (source user.group.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |