fortios_switch_controller_fortilink_settings – Configure integrated FortiLink settings for FortiSwitch in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_switch_controller_fortilink_settings | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- switch_controller_fortilink_settings - Configure integrated FortiLink settings for FortiSwitch. type: dict more...
- fortilink - FortiLink interface to which this fortilink-setting belongs. Source system.interface.name. type: str more...
- inactive_timer - Time interval(minutes) to be included in the inactive devices expiry calculation (mac age-out + inactive-time + periodic scan interval). type: int more...
- link_down_flush - Clear NAC and dynamic devices on switch ports on link down event. type: str choices: disable, enable more...
- nac_ports - NAC specific configuration. type: dict more...
- bounce_nac_port - 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 choices: disable, enable more...
- lan_segment - Enable/disable LAN segment feature on the FortiLink interface. type: str choices: enabled, disabled more...
- member_change - Member change flag. type: int more...
- nac_lan_interface - Configure NAC LAN interface. Source system.interface.name. type: str more...
- nac_segment_vlans - Configure NAC segment VLANs. type: list more...
- vlan_name - VLAN interface name. Source system.interface.name. type: str more...
- onboarding_vlan - Default NAC Onboarding VLAN when NAC devices are discovered. Source system.interface.name. type: str more...
- parent_key - Parent key name. type: str more...
- name - FortiLink settings name. type: str required: true more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3