fortinet.fortimanager.fmgr_dlp_sensor module – Configure DLP sensors.

Note

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

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 version 2.10: of fortinet.fortimanager

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

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:

  • no ← (default)

  • yes

dlp_sensor

dictionary

the top level parameters set

comment

string

Comment.

dlp-log

string

Enable/disable DLP logging.

Choices:

  • disable

  • enable

extended-log

string

Enable/disable extended logging for data leak prevention.

Choices:

  • disable

  • enable

feature-set

string

Flow/proxy feature set.

Choices:

  • proxy

  • flow

filter

list / elements=string

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

Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched.

expiry

string

Quarantine duration in days, hours, minutes format (dddhhmm).

file-size

integer

Match files this size or larger (0 - 4294967295 kbytes).

file-type

string

Select the number of a DLP file pattern table to match.

filter-by

string

Select the type of content to match.

Choices:

  • credit-card

  • ssn

  • regexp

  • file-type

  • file-size

  • fingerprint

  • watermark

  • encrypted

fp-sensitivity

string

Select a DLP file pattern sensitivity to match.

id

integer

ID.

match-percentage

integer

Percentage of fingerprints in the fingerprint databases designated with the selected fp-sensitivity to match.

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 (max. 255 characters).

sensitivity

string

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 (an email message) or files (downloaded files or email attachments).

Choices:

  • file

  • message

flow-based

string

Enable/disable flow-based DLP.

Choices:

  • disable

  • enable

full-archive-proto

list / elements=string

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

nac-quar-log

string

Enable/disable NAC quarantine logging.

Choices:

  • disable

  • enable

name

string

Name of the DLP sensor.

options

string

Configure DLP options.

Choices:

  • strict-file

replacemsg-group

string

Replacement message group used by this DLP sensor.

summary-proto

list / elements=string

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:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

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

rc_succeeded

list / elements=string

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

  • 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: Configure DLP sensors.
     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]>

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)