fortinet.fortios.fortios_switch_controller_fortilink_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 fortilink_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 integrated FortiLink settings for FortiSwitch.
  fortinet.fortios.fortios_switch_controller_fortilink_settings:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_fortilink_settings:
          access_vlan_mode: "legacy"
          fortilink: "<your_own_value> (source system.interface.name)"
          inactive_timer: "15"
          link_down_flush: "disable"
          nac_ports:
              bounce_nac_port: "disable"
              lan_segment: "enabled"
              member_change: "0"
              nac_lan_interface: "<your_own_value> (source system.interface.name)"
              nac_segment_vlans:
                  -
                      vlan_name: "<your_own_value> (source system.interface.name)"
              onboarding_vlan: "<your_own_value> (source system.interface.name)"
              parent_key: "<your_own_value>"
          name: "default_name_16"

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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    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_fortilink_settings:
    default: null
    description:
    - Configure integrated FortiLink settings for FortiSwitch.
    suboptions:
      access_vlan_mode:
        choices:
        - legacy
        - fail-open
        - fail-close
        description:
        - Intra VLAN traffic behavior with loss of connection to the FortiGate.
        type: str
      fortilink:
        description:
        - FortiLink interface to which this fortilink-setting belongs. Source system.interface.name.
        type: str
      inactive_timer:
        description:
        - Time interval(minutes) to be included in the inactive devices expiry calculation
          (mac age-out + inactive-time + periodic scan interval).
        type: int
      link_down_flush:
        choices:
        - disable
        - enable
        description:
        - Clear NAC and dynamic devices on switch ports on link down event.
        type: str
      nac_ports:
        description:
        - NAC specific configuration.
        suboptions:
          bounce_nac_port:
            choices:
            - disable
            - enable
            description:
            - Enable/disable bouncing (administratively bring the link down, up) of a
              switch port when NAC mode is configured on the port. Helps to re-initiate
              the DHCP process for a device.
            type: str
          lan_segment:
            choices:
            - enabled
            - disabled
            description:
            - Enable/disable LAN segment feature on the FortiLink interface.
            type: str
          member_change:
            description:
            - Member change flag.
            type: int
          nac_lan_interface:
            description:
            - Configure NAC LAN interface. Source system.interface.name.
            type: str
          nac_segment_vlans:
            description:
            - Configure NAC segment VLANs.
            elements: dict
            suboptions:
              vlan_name:
                description:
                - VLAN interface name. Source system.interface.name.
                required: true
                type: str
            type: list
          onboarding_vlan:
            description:
            - Default NAC Onboarding VLAN when NAC devices are discovered. Source system.interface.name.
            type: str
          parent_key:
            description:
            - Parent key name.
            type: str
        type: dict
      name:
        description:
        - FortiLink settings name.
        required: true
        type: str
    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