W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_dlp_sensor – Configure DLP sensors.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_dlp_sensor.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
dlp_sensor
dictionary
the top level parameters set
comment
string
Comment.
dlp-log
string
    Choices:
  • disable
  • enable
Enable/disable DLP logging.
extended-log
string
    Choices:
  • disable
  • enable
Enable/disable extended logging for data leak prevention.
feature-set
string
    Choices:
  • proxy
  • flow
Flow/proxy feature set.
filter
list / elements=string
no description
action
string
    Choices:
  • log-only
  • block
  • exempt
  • ban
  • ban-sender
  • quarantine-ip
  • quarantine-port
  • none
  • allow
Action to take with content that this DLP sensor matches.
archive
string
    Choices:
  • disable
  • enable
  • summary-only
Enable/disable DLP archiving.
company-identifier
string
Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched.
expiry
string
Quarantine duration in days, hours, minutes format (dddhhmm).
file-size
integer
Match files this size or larger (0 - 4294967295 kbytes).
file-type
string
Select the number of a DLP file pattern table to match.
filter-by
string
    Choices:
  • credit-card
  • ssn
  • regexp
  • file-type
  • file-size
  • fingerprint
  • watermark
  • encrypted
Select the type of content to match.
fp-sensitivity
string
Select a DLP file pattern sensitivity to match.
id
integer
ID.
match-percentage
integer
Percentage of fingerprints in the fingerprint databases designated with the selected fp-sensitivity to match.
name
string
Filter name.
proto
list / elements=string
    Choices:
  • imap
  • smtp
  • pop3
  • ftp
  • nntp
  • mm1
  • mm3
  • mm4
  • mm7
  • mapi
  • aim
  • icq
  • msn
  • yahoo
  • http-get
  • http-post
  • ssh
  • cifs
no description
regexp
string
Enter a regular expression to match (max. 255 characters).
sensitivity
string
Select a DLP file pattern sensitivity to match.
severity
string
    Choices:
  • info
  • low
  • medium
  • high
  • critical
Select the severity or threat level that matches this filter.
type
string
    Choices:
  • file
  • message
Select whether to check the content of messages (an email message) or files (downloaded files or email attachments).
flow-based
string
    Choices:
  • disable
  • enable
Enable/disable flow-based DLP.
full-archive-proto
list / elements=string
    Choices:
  • imap
  • smtp
  • pop3
  • ftp
  • nntp
  • mm1
  • mm3
  • mm4
  • mm7
  • mapi
  • aim
  • icq
  • msn
  • yahoo
  • http-get
  • http-post
  • ssh
  • cifs
no description
nac-quar-log
string
    Choices:
  • disable
  • enable
Enable/disable NAC quarantine logging.
name
string
Name of the DLP sensor.
options
string
    Choices:
  • strict-file
Configure DLP options.
replacemsg-group
string
Replacement message group used by this DLP sensor.
summary-proto
list / elements=string
    Choices:
  • imap
  • smtp
  • pop3
  • ftp
  • nntp
  • mm1
  • mm3
  • mm4
  • mm7
  • mapi
  • aim
  • icq
  • msn
  • yahoo
  • http-get
  • http-post
  • ssh
  • cifs
no description
enable_log
boolean
    Choices:
  • no
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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
                   - ssh
                   - cifs
                 regexp: <value of string>
                 severity: <value in [info, low, medium, ...]>
                 type: <value in [file, message]>
                 sensitivity: <value of string>
           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
             - ssh
             - cifs
           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
             - ssh
             - cifs
           feature-set: <value in [proxy, flow]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_dlp_sensor_module.html