fmgr_dlp_sensor – Configure DLP sensors.¶
New in version 2.10.
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 v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- dlp_sensor - Configure DLP sensors. type: dict
- comment - Comment. type: str
- dlp-log - Enable/disable DLP logging. type: str choices: [disable, enable]
- extended-log - Enable/disable extended logging for data leak prevention. type: str choices: [disable, enable]
- filter - No description for the parameter type: array
- action - Action to take with content that this DLP sensor matches. type: str choices: [log-only, block, exempt, ban, ban-sender, quarantine-ip, quarantine-port, none, allow]
- archive - Enable/disable DLP archiving. type: str choices: [disable, enable, summary-only]
- company-identifier - Enter a company identifier watermark to match. type: str
- expiry - Quarantine duration in days, hours, minutes format (dddhhmm). type: str
- file-size - Match files this size or larger (0 - 4294967295 kbytes). type: int
- file-type - Select the number of a DLP file pattern table to match. type: str
- filter-by - Select the type of content to match. type: str choices: [credit-card, ssn, regexp, file-type, file-size, fingerprint, watermark, encrypted]
- fp-sensitivity - Select a DLP file pattern sensitivity to match. type: str
- id - ID. type: int
- match-percentage - Percentage of fingerprints in the fingerprint databases designated with the selected fp-sensitivity to match. type: int
- name - Filter name. type: str
- proto - No description for the parameter type: array choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post]
- regexp - Enter a regular expression to match (max. type: str
- severity - Select the severity or threat level that matches this filter. type: str choices: [info, low, medium, high, critical]
- type - Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). type: str choices: [file, message]
- flow-based - Enable/disable flow-based DLP. type: str choices: [disable, enable]
- full-archive-proto - No description for the parameter type: array choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post]
- nac-quar-log - Enable/disable NAC quarantine logging. type: str choices: [disable, enable]
- name - Name of the DLP sensor. type: str
- options - Configure DLP options. type: str choices: [strict-file]
- replacemsg-group - Replacement message group used by this DLP sensor. type: str
- summary-proto - No description for the parameter type: array choices: [imap, smtp, pop3, ftp, nntp, mm1, mm3, mm4, mm7, mapi, aim, icq, msn, yahoo, http-get, http-post]
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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure DLP sensors.
fmgr_dlp_sensor:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
dlp_sensor:
comment: <value of string>
dlp-log: <value in [disable, enable]>
extended-log: <value in [disable, enable]>
filter:
-
action: <value in [log-only, block, exempt, ...]>
archive: <value in [disable, enable, summary-only]>
company-identifier: <value of string>
expiry: <value of string>
file-size: <value of integer>
file-type: <value of string>
filter-by: <value in [credit-card, ssn, regexp, ...]>
fp-sensitivity: <value of string>
id: <value of integer>
match-percentage: <value of integer>
name: <value of string>
proto:
- imap
- smtp
- pop3
- ftp
- nntp
- mm1
- mm3
- mm4
- mm7
- mapi
- aim
- icq
- msn
- yahoo
- http-get
- http-post
regexp: <value of string>
severity: <value in [info, low, medium, ...]>
type: <value in [file, message]>
flow-based: <value in [disable, enable]>
full-archive-proto:
- imap
- smtp
- pop3
- ftp
- nntp
- mm1
- mm3
- mm4
- mm7
- mapi
- aim
- icq
- msn
- yahoo
- http-get
- http-post
nac-quar-log: <value in [disable, enable]>
name: <value of string>
options: <value in [strict-file]>
replacemsg-group: <value of string>
summary-proto:
- imap
- smtp
- pop3
- ftp
- nntp
- mm1
- mm3
- mm4
- mm7
- mapi
- aim
- icq
- msn
- yahoo
- http-get
- http-post
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict