fortinet.fortios.fortios_switch_controller_global module – Configure FortiSwitch global settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.9).
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_global.
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 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.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 FortiSwitch global settings. |
|
Enable/disable multiple FortiLink interfaces for redundant connections between a managed FortiSwitch and FortiGate. Choices:
|
|
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. Choices:
|
|
List of custom commands to be pushed to all FortiSwitches in the VDOM. |
|
List of FortiSwitch commands. |
|
Name of custom command to push to all FortiSwitches in VDOM. Source switch-controller.custom-command.command-name. |
|
Default VLAN for ports when added to the virtual-switch. Source system.interface.name. |
|
List the parameters to be included to inform about client identification. Choices:
|
|
DHCP option-82 format string. Choices:
|
|
List the parameters to be included to inform about client identification. Choices:
|
|
Enable/disable DHCP snooping server access list. Choices:
|
|
Expiry time for DHCP snooping server database entries (300 - 259200 sec). |
|
Client DHCP packet broadcast mode. Choices:
|
|
Per Interface dhcp-server entries learn limit (0 - 1024). |
|
Prevent this FortiSwitch from discovering. |
|
Managed device ID. |
|
Enable/disable enforcement of FIPS on managed FortiSwitch devices. Choices:
|
|
Enable/disable automatic provisioning of latest firmware on authorization. Choices:
|
|
Enable/disable image push to FortiSwitch using HTTPS. Choices:
|
|
Enable/disable logs for Learning Limit Violations. Choices:
|
|
Time after which an inactive MAC is aged out (10 - 1000000 sec). |
|
Enable/disable MAC address event logging. Choices:
|
|
Time in hours after which an inactive MAC is removed from client DB (0 = aged out based on mac-aging-interval). |
|
Set timeout for Learning Limit Violations (0 = disabled). |
|
Quarantine mode. Choices:
|
|
Enable/disable DNS resolution of the FortiSwitch unit”s IP address with switch name. Choices:
|
|
Control which sources update the device user list. Choices:
|
|
VLAN configuration mode, user-defined-vlans or all-possible-vlans. Choices:
|
|
Identity of the VLAN. Commonly used for RADIUS Tunnel-Private-Group-Id. Choices:
|
|
FortiLink VLAN optimization. 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
The module supports check_mode.
Examples
- name: Configure FortiSwitch global settings.
fortinet.fortios.fortios_switch_controller_global:
vdom: "{{ vdom }}"
switch_controller_global:
allow_multiple_interfaces: "enable"
bounce_quarantined_link: "disable"
custom_command:
-
command_entry: "<your_own_value>"
command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
default_virtual_switch_vlan: "<your_own_value> (source system.interface.name)"
dhcp_option82_circuit_id: "intfname"
dhcp_option82_format: "ascii"
dhcp_option82_remote_id: "mac"
dhcp_server_access_list: "enable"
dhcp_snoop_client_db_exp: "86400"
dhcp_snoop_client_req: "drop-untrusted"
dhcp_snoop_db_per_port_learn_limit: "64"
disable_discovery:
-
name: "default_name_17"
fips_enforce: "disable"
firmware_provision_on_authorization: "enable"
https_image_push: "enable"
log_mac_limit_violations: "enable"
mac_aging_interval: "300"
mac_event_logging: "enable"
mac_retention_period: "24"
mac_violation_timer: "0"
quarantine_mode: "by-vlan"
sn_dns_resolution: "enable"
update_user_device: "mac-cache"
vlan_all_mode: "all"
vlan_identity: "description"
vlan_optimization: "enable"
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: |