Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | 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. | |||
| extended_log string |
| Enable/disable extended logging for data leak prevention. | |||
| feature_set string |
| Flow/proxy feature set. | |||
| filter list / elements=string | Set up DLP filters for this sensor. | ||||
| action string |
| Action to take with content that this DLP sensor matches. | |||
| archive string |
| Enable/disable DLP archiving. | |||
| 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. | |||
| 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. | |||
| 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. | |||
| type string |
| Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). | |||
| flow_based string |
| Enable/disable flow-based DLP. | |||
| full_archive_proto list / elements=string |
| Protocols to always content archive. | |||
| nac_quar_log string |
| Enable/disable NAC quarantine logging. | |||
| 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. | |||
| enable_log boolean |
| Enable/Disable logging for task. | |||
| state string / required |
| Indicates whether to create or remove the object. | |||
| vdom string | 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. | |||
Note
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure DLP sensors.
fortios_dlp_sensor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_sensor:
comment: "Comment."
dlp_log: "enable"
extended_log: "enable"
feature_set: "flow"
filter:
-
action: "allow"
archive: "disable"
company_identifier: "myId_10"
expiry: "<your_own_value>"
file_size: "12"
file_type: "13 (source dlp.filepattern.id)"
filter_by: "credit-card"
fp_sensitivity:
-
name: "default_name_16 (source dlp.fp-sensitivity.name)"
id: "17"
match_percentage: "18"
name: "default_name_19"
proto: "smtp"
regexp: "<your_own_value>"
sensitivity:
-
name: "default_name_23 (source dlp.sensitivity.name)"
severity: "info"
type: "file"
flow_based: "enable"
full_archive_proto: "smtp"
nac_quar_log: "enable"
name: "default_name_29"
options: "<your_own_value>"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
summary_proto: "smtp"
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_dlp_sensor_module.html