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.5.1).
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.16
Parameters
Parameter | Comments |
|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. |
enable_log boolean | Enable/Disable logging for task. Choices:
|
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:
|
state string / required | Indicates whether to create or remove the object. Choices:
|
switch_controller_fortilink_settings dictionary | Configure integrated FortiLink settings for FortiSwitch. |
|
access_vlan_mode string |
Intra VLAN traffic behavior with loss of connection to the FortiGate. Choices:
|
|
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:
|
|
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:
|
|
lan_segment string |
Enable/disable LAN segment feature on the FortiLink interface. Choices:
|
|
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: |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
- 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"
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: |
http_method string | Last method used to provision the content into FortiGate Returned: always Sample: |
http_status string | Last result given by FortiGate on last operation applied Returned: always Sample: |
mkey string | Master key (id) used in the last call to FortiGate Returned: success Sample: |
name string | Name of the table used to fulfill the request Returned: always Sample: |
path string | Path of the table used to fulfill the request Returned: always Sample: |
revision string | Internal revision number Returned: always Sample: |
serial string | Serial number of the unit Returned: always Sample: |
status string | Indication of the operation’s result Returned: always Sample: |
vdom string | Virtual domain used Returned: always Sample: |
version string | Version of the FortiGate Returned: always Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_fortilink_settings_module.html
