fortinet.fortios.fortios_system_switch_interface module – Configure software switch interfaces by grouping physical and WiFi interfaces 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_system_switch_interface
.
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 system feature and switch_interface 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:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure software switch interfaces by grouping physical and WiFi interfaces. |
|
Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Choices:
|
|
Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec). |
|
Names of the interfaces that belong to the virtual switch. |
|
Interface name. Source system.interface.name. |
|
Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links). |
|
Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Choices:
|
|
SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port. Source system.interface.name. |
|
The direction in which the SPAN port operates, either: rx, tx, or both. Choices:
|
|
Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. |
|
Physical interface name. Source system.interface.name. |
|
Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Choices:
|
|
VDOM that the software switch belongs to. Source system.vdom.name. |
|
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 software switch interfaces by grouping physical and WiFi interfaces.
fortinet.fortios.fortios_system_switch_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_switch_interface:
intra_switch_policy: "implicit"
mac_ttl: "300"
member:
-
interface_name: "<your_own_value> (source system.interface.name)"
name: "default_name_7"
span: "disable"
span_dest_port: "<your_own_value> (source system.interface.name)"
span_direction: "rx"
span_source_port:
-
interface_name: "<your_own_value> (source system.interface.name)"
type: "switch"
vdom: "<your_own_value> (source system.vdom.name)"
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: |