fortinet / fortinet.fortios / 1.1.7 / module / fortios_switch_controller_traffic_sniffer Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters in Fortinet's FortiOS and FortiGate. | "added in version" 2.9 of fortinet.fortios" Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityfortinet.fortios.fortios_switch_controller_traffic_sniffer (1.1.7) — module
Install with ansible-galaxy collection install fortinet.fortios:==1.1.7
collections: - name: fortinet.fortios version: 1.1.7
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.4.0
- 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>" ip: "<your_own_value>" target_mac: - description: "<your_own_value>" mac: "<your_own_value>" target_port: - description: "<your_own_value>" in_ports: - name: "default_name_14" out_ports: - name: "default_name_16" switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
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 access_token: description: - Token-based authentication. Generated from GUI of Fortigate. required: false type: str switch_controller_traffic_sniffer: default: null description: - Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters. suboptions: erspan_ip: description: - Configure ERSPAN collector IP address. type: str mode: choices: - erspan-auto - rspan - none description: - Configure traffic sniffer mode. type: str target_ip: description: - Sniffer IPs to filter. suboptions: description: description: - Description for the sniffer IP. type: str ip: description: - Sniffer IP. required: true type: str type: list target_mac: description: - Sniffer MACs to filter. suboptions: description: description: - Description for the sniffer MAC. type: str mac: description: - Sniffer MAC. required: true type: str type: list target_port: description: - Sniffer ports to filter. suboptions: description: description: - Description for the sniffer port entry. type: str in_ports: description: - Configure source ingress port interfaces. suboptions: name: description: - Interface name. required: true type: str type: list out_ports: description: - Configure source egress port interfaces. suboptions: name: description: - Interface name. required: true type: str type: list switch_id: description: - Managed-switch ID. Source switch-controller.managed-switch.switch-id. type: str type: list type: dict
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