Try SpotterCreate 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.
| "added in version" 2.8 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.8.20
This module is able to configure a FortiGate or FortiOS by allowing the user to configure dlp feature and fp_doc_source category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2
- 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"
host:
description:
- FortiOS or FortiGate ip address.
required: true
vdom:
default: root
description:
- 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.
https:
default: false
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol
type: bool
password:
default: ''
description:
- FortiOS or FortiGate password.
username:
description:
- FortiOS or FortiGate username.
required: true
dlp_fp_doc_source:
default: null
description:
- Create a DLP fingerprint database by allowing the FortiGate to access a file server
containing files from which to create fingerprints.
suboptions:
date:
description:
- Day of the month on which to scan the server (1 - 31).
file-path:
description:
- Path on the server to the fingerprint files (max 119 characters).
file-pattern:
description:
- Files matching this pattern on the server are fingerprinted. Optionally use
the * and ? wildcards.
keep-modified:
choices:
- enable
- disable
description:
- 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:
description:
- Name of the DLP fingerprint database.
required: true
password:
description:
- Password required to log into the file server.
period:
choices:
- none
- daily
- weekly
- monthly
description:
- Frequency for which the FortiGate checks the server for new or changed files.
remove-deleted:
choices:
- enable
- disable
description:
- Enable to keep the fingerprint database up to date when a file is deleted from
the server.
scan-on-creation:
choices:
- enable
- disable
description:
- Enable to keep the fingerprint database up to date when a file is added or changed
on the server.
scan-subdirectories:
choices:
- enable
- disable
description:
- Enable/disable scanning subdirectories to find files to create fingerprints
from.
sensitivity:
description:
- Select a sensitivity or threat level for matches with this fingerprint database.
Add sensitivities using fp-sensitivity. Source dlp .fp-sensitivity.name.
server:
description:
- IPv4 or IPv6 address of the server.
server-type:
choices:
- samba
description:
- Protocol used to communicate with the file server. Currently only Samba (SMB)
servers are supported.
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object
tod-hour:
description:
- Hour of the day on which to scan the server (0 - 23, default = 1).
tod-min:
description:
- Minute of the hour on which to scan the server (0 - 59).
username:
description:
- User name required to log into the file server.
vdom:
choices:
- mgmt
- current
description:
- Select the VDOM that can communicate with the file server.
weekday:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description:
- Day of the week on which to scan the server.
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str