Try SpotterConfigure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of lix_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 community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This 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
- 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: "2147483647"
ip: "<your_own_value>"
src_entry_id: "2147483647"
target_mac:
-
description: "<your_own_value>"
dst_entry_id: "2147483647"
mac: "<your_own_value>"
src_entry_id: "2147483647"
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)"
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
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
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.
elements: dict
suboptions:
description:
description:
- Description for the sniffer IP.
type: str
dst_entry_id:
description:
- FortiSwitch dest entry ID for the sniffer IP.
type: int
ip:
description:
- Sniffer IP.
type: str
src_entry_id:
description:
- FortiSwitch source entry ID for the sniffer IP.
type: int
type: list
target_mac:
description:
- Sniffer MACs to filter.
elements: dict
suboptions:
description:
description:
- Description for the sniffer MAC.
type: str
dst_entry_id:
description:
- FortiSwitch dest entry ID for the sniffer MAC.
type: int
mac:
description:
- Sniffer MAC.
type: str
src_entry_id:
description:
- FortiSwitch source entry ID for the sniffer MAC.
type: int
type: list
target_port:
description:
- Sniffer ports to filter.
elements: dict
suboptions:
description:
description:
- Description for the sniffer port entry.
type: str
in_ports:
description:
- Configure source ingress port interfaces.
elements: dict
suboptions:
name:
description:
- Interface name.
type: str
type: list
out_ports:
description:
- Configure source egress port interfaces.
elements: dict
suboptions:
name:
description:
- Interface name.
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