fortios_switch_controller_security_policy_802_1x – Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- switch_controller_security_policy_802_1x - Configure 802.1x MAC Authentication Bypass (MAB) policies. type: dict more...
- auth_fail_vlan - Enable to allow limited access to clients that cannot authenticate. type: str choices: disable, enable more...
- auth_fail_vlan_id - VLAN ID on which authentication failed. Source system.interface.name. type: str more...
- auth_fail_vlanid - VLAN ID on which authentication failed. type: int more...
- authserver_timeout_period - Authentication server timeout period (3 - 15 sec). type: int more...
- authserver_timeout_vlan - Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable. type: str choices: disable, enable more...
- authserver_timeout_vlanid - Authentication server timeout VLAN name. Source system.interface.name. type: str more...
- eap_auto_untagged_vlans - Enable/disable automatic inclusion of untagged VLANs. type: str choices: disable, enable more...
- eap_passthru - Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass through ports for more flexible authentication. type: str choices: disable, enable more...
- framevid_apply - Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN. type: str choices: disable, enable more...
- guest_auth_delay - Guest authentication delay (1 - 900 sec). type: int more...
- guest_vlan - Enable the guest VLAN feature to allow limited access to non-802.1X-compliant clients. type: str choices: disable, enable more...
- guest_vlan_id - Guest VLAN name. Source system.interface.name. type: str more...
- guest_vlanid - Guest VLAN ID. type: int more...
- mac_auth_bypass - Enable/disable MAB for this policy. type: str choices: disable, enable more...
- name - Policy name. type: str required: true more...
- open_auth - Enable/disable open authentication for this policy. type: str choices: disable, enable more...
- policy_type - Policy type. type: str choices: 802.1X more...
- radius_timeout_overwrite - Enable to override the global RADIUS session timeout. type: str choices: disable, enable more...
- security_mode - Port or MAC based 802.1X security mode. type: str choices: 802.1X, 802.1X-mac-based more...
- user_group - Name of user-group to assign to this MAC Authentication Bypass (MAB) policy. type: list member_path: user_group:name more...
- name - Group name. Source user.group.name. type: str required: true more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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"
authserver_timeout_period: "3"
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: "30"
guest_vlan: "disable"
guest_vlan_id: "<your_own_value> (source system.interface.name)"
guest_vlanid: "32767"
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.