You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_dlp_sensor.

New in version 2.10: of fortinet.fortios

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and sensor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

• ansible>=2.9.0

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
dlp_sensor dictionary	Configure DLP sensors.
comment string	Comment.
dlp_log string	Enable/disable DLP logging. Choices: enable disable
extended_log string	Enable/disable extended logging for data leak prevention. Choices: enable disable
feature_set string	Flow/proxy feature set. Choices: flow proxy
filter list / elements=string	Set up DLP filters for this sensor.
action string	Action to take with content that this DLP sensor matches. Choices: allow log-only block quarantine-ip
archive string	Enable/disable DLP archiving. Choices: disable enable
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 integer	Select the number of a DLP file pattern table to match. Source dlp.filepattern.id.
filter_by string	Select the type of content to match. Choices: credit-card ssn regexp file-type file-size fingerprint watermark encrypted
fp_sensitivity list / elements=string	Select a DLP file pattern sensitivity to match.
name string / required	Select a DLP sensitivity. Source dlp.fp-sensitivity.name.
id integer / required	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: smtp pop3 imap http-get http-post ftp nntp mapi mm1 mm3 mm4 mm7 ssh cifs
regexp string	Enter a regular expression to match (max. 255 characters).
sensitivity list / elements=string	Select a DLP file pattern sensitivity to match.
name string / required	Select a DLP sensitivity. Source dlp.sensitivity.name.
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: enable disable
full_archive_proto list / elements=string	Protocols to always content archive. Choices: smtp pop3 imap http-get http-post ftp nntp mapi mm1 mm3 mm4 mm7 ssh cifs
nac_quar_log string	Enable/disable NAC quarantine logging. Choices: enable disable
name string / required	Name of the DLP sensor.
options string	Configure DLP options.
replacemsg_group string	Replacement message group used by this DLP sensor. Source system.replacemsg-group.name.
summary_proto list / elements=string	Protocols to always log summary. Choices: smtp pop3 imap http-get http-post ftp nntp mapi mm1 mm3 mm4 mm7 ssh cifs
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	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. Default: “root”

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_dlp_sensor
    fortios_dlp_sensor:
      vdom: root
      state: present
      dlp_sensor:
        dlp_log: enable
        extended_log: disable
        feature_set: flow
        nac_quar_log: disable
        name: terr-test-rdmstr

Return Values

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

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always Sample: “v5.6.3”

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)