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.0.0 of lix_fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This 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
- 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: "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"
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.
type: str
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- 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.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
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).
type: int
file_path:
description:
- Path on the server to the fingerprint files (max 119 characters).
type: str
file_pattern:
description:
- Files matching this pattern on the server are fingerprinted. Optionally use
the * and ? wildcards.
type: str
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.
type: str
name:
description:
- Name of the DLP fingerprint database.
required: true
type: str
password:
description:
- Password required to log into the file server.
type: str
period:
choices:
- none
- daily
- weekly
- monthly
description:
- Frequency for which the FortiGate checks the server for new or changed files.
type: str
remove_deleted:
choices:
- enable
- disable
description:
- Enable to keep the fingerprint database up to date when a file is deleted from
the server.
type: str
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.
type: str
scan_subdirectories:
choices:
- enable
- disable
description:
- Enable/disable scanning subdirectories to find files to create fingerprints
from.
type: str
sensitivity:
description:
- Select a sensitivity or threat level for matches with this fingerprint database.
Add sensitivities using sensitivity. Source dlp .sensitivity.name.
type: str
server:
description:
- IPv4 or IPv6 address of the server.
type: str
server_type:
choices:
- samba
description:
- Protocol used to communicate with the file server. Currently only Samba (SMB)
servers are supported.
type: str
tod_hour:
description:
- Hour of the day on which to scan the server (0 - 23).
type: int
tod_min:
description:
- Minute of the hour on which to scan the server (0 - 59).
type: int
username:
description:
- User name required to log into the file server.
type: str
vdom:
choices:
- mgmt
- current
description:
- Select the VDOM that can communicate with the file server.
type: str
weekday:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description:
- Day of the week on which to scan the server.
type: str
type: dict
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