W3cubDocs

/Ansible

fortinet.fortios.fortios_switch_controller_traffic_sniffer – Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_traffic_sniffer.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and traffic_sniffer 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

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
switch_controller_traffic_sniffer
dictionary
Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
erspan_ip
string
Configure ERSPAN collector IP address.
mode
string
    Choices:
  • erspan-auto
  • rspan
  • none
Configure traffic sniffer mode.
target_ip
list / elements=string
Sniffer IPs to filter.
description
string
Description for the sniffer IP.
dst_entry_id
integer
FortiSwitch dest entry ID for the sniffer IP.
ip
string / required
Sniffer IP.
src_entry_id
integer
FortiSwitch source entry ID for the sniffer IP.
target_mac
list / elements=string
Sniffer MACs to filter.
description
string
Description for the sniffer MAC.
dst_entry_id
integer
FortiSwitch dest entry ID for the sniffer MAC.
mac
string / required
Sniffer MAC.
src_entry_id
integer
FortiSwitch source entry ID for the sniffer MAC.
target_port
list / elements=string
Sniffer ports to filter.
description
string
Description for the sniffer port entry.
in_ports
list / elements=string
Configure source ingress port interfaces.
name
string / required
Interface name.
out_ports
list / elements=string
Configure source egress port interfaces.
name
string / required
Interface name.
switch_id
string
Managed-switch ID. Source switch-controller.managed-switch.switch-id.
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

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

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 FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
    fortios_switch_controller_traffic_sniffer:
      vdom:  "{{ vdom }}"
      switch_controller_traffic_sniffer:
        erspan_ip: "<your_own_value>"
        mode: "erspan-auto"
        target_ip:
         -
            description: "<your_own_value>"
            dst_entry_id: "7"
            ip: "<your_own_value>"
            src_entry_id: "9"
        target_mac:
         -
            description: "<your_own_value>"
            dst_entry_id: "12"
            mac: "<your_own_value>"
            src_entry_id: "14"
        target_port:
         -
            description: "<your_own_value>"
            in_ports:
             -
                name: "default_name_18"
            out_ports:
             -
                name: "default_name_20"
            switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"

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


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_traffic_sniffer_module.html