fortinet.fortios.fortios_switch_controller_global – Configure FortiSwitch global settings in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_global.

New in version 2.10: of fortinet.fortios

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 global 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.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
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
    Choices:
  • present
  • absent
Add or delete a member under specified attribute path.
When member_state is specified, the state option is ignored.
switch_controller_global
dictionary
Configure FortiSwitch global settings.
allow_multiple_interfaces
string
    Choices:
  • enable
  • disable
Enable/disable multiple FortiLink interfaces for redundant connections between a managed FortiSwitch and FortiGate.
bounce_quarantined_link
string
    Choices:
  • disable
  • enable
Enable/disable bouncing (administratively bring the link down, up) of a switch port where a quarantined device was seen last. Helps to re-initiate the DHCP process for a device.
custom_command
list / elements=string
List of custom commands to be pushed to all FortiSwitches in the VDOM.
command_entry
string
List of FortiSwitch commands.
command_name
string
Name of custom command to push to all FortiSwitches in VDOM. Source switch-controller.custom-command.command-name.
default_virtual_switch_vlan
string
Default VLAN for ports when added to the virtual-switch. Source system.interface.name.
dhcp_server_access_list
string
    Choices:
  • enable
  • disable
Enable/disable DHCP snooping server access list.
disable_discovery
list / elements=string
Prevent this FortiSwitch from discovering.
name
string / required
Managed device ID.
fips_enforce
string
    Choices:
  • disable
  • enable
Enable/disable enforcement of FIPS on managed FortiSwitch devices.
https_image_push
string
    Choices:
  • enable
  • disable
Enable/disable image push to FortiSwitch using HTTPS.
log_mac_limit_violations
string
    Choices:
  • enable
  • disable
Enable/disable logs for Learning Limit Violations.
mac_aging_interval
integer
Time after which an inactive MAC is aged out (10 - 1000000 sec).
mac_event_logging
string
    Choices:
  • enable
  • disable
Enable/disable MAC address event logging.
mac_retention_period
integer
Time in hours after which an inactive MAC is removed from client DB.
mac_violation_timer
integer
Set timeout for Learning Limit Violations (0 = disabled).
quarantine_mode
string
    Choices:
  • by-vlan
  • by-redirect
Quarantine mode.
sn_dns_resolution
string
    Choices:
  • enable
  • disable
Enable/disable DNS resolution of the FortiSwitch unit"s IP address by use of its serial number.
update_user_device
list / elements=string
    Choices:
  • mac-cache
  • lldp
  • dhcp-snooping
  • l2-db
  • l3-db
Control which sources update the device user list.
vlan_all_mode
string
    Choices:
  • all
  • defined
VLAN configuration mode, user-defined-vlans or all-possible-vlans.
vlan_optimization
string
    Choices:
  • enable
  • disable
FortiLink VLAN optimization.
vdom
string
Default:
"root"
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.

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_switch_controller_global
    fortios_switch_controller_global:
      vdom: root
      switch_controller_global:
        bounce_quarantined_link: disable
        https_image_push: enable
        log_mac_limit_violations: disable
        mac_aging_interval: 300
        mac_event_logging: disable
        mac_retention_period: 24
        mac_violation_timer: 0
        quarantine_mode: by-vlan
        sn_dns_resolution: enable
        update_user_device: mac-cache
        vlan_all_mode: defined
        vlan_optimization: enable

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

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)