Skip to content

Latest commit

 

History

History
1010 lines (965 loc) · 45.1 KB

fortios_firewall_sniffer.rst

File metadata and controls

1010 lines (965 loc) · 45.1 KB
Raw
source:fortios_firewall_sniffer.py
orphan:

fortios_firewall_sniffer -- Configure sniffer in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_sniffer v6.0.0 -> latest

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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_sniffer - Configure sniffer. type: dict more...
    Supported Version Ranges
    firewall_sniffer v6.0.0 -> latest
    • anomaly - Configuration method to edit Denial of Service (DoS) anomaly settings. type: list member_path: anomaly:name more...
      Supported Version Ranges
      anomaly v6.0.0 -> latest
      • action - Action taken when the threshold is reached. type: str choices: pass, block, proxy more...
        Supported Version Ranges
        action v6.0.0 -> latest
        [pass] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [proxy] v6.0.0 -> latest
      • log - Enable/disable anomaly logging. type: str choices: enable, disable more...
        Supported Version Ranges
        log v6.0.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • name - Anomaly name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
      • quarantine - Quarantine method. type: str choices: none, attacker more...
        Supported Version Ranges
        quarantine v6.0.0 -> latest
        [none] v6.0.0 -> latest
        [attacker] v6.0.0 -> latest
      • quarantine_expiry - Duration of quarantine. (Format type: str more...
        Supported Version Ranges
        quarantine_expiry v6.0.0 -> latest
      • quarantine_log - Enable/disable quarantine logging. type: str choices: disable, enable more...
        Supported Version Ranges
        quarantine_log v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • status - Enable/disable this anomaly. type: str choices: disable, enable more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • threshold - Anomaly threshold. Number of detected instances (packets per second or concurrent session number) that triggers the anomaly action. type: int more...
        Supported Version Ranges
        threshold v6.0.0 -> latest
      • threshold_default - Number of detected instances per minute which triggers action (1 - 2147483647). Note that each anomaly has a different threshold value assigned to it. type: int more...
        Supported Version Ranges
        threshold_default v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
    • application_list - Name of an existing application list. Source application.list.name. type: str more...
      Supported Version Ranges
      application_list v6.0.0 -> latest
    • application_list_status - Enable/disable application control profile. type: str choices: enable, disable more...
      Supported Version Ranges
      application_list_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • av_profile - Name of an existing antivirus profile. Source antivirus.profile.name. type: str more...
      Supported Version Ranges
      av_profile v6.0.0 -> latest
    • av_profile_status - Enable/disable antivirus profile. type: str choices: enable, disable more...
      Supported Version Ranges
      av_profile_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • casb_profile - Name of an existing CASB profile. Source casb.profile.name. type: str more...
      Supported Version Ranges
      casb_profile v7.4.1 -> latest
    • casb_profile_status - Enable/disable CASB profile. type: str choices: enable, disable more...
      Supported Version Ranges
      casb_profile_status v7.4.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • dlp_profile - Name of an existing DLP profile. Source dlp.profile.name. type: str more...
      Supported Version Ranges
      dlp_profile v7.2.0 -> latest
    • dlp_profile_status - Enable/disable DLP profile. type: str choices: enable, disable more...
      Supported Version Ranges
      dlp_profile_status v7.2.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
      Supported Version Ranges
      dlp_sensor v6.0.0 -> v7.0.12
    • dlp_sensor_status - Enable/disable DLP sensor. type: str choices: enable, disable more...
      Supported Version Ranges
      dlp_sensor_status v6.0.0 -> v7.0.12
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • dsri - Enable/disable DSRI. type: str choices: enable, disable more...
      Supported Version Ranges
      dsri v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
      Supported Version Ranges
      emailfilter_profile v6.2.0 -> latest
    • emailfilter_profile_status - Enable/disable emailfilter. type: str choices: enable, disable more...
      Supported Version Ranges
      emailfilter_profile_status v6.2.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str more...
      Supported Version Ranges
      file_filter_profile v7.0.0 -> latest
    • file_filter_profile_status - Enable/disable file filter. type: str choices: enable, disable more...
      Supported Version Ranges
      file_filter_profile_status v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • host - Hosts to filter for in sniffer traffic (Format examples: 1.1.1.1, 2.2.2.0/24, 3.3.3.3/255.255.255.0, 4.4.4.0-4.4.4.240). type: str more...
      Supported Version Ranges
      host v6.0.0 -> v7.0.12 v7.2.1 -> latest
    • id - Sniffer ID (0 - 9999). see Notes. type: int required: true more...
      Supported Version Ranges
      id v6.0.0 -> latest
    • interface - Interface name that traffic sniffing will take place on. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.0.0 -> latest
    • ip_threatfeed - Name of an existing IP threat feed. type: list member_path: ip_threatfeed:name more...
      Supported Version Ranges
      ip_threatfeed v7.0.0 -> latest
      • name - Threat feed name. Source system.external-resource.name. type: str required: true more...
        Supported Version Ranges
        name v7.0.0 -> latest
    • ip_threatfeed_status - Enable/disable IP threat feed. type: str choices: enable, disable more...
      Supported Version Ranges
      ip_threatfeed_status v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ips_dos_status - Enable/disable IPS DoS anomaly detection. type: str choices: enable, disable more...
      Supported Version Ranges
      ips_dos_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
      Supported Version Ranges
      ips_sensor v6.0.0 -> latest
    • ips_sensor_status - Enable/disable IPS sensor. type: str choices: enable, disable more...
      Supported Version Ranges
      ips_sensor_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ipv6 - Enable/disable sniffing IPv6 packets. type: str choices: enable, disable more...
      Supported Version Ranges
      ipv6 v6.0.0 -> v7.0.12 v7.2.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • logtraffic - Either log all sessions, only sessions that have a security profile applied, or disable all logging for this policy. type: str choices: all, utm, disable more...
      Supported Version Ranges
      logtraffic v6.0.0 -> latest
      [all] v6.0.0 -> latest
      [utm] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • max_packet_count - Maximum packet count (1 - 1000000). type: int more...
      Supported Version Ranges
      max_packet_count v6.0.0 -> v7.0.12
    • non_ip - Enable/disable sniffing non-IP packets. type: str choices: enable, disable more...
      Supported Version Ranges
      non_ip v6.0.0 -> v7.0.12 v7.2.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • port - Ports to sniff (Format examples: 10, :20, 30:40, 50-, 100-200). type: str more...
      Supported Version Ranges
      port v6.0.0 -> v7.0.12 v7.2.1 -> latest
    • protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: str more...
      Supported Version Ranges
      protocol v6.0.0 -> v7.0.12 v7.2.1 -> latest
    • scan_botnet_connections - Enable/disable scanning of connections to Botnet servers. type: str choices: disable, block, monitor more...
      Supported Version Ranges
      scan_botnet_connections v6.0.0 -> v6.0.11
      [disable] v6.0.0 -> latest
      [block] v6.0.0 -> latest
      [monitor] v6.0.0 -> latest
    • spamfilter_profile - Name of an existing spam filter profile. Source spamfilter.profile.name. type: str more...
      Supported Version Ranges
      spamfilter_profile v6.0.0 -> v6.0.11
    • spamfilter_profile_status - Enable/disable spam filter. type: str choices: enable, disable more...
      Supported Version Ranges
      spamfilter_profile_status v6.0.0 -> v6.0.11
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • status - Enable/disable the active status of the sniffer. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • vlan - List of VLANs to sniff. type: str more...
      Supported Version Ranges
      vlan v6.0.0 -> v7.0.12 v7.2.1 -> latest
    • webfilter_profile - Name of an existing web filter profile. Source webfilter.profile.name. type: str more...
      Supported Version Ranges
      webfilter_profile v6.0.0 -> latest
    • webfilter_profile_status - Enable/disable web filter profile. type: str choices: enable, disable more...
      Supported Version Ranges
      webfilter_profile_status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure sniffer.
  fortinet.fortios.fortios_firewall_sniffer:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_sniffer:
          anomaly:
              -
                  action: "pass"
                  log: "enable"
                  name: "default_name_6"
                  quarantine: "none"
                  quarantine_expiry: "<your_own_value>"
                  quarantine_log: "disable"
                  status: "disable"
                  threshold: "0"
                  threshold_default: "0"
          application_list: "<your_own_value> (source application.list.name)"
          application_list_status: "enable"
          av_profile: "<your_own_value> (source antivirus.profile.name)"
          av_profile_status: "enable"
          casb_profile: "<your_own_value> (source casb.profile.name)"
          casb_profile_status: "enable"
          dlp_profile: "<your_own_value> (source dlp.profile.name)"
          dlp_profile_status: "enable"
          dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
          dlp_sensor_status: "enable"
          dsri: "enable"
          emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
          emailfilter_profile_status: "enable"
          file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
          file_filter_profile_status: "enable"
          host: "myhostname"
          id: "29"
          interface: "<your_own_value> (source system.interface.name)"
          ip_threatfeed:
              -
                  name: "default_name_32 (source system.external-resource.name)"
          ip_threatfeed_status: "enable"
          ips_dos_status: "enable"
          ips_sensor: "<your_own_value> (source ips.sensor.name)"
          ips_sensor_status: "enable"
          ipv6: "enable"
          logtraffic: "all"
          max_packet_count: "4000"
          non_ip: "enable"
          port: "<your_own_value>"
          protocol: "<your_own_value>"
          scan_botnet_connections: "disable"
          spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
          spamfilter_profile_status: "enable"
          status: "enable"
          vlan: "<your_own_value>"
          webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
          webfilter_profile_status: "enable"

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

Status

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

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.