fortinet.fortios.fortios_dlp_sensor module – Configure sensors used by DLP blocking in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_dlp_sensor
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure sensors used by DLP blocking. |
|
Optional comments. |
|
Enable/disable DLP logging. Choices:
|
|
DLP sensor entries. |
|
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). |
|
Select a DLP dictionary or exact-data-match. Source dlp.dictionary.name dlp.exact-data-match.name. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Enable/disable this entry. Choices:
|
|
Expression to evaluate. |
|
Enable/disable extended logging for data leak prevention. Choices:
|
|
Flow/proxy feature set. Choices:
|
|
Set up DLP filters for this sensor. |
|
Action to take with content that this DLP sensor matches. Choices:
|
|
Enable/disable DLP archiving. Choices:
|
|
Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched. |
|
Quarantine duration in days, hours, minutes (format = dddhhmm). |
|
Match files this size or larger (0 - 4294967295 kbytes). |
|
Select the number of a DLP file pattern table to match. Source dlp.filepattern.id. |
|
Select the type of content to match. Choices:
|
|
Select a DLP file pattern sensitivity to match. |
|
Select a DLP sensitivity. Source dlp.fp-sensitivity.name. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match. |
|
Filter name. |
|
Check messages or files over one or more of these protocols. Choices:
|
|
Enter a regular expression to match (max. 255 characters). |
|
Select a DLP file pattern sensitivity to match. |
|
Select a DLP sensitivity. Source dlp.sensitivity.name. |
|
Select the severity or threat level that matches this filter. Choices:
|
|
Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). Choices:
|
|
Enable/disable flow-based DLP. Choices:
|
|
Protocols to always content archive. Choices:
|
|
Logical relation between entries . Choices:
|
|
Enable/disable NAC quarantine logging. Choices:
|
|
Name of table containing the sensor. |
|
Configure DLP options. |
|
Replacement message group used by this DLP sensor. Source system.replacemsg-group.name. |
|
Protocols to always log summary. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure sensors used by DLP blocking.
fortinet.fortios.fortios_dlp_sensor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_sensor:
comment: "Optional comments."
dlp_log: "enable"
entries:
-
count: "1"
dictionary: "<your_own_value> (source dlp.dictionary.name dlp.exact-data-match.name)"
id: "8"
status: "enable"
eval: "<your_own_value>"
extended_log: "enable"
feature_set: "flow"
filter:
-
action: "allow"
archive: "disable"
company_identifier: "myId_16"
expiry: "<your_own_value>"
file_size: "10"
file_type: "0"
filter_by: "credit-card"
fp_sensitivity:
-
name: "default_name_22 (source dlp.fp-sensitivity.name)"
id: "23"
match_percentage: "10"
name: "default_name_25"
proto: "smtp"
regexp: "<your_own_value>"
sensitivity:
-
name: "default_name_29 (source dlp.sensitivity.name)"
severity: "info"
type: "file"
flow_based: "enable"
full_archive_proto: "smtp"
match_type: "match-all"
nac_quar_log: "enable"
name: "default_name_36"
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 |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |