fortios_dlp_sensor – Configure DLP sensors in Fortinet’s FortiOS and FortiGate

From Get docs
Ansible/docs/2.8/modules/fortios dlp sensor module


fortios_dlp_sensor – Configure DLP sensors in Fortinet’s FortiOS and FortiGate

New in version 2.8.


Synopsis

  • This module is able to configure a FortiGate or FortiOS by allowing the user to configure dlp feature and sensor category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

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

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments

dlp_sensor

-

Default:

null

Configure DLP sensors.

comment

-

Comment.

dlp-log

-

  • enable
  • disable

Enable/disable DLP logging.

extended-log

-

  • enable
  • disable

Enable/disable extended logging for data leak prevention.

filter

-

Set up DLP filters for this sensor.

action

-

  • allow
  • log-only
  • block
  • quarantine-ip

Action to take with content that this DLP sensor matches.

archive

-

  • disable
  • enable

Enable/disable DLP archiving.

company-identifier

-

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

expiry

-

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

file-size

-

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

file-type

-

Select the number of a DLP file pattern table to match. Source dlp.filepattern.id.

filter-by

-

  • credit-card
  • ssn
  • regexp
  • file-type
  • file-size
  • fingerprint
  • watermark
  • encrypted

Select the type of content to match.

fp-sensitivity

-

Select a DLP file pattern sensitivity to match.

name

- / required

Select a DLP sensitivity. Source dlp.fp-sensitivity.name.

id

- / required

ID.

match-percentage

-

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

name

-

Filter name.

proto

-

  • smtp
  • pop3
  • imap
  • http-get
  • http-post
  • ftp
  • nntp
  • mapi
  • mm1
  • mm3
  • mm4
  • mm7

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

regexp

-

Enter a regular expression to match (max. 255 characters).

severity

-

  • info
  • low
  • medium
  • high
  • critical

Select the severity or threat level that matches this filter.

type

-

  • file
  • message

Select whether to check the content of messages (an email message) or files (downloaded files or email attachments).

flow-based

-

  • enable
  • disable

Enable/disable flow-based DLP.

full-archive-proto

-

  • smtp
  • pop3
  • imap
  • http-get
  • http-post
  • ftp
  • nntp
  • mapi
  • mm1
  • mm3
  • mm4
  • mm7

Protocols to always content archive.

nac-quar-log

-

  • enable
  • disable

Enable/disable NAC quarantine logging.

name

- / required

Name of the DLP sensor.

options

-

Configure DLP options.

replacemsg-group

-

Replacement message group used by this DLP sensor. Source system.replacemsg-group.name.

state

-

  • present
  • absent

Indicates whether to create or remove the object

summary-proto

-

  • smtp
  • pop3
  • imap
  • http-get
  • http-post
  • ftp
  • nntp
  • mapi
  • mm1
  • mm3
  • mm4
  • mm7

Protocols to always log summary.

host

- / required

FortiOS or FortiGate ip address.

https

boolean

  • no

  • yes

Indicates if the requests towards FortiGate must use HTTPS protocol

password

-

Default:

""

FortiOS or FortiGate password.

username

- / required

FortiOS or FortiGate username.

vdom

-

Default:

"root"

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.



Notes

Note

  • Requires fortiosapi library developed by Fortinet
  • Run as a local_action in your playbook


Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure DLP sensors.
    fortios_dlp_sensor:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      dlp_sensor:
        state: "present"
        comment: "Comment."
        dlp-log: "enable"
        extended-log: "enable"
        filter:
         -
            action: "allow"
            archive: "disable"
            company-identifier:  "myId_9"
            expiry: "<your_own_value>"
            file-size: "11"
            file-type: "12 (source dlp.filepattern.id)"
            filter-by: "credit-card"
            fp-sensitivity:
             -
                name: "default_name_15 (source dlp.fp-sensitivity.name)"
            id:  "16"
            match-percentage: "17"
            name: "default_name_18"
            proto: "smtp"
            regexp: "<your_own_value>"
            severity: "info"
            type: "file"
        flow-based: "enable"
        full-archive-proto: "smtp"
        nac-quar-log: "enable"
        name: "default_name_26"
        options: "<your_own_value>"
        replacemsg-group: "<your_own_value> (source system.replacemsg-group.name)"
        summary-proto: "smtp"

Return Values

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

Key Returned Description

build

string

always

Build number of the fortigate image


Sample:

1547

http_method

string

always

Last method used to provision the content into FortiGate


Sample:

PUT

http_status

string

always

Last result given by FortiGate on last operation applied


Sample:

200

mkey

string

success

Master key (id) used in the last call to FortiGate


Sample:

id

name

string

always

Name of the table used to fulfill the request


Sample:

urlfilter

path

string

always

Path of the table used to fulfill the request


Sample:

webfilter

revision

string

always

Internal revision number


Sample:

17.0.2.10658

serial

string

always

Serial number of the unit


Sample:

FGVMEVYYQT3AB5352

status

string

always

Indication of the operation's result


Sample:

success

vdom

string

always

Virtual domain used


Sample:

root

version

string

always

Version of the FortiGate


Sample:

v5.6.3




Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_dlp_sensor_module.html