fortinet.fortios.fortios_dlp_fp_doc_source module – Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints 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_fp_doc_source
.
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 fp_doc_source 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. |
|
Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints. |
|
Day of the month on which to scan the server (1 - 31). |
|
Path on the server to the fingerprint files (max 119 characters). |
|
Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards. |
|
Enable so that when a file is changed on the server the FortiGate keeps the old fingerprint and adds a new fingerprint to the database. Choices:
|
|
Name of the DLP fingerprint database. |
|
Password required to log into the file server. |
|
Frequency for which the FortiGate checks the server for new or changed files. Choices:
|
|
Enable to keep the fingerprint database up to date when a file is deleted from the server. Choices:
|
|
Enable to keep the fingerprint database up to date when a file is added or changed on the server. Choices:
|
|
Enable/disable scanning subdirectories to find files to create fingerprints from. Choices:
|
|
Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using sensitivity. Source dlp .sensitivity.name. |
|
IPv4 or IPv6 address of the server. |
|
Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. Choices:
|
|
Hour of the day on which to scan the server (0 - 23). |
|
Minute of the hour on which to scan the server (0 - 59). |
|
User name required to log into the file server. |
|
Select the VDOM that can communicate with the file server. Choices:
|
|
Day of the week on which to scan the server. 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: Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
fortinet.fortios.fortios_dlp_fp_doc_source:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_fp_doc_source:
date: "1"
file_path: "<your_own_value>"
file_pattern: "<your_own_value>"
keep_modified: "enable"
name: "default_name_7"
password: "<your_own_value>"
period: "none"
remove_deleted: "enable"
scan_on_creation: "enable"
scan_subdirectories: "enable"
sensitivity: "<your_own_value> (source dlp.sensitivity.name)"
server: "192.168.100.40"
server_type: "samba"
tod_hour: "1"
tod_min: "0"
username: "<your_own_value>"
vdom: "mgmt"
weekday: "sunday"
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: |