fortinet.fortios.fortios_switch_controller_system module – Configure system-wide switch controller settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_system.
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 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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure system-wide switch controller settings. |
|
Echo interval for the caputp echo requests from swtp. |
|
Maximum retransmission count for the caputp tunnel packets. |
|
Time interval between collection of switch data (30 - 1800 sec). |
|
Periodic time interval to run Dynamic port policy engine (5 - 180 sec). |
|
MAC entry”s creation time. Time must be greater than this value for an entry to be created (0 - 10080 mins). |
|
MAC entry”s idle time. MAC entry is removed after this value (0 - 10080 mins). |
|
IoT scan interval (2 - 10080 mins). |
|
MAC entry”s confidence value. Value is re-queried when below this value . |
|
Periodic time interval to run NAC engine (5 - 180 sec). |
|
Maximum number of parallel processes. |
|
Enable/disable parallel process override. Choices:
|
|
Compatible/strict tunnel mode. Choices:
|
|
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
Examples
- name: Configure system-wide switch controller settings.
fortinet.fortios.fortios_switch_controller_system:
vdom: "{{ vdom }}"
switch_controller_system:
caputp_echo_interval: "30"
caputp_max_retransmit: "5"
data_sync_interval: "60"
dynamic_periodic_interval: "60"
iot_holdoff: "5"
iot_mac_idle: "1440"
iot_scan_interval: "60"
iot_weight_threshold: "1"
nac_periodic_interval: "60"
parallel_process: "1"
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 |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |