fortinet.fortios.fortios_switch_controller_fortilink_settings module – Configure integrated FortiLink settings for FortiSwitch in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.2).

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

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

The below requirements are needed on the host that executes this module.

• ansible>=2.9

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
member_path string	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.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: "present" "absent"
state string / required	Indicates whether to create or remove the object. Choices: "present" "absent"
switch_controller_fortilink_settings dictionary	Configure integrated FortiLink settings for FortiSwitch.
fortilink string	FortiLink interface to which this fortilink-setting belongs. Source system.interface.name.
inactive_timer integer	Time interval(minutes) to be included in the inactive devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
link_down_flush string	Clear NAC and dynamic devices on switch ports on link down event. Choices: "disable" "enable"
nac_ports dictionary	NAC specific configuration.
bounce_nac_port string	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. Choices: "disable" "enable"
lan_segment string	Enable/disable LAN segment feature on the FortiLink interface. Choices: "enabled" "disabled"
member_change integer	Member change flag.
nac_lan_interface string	Configure NAC LAN interface. Source system.interface.name.
nac_segment_vlans list / elements=dictionary	Configure NAC segment VLANs.
vlan_name string / required	VLAN interface name. Source system.interface.name.
onboarding_vlan string	Default NAC Onboarding VLAN when NAC devices are discovered. Source system.interface.name.
parent_key string	Parent key name.
name string / required	FortiLink settings name.
vdom string	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: "root"

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure integrated FortiLink settings for FortiSwitch.
    fortios_switch_controller_fortilink_settings:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_fortilink_settings:
        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_15"

Return Values

Common return values are documented here, the following are the fields unique to this module:

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

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)