fmgr_dlp_sensor – Configure DLP sensors.

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
dlp_sensor yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • dlp_sensor - no description type: dict
    • comment - Comment. type: str more...
    • dlp-log - Enable/disable DLP logging. type: str choices: [disable, enable] more...
    • extended-log - Enable/disable extended logging for data leak prevention. type: str choices: [disable, enable] more...
    • filter - Filter. type: array 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 - Enter a company identifier watermark to match. type: str more...
      • expiry - Quarantine duration in days, hours, minutes format (dddhhmm). type: str more...
      • file-size - Match files this size or larger (0 - 4294967295 kbytes). type: int more...
      • file-type - Select the number of a DLP file pattern table to match. type: str more...
      • filter-by - Select the type of content to match. type: str choices: [credit-card, ssn, regexp, file-type, file-size, fingerprint, watermark, encrypted] more...
      • fp-sensitivity - Select a DLP file pattern sensitivity to match. type: str more...
      • id - ID. type: int more...
      • 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: array 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: str more...
    • flow-based - Enable/disable flow-based DLP. type: str choices: [disable, enable] more...
    • full-archive-proto - Protocols to always content archive. type: array 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 - 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 - Replacement message group used by this DLP sensor. type: str more...
    • summary-proto - Protocols to always log summary. type: array choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post, ssh, cifs] more...
    • feature-set - Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • entries - No description for the parameter type: array 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 - 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     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: <value in [present, absent]>
        dlp_sensor:
           comment: <value of 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: <value of string>
                 expiry: <value of string>
                 file-size: <value of integer>
                 file-type: <value of string>
                 filter-by: <value in [credit-card, ssn, regexp, ...]>
                 fp-sensitivity: <value of string>
                 id: <value of integer>
                 match-percentage: <value of integer>
                 name: <value of string>
                 proto:
                   - imap
                   - smtp
                   - pop3
                   - ftp
                   - nntp
                   - mm1
                   - mm3
                   - mm4
                   - mm7
                   - mapi
                   - aim
                   - icq
                   - msn
                   - yahoo
                   - http-get
                   - http-post
                   - ssh
                   - cifs
                 regexp: <value of string>
                 severity: <value in [info, low, medium, ...]>
                 type: <value in [file, message]>
                 sensitivity: <value of 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: <value of string>
           options: <value in [strict-file]>
           replacemsg-group: <value of 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: <value of integer>
                 dictionary: <value of string>
                 id: <value of integer>
                 status: <value in [disable, enable]>
           eval: <value of 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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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