fmgd_dlp_fpdocsource – Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- dlp_fpdocsource - Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints. type: dict
- date Day of the month on which to scan the server (1 - 31). type: int more...
- file_path (Alias name: file-path) Path on the server to the fingerprint files (max 119 characters). type: str more...
- file_pattern (Alias name: file-pattern) Files matching this pattern on the server are fingerprinted. type: str more...
- keep_modified (Alias name: 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. type: str choices: [disable, enable] more...
- name Name of the dlp fingerprint database. type: str more...
- password Password required to log into the file server. type: list more...
- period Frequency for which the fortigate checks the server for new or changed files. type: str choices: [none, daily, weekly, monthly] more...
- remove_deleted (Alias name: remove-deleted) Enable to keep the fingerprint database up to date when a file is deleted from the server. type: str choices: [disable, enable] more...
- scan_on_creation (Alias name: scan-on-creation) Enable to keep the fingerprint database up to date when a file is added or changed on the server. type: str choices: [disable, enable] more...
- scan_subdirectories (Alias name: scan-subdirectories) Enable/disable scanning subdirectories to find files to create fingerprints from. type: str choices: [disable, enable] more...
- sensitivity Select a sensitivity or threat level for matches with this fingerprint database. type: list more...
- server Ipv4 or ipv6 address of the server. type: str more...
- server_type (Alias name: server-type) Protocol used to communicate with the file server. type: str choices: [samba] more...
- tod_hour (Alias name: tod-hour) Hour of the day on which to scan the server (0 - 23, default = 1). type: int more...
- tod_min (Alias name: tod-min) Minute of the hour on which to scan the server (0 - 59). type: int more...
- username User name required to log into the file server. type: str more...
- vdom Select the vdom that can communicate with the file server. type: str choices: [mgmt, current] more...
- weekday Day of the week on which to scan the server. type: str choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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.
fortinet.fmgdevice.fmgd_dlp_fpdocsource:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
dlp_fpdocsource:
name: "your value" # Required variable, string
# date: <integer>
# file_path: <string>
# file_pattern: <string>
# keep_modified: <value in [disable, enable]>
# password: <list or string>
# period: <value in [none, daily, weekly, ...]>
# remove_deleted: <value in [disable, enable]>
# scan_on_creation: <value in [disable, enable]>
# scan_subdirectories: <value in [disable, enable]>
# sensitivity: <list or string>
# server: <string>
# server_type: <value in [samba]>
# tod_hour: <integer>
# tod_min: <integer>
# username: <string>
# vdom: <value in [mgmt, current]>
# weekday: <value in [sunday, monday, tuesday, ...]>
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.