ansible.builtin.fortios_switch_controller_security_policy_802_1X (v2.9.27) — module

Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure 802.1x MAC Authentication Bypass (MAB) policies.
    fortios_switch_controller_security_policy_802_1X:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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"
        eap_passthru: "disable"
        guest_auth_delay: "7"
        guest_vlan: "disable"
        guest_vlan_id: "<your_own_value> (source system.interface.name)"
        guest_vlanid: "10"
        mac_auth_bypass: "disable"
        name: "default_name_12"
        open_auth: "disable"
        policy_type: "802.1X"
        radius_timeout_overwrite: "disable"
        security_mode: "802.1X"
        user_group:
         -
            name: "default_name_18 (source user.group.name)"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

switch_controller_security_policy_802_1X:
    default: null
    description:
    - Configure 802.1x MAC Authentication Bypass (MAB) policies.
    suboptions:
      auth_fail_vlan:
        choices:
        - disable
        - enable
        description:
        - Enable to allow limited access to clients that cannot authenticate.
        type: str
      auth_fail_vlan_id:
        description:
        - VLAN ID on which authentication failed. Source system.interface.name.
        type: str
      auth_fail_vlanid:
        description:
        - VLAN ID on which authentication failed.
        type: int
      eap_passthru:
        choices:
        - disable
        - enable
        description:
        - Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass
          through ports for more flexible authentication.
        type: str
      guest_auth_delay:
        description:
        - Guest authentication delay (1 - 900  sec).
        type: int
      guest_vlan:
        choices:
        - disable
        - enable
        description:
        - Enable the guest VLAN feature to allow limited access to non-802.1X-compliant
          clients.
        type: str
      guest_vlan_id:
        description:
        - Guest VLAN name. Source system.interface.name.
        type: str
      guest_vlanid:
        description:
        - Guest VLAN ID.
        type: int
      mac_auth_bypass:
        choices:
        - disable
        - enable
        description:
        - Enable/disable MAB for this policy.
        type: str
      name:
        description:
        - Policy name.
        required: true
        type: str
      open_auth:
        choices:
        - disable
        - enable
        description:
        - Enable/disable open authentication for this policy.
        type: str
      policy_type:
        choices:
        - 802.1X
        description:
        - Policy type.
        type: str
      radius_timeout_overwrite:
        choices:
        - disable
        - enable
        description:
        - Enable to override the global RADIUS session timeout.
        type: str
      security_mode:
        choices:
        - 802.1X
        - 802.1X-mac-based
        description:
        - Port or MAC based 802.1X security mode.
        type: str
      user_group:
        description:
        - Name of user-group to assign to this MAC Authentication Bypass (MAB) policy.
        suboptions:
          name:
            description:
            - Group name. Source user.group.name.
            required: true
            type: str
        type: list
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str