Note
This plugin is part of the fortinet.fortios collection.
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.8: of fortinet.fortios
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| 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. | |
| state string |
| Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. | |
| 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. | |
| host string | FortiOS or FortiGate IP address. | ||
| https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
| password string | Default: "" | FortiOS or FortiGate password. | |
| ssl_verify boolean added in 2.9 of fortinet.fortios |
| Ensures FortiGate certificate must be verified by a proper CA. | |
| state string added in 2.9 of fortinet.fortios |
| Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | |
| username string | FortiOS or FortiGate username. | ||
| 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: 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"
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"
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_dlp_fp_doc_source_module.html