fortinet.fortios.fortios_dlp_fp_doc_source – 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 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_fp_doc_source.
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 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.9.0
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
| dlp_fp_doc_source dictionary | Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints. | ||
| date integer | Day of the month on which to scan the server (1 - 31). | ||
| file_path string | Path on the server to the fingerprint files (max 119 characters). | ||
| file_pattern string | Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards. | ||
| keep_modified string |
| 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. | |
| name string / required | Name of the DLP fingerprint database. | ||
| password string | Password required to log into the file server. | ||
| period string |
| Frequency for which the FortiGate checks the server for new or changed files. | |
| remove_deleted string |
| Enable to keep the fingerprint database up to date when a file is deleted from the server. | |
| scan_on_creation string |
| Enable to keep the fingerprint database up to date when a file is added or changed on the server. | |
| scan_subdirectories string |
| Enable/disable scanning subdirectories to find files to create fingerprints from. | |
| sensitivity string | Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using fp-sensitivity. Source dlp .fp-sensitivity.name. | ||
| server string | IPv4 or IPv6 address of the server. | ||
| server_type string |
| Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. | |
| tod_hour integer | Hour of the day on which to scan the server (0 - 23). | ||
| tod_min integer | Minute of the hour on which to scan the server (0 - 59). | ||
| username string | User name required to log into the file server. | ||
| vdom string |
| Select the VDOM that can communicate with the file server. | |
| weekday string |
| Day of the week on which to scan the server. | |
| 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. | |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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: Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
fortios_dlp_fp_doc_source:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
dlp_fp_doc_source:
date: "3"
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.fp-sensitivity.name)"
server: "192.168.100.40"
server_type: "samba"
tod_hour: "16"
tod_min: "17"
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 | 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 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 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_fp_doc_source_module.html