fortinet.fortios.fortios_switch_controller_system – Configure system-wide switch controller settings in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.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.

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

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 system 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.
switch_controller_system
dictionary
Configure system-wide switch controller settings.
data_sync_interval
integer
Time interval between collection of switch data (30 - 1800 sec).
dynamic_periodic_interval
integer
Periodic time interval to run Dynamic port policy engine (5 - 60 sec).
iot_holdoff
integer
MAC entry"s creation time. Time must be greater than this value for an entry to be created (0 - 10080 mins).
iot_mac_idle
integer
MAC entry"s idle time. MAC entry is removed after this value (0 - 10080 mins).
iot_scan_interval
integer
IoT scan interval (2 - 10080 mins).
iot_weight_threshold
integer
MAC entry"s confidence value. Value is re-queried when below this value .
nac_periodic_interval
integer
Periodic time interval to run NAC engine (5 - 60 sec).
parallel_process
integer
Maximum number of parallel processes (1 - 300).
parallel_process_override
string
    Choices:
  • disable
  • enable
Enable/disable parallel process override.
tunnel_mode
string
    Choices:
  • compatible
  • strict
Compatible/strict tunnel mode.
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

- 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 system-wide switch controller settings.
    fortios_switch_controller_system:
      vdom:  "{{ vdom }}"
      switch_controller_system:
        data_sync_interval: "3"
        dynamic_periodic_interval: "4"
        iot_holdoff: "5"
        iot_mac_idle: "6"
        iot_scan_interval: "7"
        iot_weight_threshold: "8"
        nac_periodic_interval: "9"
        parallel_process: "10"
        parallel_process_override: "disable"
        tunnel_mode: "compatible"

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_system_module.html