New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
dlp_fp_doc_source
-
|
Default: null
|
Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
|
|
date
-
|
Day of the month on which to scan the server (1 - 31).
|
||
file-path
-
|
Path on the server to the fingerprint files (max 119 characters).
|
||
file-pattern
-
|
Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards.
|
||
keep-modified
-
|
|
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
-
/ required
|
Name of the DLP fingerprint database.
|
||
password
-
|
Password required to log into the file server.
|
||
period
-
|
|
Frequency for which the FortiGate checks the server for new or changed files.
|
|
remove-deleted
-
|
|
Enable to keep the fingerprint database up to date when a file is deleted from the server.
|
|
scan-on-creation
-
|
|
Enable to keep the fingerprint database up to date when a file is added or changed on the server.
|
|
scan-subdirectories
-
|
|
Enable/disable scanning subdirectories to find files to create fingerprints from.
|
|
sensitivity
-
|
Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using fp-sensitivity. Source dlp .fp-sensitivity.name.
|
||
server
-
|
IPv4 or IPv6 address of the server.
|
||
server-type
-
|
|
Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported.
|
|
state
-
|
|
Indicates whether to create or remove the object
|
|
tod-hour
-
|
Hour of the day on which to scan the server (0 - 23, default = 1).
|
||
tod-min
-
|
Minute of the hour on which to scan the server (0 - 59).
|
||
username
-
|
User name required to log into the file server.
|
||
vdom
-
|
|
Select the VDOM that can communicate with the file server.
|
|
weekday
-
|
|
Day of the week on which to scan the server.
|
|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
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: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
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:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
dlp_fp_doc_source:
state: "present"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.