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.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host string | FortiOS or FortiGate IP address. | |||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | ||
password string | Default: "" | FortiOS or FortiGate password. | ||
ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
system_switch_interface dictionary | Default: null | Configure software switch interfaces by grouping physical and WiFi interfaces. | ||
intra_switch_policy string |
| Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. | ||
member list | Names of the interfaces that belong to the virtual switch. | |||
interface_name string | Physical interface name. Source system.interface.name. | |||
name string / required | Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links). | |||
span string |
| Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. | ||
span_dest_port string | SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port. Source system.interface.name. | |||
span_direction string |
| The direction in which the SPAN port operates, either: rx, tx, or both. | ||
span_source_port list | Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. | |||
interface_name string | Physical interface name. Source system.interface.name. | |||
type string |
| Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. | ||
vdom string | VDOM that the software switch belongs to. Source system.vdom.name. | |||
username string | FortiOS or FortiGate username. | |||
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
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure software switch interfaces by grouping physical and WiFi interfaces. fortios_system_switch_interface: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" 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 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 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_switch_interface_module.html