fortios_switch_controller_traffic_sniffer – Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters 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 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
FortiOS Version Compatibility¶
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_switch_controller_traffic_sniffer | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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
- switch_controller_traffic_sniffer - Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters. type: dict more...
- erspan_ip - Configure ERSPAN collector IP address. type: str more...
- mode - Configure traffic sniffer mode. type: str choices: erspan-auto, rspan, none more...
- target_ip - Sniffer IPs to filter. type: list more...
- description - Description for the sniffer IP. type: str more...
- dst_entry_id - FortiSwitch dest entry ID for the sniffer IP. type: int more...
- ip - Sniffer IP. type: str more...
- src_entry_id - FortiSwitch source entry ID for the sniffer IP. type: int more...
- target_mac - Sniffer MACs to filter. type: list more...
- description - Description for the sniffer MAC. type: str more...
- dst_entry_id - FortiSwitch dest entry ID for the sniffer MAC. type: int more...
- mac - Sniffer MAC. type: str more...
- src_entry_id - FortiSwitch source entry ID for the sniffer MAC. type: int more...
- target_port - Sniffer ports to filter. type: list more...
- description - Description for the sniffer port entry. type: str more...
- in_ports - Configure source ingress port interfaces. type: list more...
- name - Interface name. type: str more...
- out_ports - Configure source egress port interfaces. type: list more...
- name - Interface name. type: str more...
- switch_id - Managed-switch ID. Source switch-controller.managed-switch.switch-id. type: str more...
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: "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)"
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