ansible.builtin.fortios_system_switch_interface (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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)"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_switch_interface:
    default: null
    description:
    - Configure software switch interfaces by grouping physical and WiFi interfaces.
    suboptions:
      intra_switch_policy:
        choices:
        - implicit
        - explicit
        description:
        - Allow any traffic between switch interfaces or require firewall policies to
          allow traffic between switch interfaces.
        type: str
      member:
        description:
        - Names of the interfaces that belong to the virtual switch.
        suboptions:
          interface_name:
            description:
            - Physical interface name. Source system.interface.name.
            type: str
        type: list
      name:
        description:
        - Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM
          links).
        required: true
        type: str
      span:
        choices:
        - disable
        - enable
        description:
        - Enable/disable port spanning. Port spanning echoes traffic received by the software
          switch to the span destination port.
        type: str
      span_dest_port:
        description:
        - 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:
        choices:
        - rx
        - tx
        - both
        description:
        - 'The direction in which the SPAN port operates, either: rx, tx, or both.'
        type: str
      span_source_port:
        description:
        - Physical interface name. Port spanning echoes all traffic on the SPAN source
          ports to the SPAN destination port.
        suboptions:
          interface_name:
            description:
            - Physical interface name. Source system.interface.name.
            type: str
        type: list
      type:
        choices:
        - switch
        - hub
        description:
        - 'Type of switch based on functionality: switch for normal functionality, or
          hub to duplicate packets to all port members.'
        type: str
      vdom:
        description:
        - VDOM that the software switch belongs to. Source system.vdom.name.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str