fortinet.fortimanager.fmgr_dlp_sensor module – Configure DLP sensors.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_dlp_sensor.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

dlp_sensor

dictionary

The top level parameters set.

comment

string

Comment.

dlp-log

string

Deprecated, please rename it to dlp_log. Enable/disable DLP logging.

Choices:

  • "disable"

  • "enable"

entries

list / elements=dictionary

Entries.

count

integer

Count of dictionary matches to trigger sensor entry match

dictionary

string

Select a DLP dictionary.

id

integer

ID.

status

string

Enable/disable this entry.

Choices:

  • "disable"

  • "enable"

eval

string

Expression to evaluate.

extended-log

string

Deprecated, please rename it to extended_log. Enable/disable extended logging for data leak prevention.

Choices:

  • "disable"

  • "enable"

feature-set

string

Deprecated, please rename it to feature_set. Flow/proxy feature set.

Choices:

  • "proxy"

  • "flow"

fgd-id

integer

Deprecated, please rename it to fgd_id. ID of object in FortiGuard database.

filter

list / elements=dictionary

Filter.

action

string

Action to take with content that this DLP sensor matches.

Choices:

  • "log-only"

  • "block"

  • "exempt"

  • "ban"

  • "ban-sender"

  • "quarantine-ip"

  • "quarantine-port"

  • "none"

  • "allow"

archive

string

Enable/disable DLP archiving.

Choices:

  • "disable"

  • "enable"

  • "summary-only"

company-identifier

string

Deprecated, please rename it to company_identifier. Enter a company identifier watermark to match.

expiry

string

Quarantine duration in days, hours, minutes format

file-size

integer

Deprecated, please rename it to file_size. Match files this size or larger

file-type

string

Deprecated, please rename it to file_type. Select the number of a DLP file pattern table to match.

filter-by

string

Deprecated, please rename it to filter_by. Select the type of content to match.

Choices:

  • "credit-card"

  • "ssn"

  • "regexp"

  • "file-type"

  • "file-size"

  • "fingerprint"

  • "watermark"

  • "encrypted"

  • "file-type-and-size"

fp-sensitivity

any

(list or str) Deprecated, please rename it to fp_sensitivity. Select a DLP file pattern sensitivity to match.

id

integer

ID.

match-percentage

integer

Deprecated, please rename it to match_percentage. Percentage of fingerprints in the fingerprint databases designat…

name

string

Filter name.

proto

list / elements=string

Check messages or files over one or more of these protocols.

Choices:

  • "imap"

  • "smtp"

  • "pop3"

  • "ftp"

  • "nntp"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

  • "mapi"

  • "aim"

  • "icq"

  • "msn"

  • "yahoo"

  • "http-get"

  • "http-post"

  • "ssh"

  • "cifs"

regexp

string

Enter a regular expression to match

sensitivity

any

(list or str) Select a DLP file pattern sensitivity to match.

severity

string

Select the severity or threat level that matches this filter.

Choices:

  • "info"

  • "low"

  • "medium"

  • "high"

  • "critical"

type

string

Select whether to check the content of messages

Choices:

  • "file"

  • "message"

flow-based

string

Deprecated, please rename it to flow_based. Enable/disable flow-based DLP.

Choices:

  • "disable"

  • "enable"

full-archive-proto

list / elements=string

Deprecated, please rename it to full_archive_proto. Protocols to always content archive.

Choices:

  • "imap"

  • "smtp"

  • "pop3"

  • "ftp"

  • "nntp"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

  • "mapi"

  • "aim"

  • "icq"

  • "msn"

  • "yahoo"

  • "http-get"

  • "http-post"

  • "ssh"

  • "cifs"

match-type

string

Deprecated, please rename it to match_type. Logical relation between entries

Choices:

  • "match-all"

  • "match-any"

  • "match-eval"

nac-quar-log

string

Deprecated, please rename it to nac_quar_log. Enable/disable NAC quarantine logging.

Choices:

  • "disable"

  • "enable"

name

string / required

Name of the DLP sensor.

options

string

Configure DLP options.

Choices:

  • "strict-file"

replacemsg-group

string

Deprecated, please rename it to replacemsg_group. Replacement message group used by this DLP sensor.

summary-proto

list / elements=string

Deprecated, please rename it to summary_proto. Protocols to always log summary.

Choices:

  • "imap"

  • "smtp"

  • "pop3"

  • "ftp"

  • "nntp"

  • "mm1"

  • "mm3"

  • "mm4"

  • "mm7"

  • "mapi"

  • "aim"

  • "icq"

  • "msn"

  • "yahoo"

  • "http-get"

  • "http-post"

  • "ssh"

  • "cifs"

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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]>
          fgd_id: <integer>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)