fmgr_dlp_sensor – Configure DLP sensors.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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 v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> 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
  • adom - The parameter in requested url type: str required: true
  • dlp_sensor - Configure DLP sensors. type: dict
    • comment Comment. type: str more...
    • dlp_log (Alias name: dlp-log) Enable/disable dlp logging. type: str choices: [disable, enable] more...
    • extended_log (Alias name: extended-log) Enable/disable extended logging for data leak prevention. type: str choices: [disable, enable] more...
    • filter Filter. type: list more...
      • action Action to take with content that this dlp sensor matches. type: str choices: [log-only, block, exempt, ban, ban-sender, quarantine-ip, quarantine-port, none, allow] more...
      • archive Enable/disable dlp archiving. type: str choices: [disable, enable, summary-only] more...
      • company_identifier (Alias name: company-identifier) Enter a company identifier watermark to match. type: str more...
      • expiry Quarantine duration in days, hours, minutes format (dddhhmm). type: str more...
      • file_size (Alias name: file-size) Match files this size or larger (0 - 4294967295 kbytes). type: int more...
      • file_type (Alias name: file-type) Select the number of a dlp file pattern table to match. type: str more...
      • filter_by (Alias name: filter-by) Select the type of content to match. type: str choices: [credit-card, ssn, regexp, file-type, file-size, fingerprint, watermark, encrypted, file-type-and-size] more...
      • fp_sensitivity (Alias name: fp-sensitivity) Select a dlp file pattern sensitivity to match. type: list or str more...
      • id Id. type: int more...
      • match_percentage (Alias name: match-percentage) Percentage of fingerprints in the fingerprint databases designated with the selected fp-sensitivity to match. type: int more...
      • name Filter name. type: str more...
      • proto Check messages or files over one or more of these protocols. type: list choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post, ssh, cifs] more...
      • regexp Enter a regular expression to match (max. type: str more...
      • severity Select the severity or threat level that matches this filter. type: str choices: [info, low, medium, high, critical] more...
      • type Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). type: str choices: [file, message] more...
      • sensitivity Select a dlp file pattern sensitivity to match. type: list or str more...
    • flow_based (Alias name: flow-based) Enable/disable flow-based dlp. type: str choices: [disable, enable] more...
    • full_archive_proto (Alias name: full-archive-proto) Protocols to always content archive. type: list choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post, ssh, cifs] more...
    • nac_quar_log (Alias name: nac-quar-log) Enable/disable nac quarantine logging. type: str choices: [disable, enable] more...
    • name Name of the dlp sensor. type: str more...
    • options Configure dlp options. type: str choices: [strict-file] more...
    • replacemsg_group (Alias name: replacemsg-group) Replacement message group used by this dlp sensor. type: str more...
    • summary_proto (Alias name: summary-proto) Protocols to always log summary. type: list choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post, ssh, cifs] more...
    • feature_set (Alias name: feature-set) Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • entries type: list more...
      • count Count of dictionary matches to trigger sensor entry match (dictionary might not be able to trigger more than once based on its repeat option, 1 - 255, default = 1). type: int more...
      • dictionary Select a dlp dictionary. type: str more...
      • id Id. type: int more...
      • status Enable/disable this entry. type: str choices: [disable, enable] more...
    • eval Expression to evaluate. type: str more...
    • match_type (Alias name: match-type) Logical relation between entries (default = match-any). type: str choices: [match-all, match-any, match-eval] 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DLP sensors.
      fortinet.fortimanager.fmgr_dlp_sensor:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        dlp_sensor:
          comment: <string>
          dlp_log: <value in [disable, enable]>
          extended_log: <value in [disable, enable]>
          filter:
            -
              action: <value in [log-only, block, exempt, ...]>
              archive: <value in [disable, enable, summary-only]>
              company_identifier: <string>
              expiry: <string>
              file_size: <integer>
              file_type: <string>
              filter_by: <value in [credit-card, ssn, regexp, ...]>
              fp_sensitivity: <list or string>
              id: <integer>
              match_percentage: <integer>
              name: <string>
              proto:
                - imap
                - smtp
                - pop3
                - ftp
                - nntp
                - mm1
                - mm3
                - mm4
                - mm7
                - mapi
                - aim
                - icq
                - msn
                - yahoo
                - http-get
                - http-post
                - ssh
                - cifs
              regexp: <string>
              severity: <value in [info, low, medium, ...]>
              type: <value in [file, message]>
              sensitivity: <list or string>
          flow_based: <value in [disable, enable]>
          full_archive_proto:
            - imap
            - smtp
            - pop3
            - ftp
            - nntp
            - mm1
            - mm3
            - mm4
            - mm7
            - mapi
            - aim
            - icq
            - msn
            - yahoo
            - http-get
            - http-post
            - ssh
            - cifs
          nac_quar_log: <value in [disable, enable]>
          name: <string>
          options: <value in [strict-file]>
          replacemsg_group: <string>
          summary_proto:
            - imap
            - smtp
            - pop3
            - ftp
            - nntp
            - mm1
            - mm3
            - mm4
            - mm7
            - mapi
            - aim
            - icq
            - msn
            - yahoo
            - http-get
            - http-post
            - ssh
            - cifs
          feature_set: <value in [proxy, flow]>
          entries:
            -
              count: <integer>
              dictionary: <string>
              id: <integer>
              status: <value in [disable, enable]>
          eval: <string>
          match_type: <value in [match-all, match-any, match-eval]>

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)