fortios_system_switch_interface – Configure software switch interfaces by grouping physical and WiFi interfaces in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_switch_interface - Configure software switch interfaces by grouping physical and WiFi interfaces. type: dict
- intra_switch_policy - Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. type: str choices: implicit, explicit
- member - Names of the interfaces that belong to the virtual switch. type: list
- interface_name - Physical interface name. Source system.interface.name. type: str
- name - Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links). type: str required: True
- span - Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. type: str choices: disable, enable
- span_dest_port - SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port. Source system.interface.name. type: str
- span_direction - The direction in which the SPAN port operates, either: rx, tx, or both. type: str choices: rx, tx, both
- span_source_port - Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. type: list
- interface_name - Physical interface name. Source system.interface.name. type: str
- type - Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. type: str choices: switch, hub
- vdom - VDOM that the software switch belongs to. Source system.vdom.name. type: str
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 software switch interfaces by grouping physical and WiFi interfaces.
fortios_system_switch_interface:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_switch_interface:
intra_switch_policy: "implicit"
member:
-
interface_name: "<your_own_value> (source system.interface.name)"
name: "default_name_6"
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3