fortios_system_switch_interface – Configure software switch interfaces by grouping physical and WiFi interfaces in Fortinet’s FortiOS and FortiGate.

New in version 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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: 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
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • 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 more...
    • intra_switch_policy - Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. type: str choices: implicit, explicit more...
    • mac_ttl - Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec). type: int more...
    • member - Names of the interfaces that belong to the virtual switch. type: list member_path: member:interface_name more...
      • interface_name - Physical interface name. Source system.interface.name. type: str required: true more...
    • name - Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links). type: str required: true more...
    • span - Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. type: str choices: disable, enable more...
    • 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 more...
    • span_direction - The direction in which the SPAN port operates, either: rx, tx, or both. type: str choices: rx, tx, both more...
    • span_source_port - Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. type: list member_path: span_source_port:interface_name more...
      • interface_name - Physical interface name. Source system.interface.name. type: str required: true more...
    • 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 more...
    • vdom - VDOM that the software switch belongs to. Source system.vdom.name. type: str more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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: 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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.