fortinet.fortios.fortios_switch_controller_802_1x_settings (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure global 802.1X settings.
  fortinet.fortios.fortios_switch_controller_802_1x_settings:
      vdom: "{{ vdom }}"
      switch_controller_802_1x_settings:
          link_down_auth: "set-unauth"
          mab_reauth: "disable"
          mac_called_station_delimiter: "colon"
          mac_calling_station_delimiter: "colon"
          mac_case: "lowercase"
          mac_password_delimiter: "colon"
          mac_username_delimiter: "colon"
          max_reauth_attempt: "3"
          reauth_period: "60"
          tx_period: "30"

Inputs

    
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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

switch_controller_802_1x_settings:
    default: null
    description:
    - Configure global 802.1X settings.
    suboptions:
      link_down_auth:
        choices:
        - set-unauth
        - no-action
        description:
        - Interface-reauthentication state to set if a link is down.
        type: str
      mab_reauth:
        choices:
        - disable
        - enable
        description:
        - Enable/disable MAB re-authentication.
        type: str
      mac_called_station_delimiter:
        choices:
        - colon
        - hyphen
        - none
        - single-hyphen
        description:
        - MAC called station delimiter .
        type: str
      mac_calling_station_delimiter:
        choices:
        - colon
        - hyphen
        - none
        - single-hyphen
        description:
        - MAC calling station delimiter .
        type: str
      mac_case:
        choices:
        - lowercase
        - uppercase
        description:
        - MAC case .
        type: str
      mac_password_delimiter:
        choices:
        - colon
        - hyphen
        - none
        - single-hyphen
        description:
        - MAC authentication password delimiter .
        type: str
      mac_username_delimiter:
        choices:
        - colon
        - hyphen
        - none
        - single-hyphen
        description:
        - MAC authentication username delimiter .
        type: str
      max_reauth_attempt:
        description:
        - Maximum number of authentication attempts (0 - 15).
        type: int
      reauth_period:
        description:
        - Period of time to allow for reauthentication (1 - 1440 sec).
        type: int
      tx_period:
        description:
        - 802.1X Tx period (seconds).
        type: int
    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