fmgd_firewall_sniffer – Configure sniffer.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • firewall_sniffer - Configure sniffer. type: dict
    • anomaly Anomaly. type: list more...
      • action Action taken when the threshold is reached. type: str choices: [pass, block, proxy] more...
      • log Enable/disable anomaly logging. type: str choices: [disable, enable] more...
      • name Anomaly name. type: str more...
      • quarantine Quarantine method. type: str choices: [none, attacker, both, interface] more...
      • quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine. type: str more...
      • quarantine_log (Alias name: quarantine-log) Enable/disable quarantine logging. type: str choices: [disable, enable] more...
      • status Enable/disable this anomaly. type: str choices: [disable, enable] more...
      • synproxy_tcp_mss (Alias name: synproxy-tcp-mss) Determine tcp maximum segment size (mss) value for packets replied by syn proxy module. type: str choices: [0, 256, 512, 1024, 1300, 1360, 1460, 1500] more...
      • synproxy_tcp_sack (Alias name: synproxy-tcp-sack) Enable/disable tcp selective acknowledage (sack) for packets replied by syn proxy module. type: str choices: [disable, enable] more...
      • synproxy_tcp_timestamp (Alias name: synproxy-tcp-timestamp) Enable/disable tcp timestamp option for packets replied by syn proxy module. type: str choices: [disable, enable] more...
      • synproxy_tcp_window (Alias name: synproxy-tcp-window) Determine tcp window size for packets replied by syn proxy module. type: str choices: [4096, 8192, 16384, 32768] more...
      • synproxy_tcp_windowscale (Alias name: synproxy-tcp-windowscale) Determine tcp window scale option value for packets replied by syn proxy module. type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14] more...
      • synproxy_tos (Alias name: synproxy-tos) Determine tcp differentiated services code point value (type of service). type: str choices: [0, 10, 12, 14, 18, 20, 22, 26, 28, 30, 34, 36, 38, 40, 46, 255] more...
      • synproxy_ttl (Alias name: synproxy-ttl) Determine time to live (ttl) value for packets replied by syn proxy module. type: str choices: [32, 64, 128, 255] more...
      • threshold Anomaly threshold. type: int more...
      • threshold_default (Alias name: threshold(default)) Threshold(default). type: int more...
    • application_list (Alias name: application-list) Name of an existing application list. type: list more...
    • application_list_status (Alias name: application-list-status) Enable/disable application control profile. type: str choices: [disable, enable] more...
    • av_profile (Alias name: av-profile) Name of an existing antivirus profile. type: list more...
    • av_profile_status (Alias name: av-profile-status) Enable/disable antivirus profile. type: str choices: [disable, enable] more...
    • dlp_profile (Alias name: dlp-profile) Name of an existing dlp profile. type: list more...
    • dlp_profile_status (Alias name: dlp-profile-status) Enable/disable dlp profile. type: str choices: [disable, enable] more...
    • dsri Enable/disable dsri. type: str choices: [disable, enable] more...
    • emailfilter_profile (Alias name: emailfilter-profile) Name of an existing email filter profile. type: list more...
    • emailfilter_profile_status (Alias name: emailfilter-profile-status) Enable/disable emailfilter. type: str choices: [disable, enable] more...
    • file_filter_profile (Alias name: file-filter-profile) Name of an existing file-filter profile. type: list more...
    • file_filter_profile_status (Alias name: file-filter-profile-status) Enable/disable file filter. type: str choices: [disable, enable] more...
    • host Hosts to filter for in sniffer traffic (format examples: 1. type: str more...
    • id Sniffer id (0 - 9999). type: int more...
    • interface Interface name that traffic sniffing will take place on. type: list more...
    • ip_threatfeed (Alias name: ip-threatfeed) Name of an existing ip threat feed. type: list more...
    • ip_threatfeed_status (Alias name: ip-threatfeed-status) Enable/disable ip threat feed. type: str choices: [disable, enable] more...
    • ips_dos_status (Alias name: ips-dos-status) Enable/disable ips dos anomaly detection. type: str choices: [disable, enable] more...
    • ips_sensor (Alias name: ips-sensor) Name of an existing ips sensor. type: list more...
    • ips_sensor_status (Alias name: ips-sensor-status) Enable/disable ips sensor. type: str choices: [disable, enable] more...
    • ipv6 Enable/disable sniffing ipv6 packets. type: str choices: [disable, enable] more...
    • logtraffic Either log all sessions, only sessions that have a security profile applied, or disable all logging for this policy. type: str choices: [disable, all, utm] more...
    • non_ip (Alias name: non-ip) Enable/disable sniffing non-ip packets. type: str choices: [disable, enable] more...
    • port Ports to sniff (format examples: 10, :20, 30:40, 50-, 100-200). type: str more...
    • protocol Integer value for the protocol type as defined by iana (0 - 255). type: str more...
    • status Enable/disable the active status of the sniffer. type: str choices: [disable, enable] more...
    • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
    • vlan List of vlans to sniff. type: str more...
    • webfilter_profile (Alias name: webfilter-profile) Name of an existing web filter profile. type: list more...
    • webfilter_profile_status (Alias name: webfilter-profile-status) Enable/disable web filter profile. type: str choices: [disable, enable] more...
    • max_packet_count (Alias name: max-packet-count) Maximum packet count (1 - 1000000, default = 4000). type: int more...
    • dlp_sensor_status (Alias name: dlp-sensor-status) Enable/disable dlp sensor. type: str choices: [disable, enable] more...
    • dlp_sensor (Alias name: dlp-sensor) Name of an existing dlp sensor. type: list more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure sniffer.
      fortinet.fmgdevice.fmgd_firewall_sniffer:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        firewall_sniffer:
          id: 0 # Required variable, integer
          # anomaly:
          #   - action: <value in [pass, block, proxy]>
          #     log: <value in [disable, enable]>
          #     name: <string>
          #     quarantine: <value in [none, attacker, both, ...]>
          #     quarantine_expiry: <string>
          #     quarantine_log: <value in [disable, enable]>
          #     status: <value in [disable, enable]>
          #     synproxy_tcp_mss: <value in [0, 256, 512, ...]>
          #     synproxy_tcp_sack: <value in [disable, enable]>
          #     synproxy_tcp_timestamp: <value in [disable, enable]>
          #     synproxy_tcp_window: <value in [4096, 8192, 16384, ...]>
          #     synproxy_tcp_windowscale: <value in [0, 1, 2, ...]>
          #     synproxy_tos: <value in [0, 10, 12, ...]>
          #     synproxy_ttl: <value in [32, 64, 128, ...]>
          #     threshold: <integer>
          #     threshold_default: <integer>
          # application_list: <list or string>
          # application_list_status: <value in [disable, enable]>
          # av_profile: <list or string>
          # av_profile_status: <value in [disable, enable]>
          # dlp_profile: <list or string>
          # dlp_profile_status: <value in [disable, enable]>
          # dsri: <value in [disable, enable]>
          # emailfilter_profile: <list or string>
          # emailfilter_profile_status: <value in [disable, enable]>
          # file_filter_profile: <list or string>
          # file_filter_profile_status: <value in [disable, enable]>
          # host: <string>
          # interface: <list or string>
          # ip_threatfeed: <list or string>
          # ip_threatfeed_status: <value in [disable, enable]>
          # ips_dos_status: <value in [disable, enable]>
          # ips_sensor: <list or string>
          # ips_sensor_status: <value in [disable, enable]>
          # ipv6: <value in [disable, enable]>
          # logtraffic: <value in [disable, all, utm]>
          # non_ip: <value in [disable, enable]>
          # port: <string>
          # protocol: <string>
          # status: <value in [disable, enable]>
          # uuid: <string>
          # vlan: <string>
          # webfilter_profile: <list or string>
          # webfilter_profile_status: <value in [disable, enable]>
          # max_packet_count: <integer>
          # dlp_sensor_status: <value in [disable, enable]>
          # dlp_sensor: <list or string>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)