:source: fortios_dlp_sensor.py

:orphan:

.. fortios_dlp_sensor:

fortios_dlp_sensor -- Configure sensors used by DLP blocking in Fortinet's FortiOS and FortiGate.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 2.0.0

.. contents::
   :local:
   :depth: 1


Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and sensor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0



Requirements
------------
The below requirements are needed on the host that executes this module.

- ansible>=2.16


Tips
----
Using member operation to add an element to an existing object.

FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6


Parameters
----------


.. raw:: html

    <ul>
    <li> <span class="li-head">access_token</span> - Token-based authentication. Generated from GUI of Fortigate. <span class="li-normal">type: str</span> <span class="li-required">required: false</span> </li>
    <li> <span class="li-head">enable_log</span> - Enable/Disable logging for task. <span class="li-normal">type: bool</span> <span class="li-required">required: false</span> <span class="li-normal">default: False</span> </li>
    <li> <span class="li-head">vdom</span> - 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. <span class="li-normal">type: str</span> <span class="li-normal">default: root</span> </li>
    <li> <span class="li-head">member_path</span> - Member attribute path to operate on. <span class="li-normal">type: str</span> </li>
    <li> <span class="li-head">member_state</span> - Add or delete a member under specified attribute path. <span class="li-normal">type: str</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">state</span> - Indicates whether to create or remove the object. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">dlp_sensor</span> - Configure sensors used by DLP blocking. <span class="li-normal">type: dict</span>
 <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a>
 <div id="label1" style="display:none">
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>dlp_sensor</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <ul class="ul-self">
        <li> <span class="li-head">comment</span> - Optional comments. <span class="li-normal">type: str</span>
 <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a>
 <div id="label3" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>comment</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">dlp_log</span> - Enable/disable DLP logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span>
 <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a>
 <div id="label5" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>dlp_log</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">entries</span> - DLP sensor entries. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id</span>
 <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a>
 <div id="label7" style="display:none">
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>entries</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <ul class="ul-self">
            <li> <span class="li-head">count</span> - Count of dictionary matches to trigger sensor entry match (Dictionary might not be able to trigger more than once based on its "repeat" option, 1 - 255). <span class="li-normal">type: int</span>
 <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a>
 <div id="label9" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>count</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">dictionary</span> - Select a DLP dictionary or exact-data-match. Source dlp.dictionary.name dlp.exact-data-match.name. <span class="li-normal">type: str</span>
 <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a>
 <div id="label11" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>dictionary</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">id</span> - ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span>
 <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a>
 <div id="label13" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>id</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">status</span> - Enable/disable this entry. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span>
 <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a>
 <div id="label15" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>status</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6</code></td>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
            </ul>
        <li> <span class="li-head">eval</span> - Expression to evaluate. <span class="li-normal">type: str</span>
 <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a>
 <div id="label17" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>eval</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">extended_log</span> - Enable/disable extended logging for data leak prevention. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span>
 <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a>
 <div id="label19" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>extended_log</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">feature_set</span> - Flow/proxy feature set. <span class="li-normal">type: str</span> <span class="li-normal">choices: flow, proxy</span>
 <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a>
 <div id="label21" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>feature_set</td>
 <td><code class="docutils literal notranslate">v6.4.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[flow]</td>
 <td><code class="docutils literal notranslate">v6.4.0 -> v7.0.12</code></td>
 <tr>
 <td>[proxy]</td>
 <td><code class="docutils literal notranslate">v6.4.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">filter</span> - Set up DLP filters for this sensor. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: filter:id</span>
 <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a>
 <div id="label23" style="display:none">
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>filter</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <ul class="ul-self">
            <li> <span class="li-head">action</span> - Action to take with content that this DLP sensor matches. <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, log-only, block, quarantine-ip</span>
 <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a>
 <div id="label25" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>action</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[allow]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[log-only]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[block]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[quarantine-ip]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
            <li> <span class="li-head">archive</span> - Enable/disable DLP archiving. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span>
 <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a>
 <div id="label27" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>archive</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
            <li> <span class="li-head">company_identifier</span> - Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched. <span class="li-normal">type: str</span>
 <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a>
 <div id="label29" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>company_identifier</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">expiry</span> - Quarantine duration in days, hours, minutes (format = dddhhmm). <span class="li-normal">type: str</span>
 <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a>
 <div id="label31" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>expiry</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">file_size</span> - Match files this size or larger (0 - 4294967295 kbytes). <span class="li-normal">type: int</span>
 <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a>
 <div id="label33" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>file_size</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">file_type</span> - Select the number of a DLP file pattern table to match. Source dlp.filepattern.id. <span class="li-normal">type: int</span>
 <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a>
 <div id="label35" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>file_type</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">filter_by</span> - Select the type of content to match. <span class="li-normal">type: str</span> <span class="li-normal">choices: credit-card, ssn, regexp, file-type, file-size, fingerprint, watermark, encrypted</span>
 <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a>
 <div id="label37" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>filter_by</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[credit-card]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ssn]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[regexp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[file-type]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[file-size]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[fingerprint]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[watermark]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[encrypted]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
            <li> <span class="li-head">fp_sensitivity</span> - Select a DLP file pattern sensitivity to match. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: filter:id/fp_sensitivity:name</span>
 <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a>
 <div id="label39" style="display:none">
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>fp_sensitivity</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td>
 </tr>
 </table>
 </div>
 </li>
                <ul class="ul-self">
                <li> <span class="li-head">name</span> - Select a DLP sensitivity. Source dlp.fp-sensitivity.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span>
 <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a>
 <div id="label41" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>name</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td>
 </tr>
 </table>
 </div>
 </li>
                </ul>
            <li> <span class="li-head">id</span> - ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span>
 <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a>
 <div id="label43" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>id</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">match_percentage</span> - Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match. <span class="li-normal">type: int</span>
 <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a>
 <div id="label45" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>match_percentage</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">name</span> - Filter name. <span class="li-normal">type: str</span>
 <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a>
 <div id="label47" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>name</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">proto</span> - Check messages or files over one or more of these protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: smtp, pop3, imap, http-get, http-post, ftp, nntp, mapi, ssh, cifs, mm1, mm3, mm4, mm7</span>
 <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a>
 <div id="label49" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>proto</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[smtp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[pop3]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[imap]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[http-get]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[http-post]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ftp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[nntp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[mapi]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ssh]</td>
 <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.12</code></td>
 </tr>
 <tr>
 <td>[cifs]</td>
 <td><code class="docutils literal notranslate">v6.4.0 -> v7.0.12</code></td>
 </tr>
 <tr>
 <td>[mm1]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm3]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm4]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm7]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">regexp</span> - Enter a regular expression to match (max. 255 characters). <span class="li-normal">type: str</span>
 <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a>
 <div id="label51" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>regexp</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
            <li> <span class="li-head">sensitivity</span> - Select a DLP file pattern sensitivity to match. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: filter:id/sensitivity:name</span>
 <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a>
 <div id="label53" style="display:none">
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>sensitivity</td>
 <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
                <ul class="ul-self">
                <li> <span class="li-head">name</span> - Select a DLP sensitivity. Source dlp.sensitivity.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span>
 <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a>
 <div id="label55" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>name</td>
 <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
                </ul>
            <li> <span class="li-head">severity</span> - Select the severity or threat level that matches this filter. <span class="li-normal">type: str</span> <span class="li-normal">choices: info, low, medium, high, critical</span>
 <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a>
 <div id="label57" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>severity</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[info]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[low]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[medium]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[high]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[critical]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
            <li> <span class="li-head">type</span> - Select whether to check the content of messages (an email message) or files (downloaded files or email attachments). <span class="li-normal">type: str</span> <span class="li-normal">choices: file, fos_message</span>
 <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a>
 <div id="label59" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>type</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[file]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[fos_message]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
            </ul>
        <li> <span class="li-head">flow_based</span> - Enable/disable flow-based DLP. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span>
 <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a>
 <div id="label61" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>flow_based</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td>
 </tr>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">full_archive_proto</span> - Protocols to always content archive. <span class="li-normal">type: list</span> <span class="li-normal">choices: smtp, pop3, imap, http-get, http-post, ftp, nntp, mapi, ssh, cifs, mm1, mm3, mm4, mm7</span>
 <a id='label62' href="javascript:ContentClick('label63', 'label62');" onmouseover="ContentPreview('label63');" onmouseout="ContentUnpreview('label63');" title="click to collapse or expand..."> more... </a>
 <div id="label63" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>full_archive_proto</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[smtp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[pop3]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[imap]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[http-get]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[http-post]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ftp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[nntp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[mapi]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ssh]</td>
 <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.12</code></td>
 </tr>
 <tr>
 <td>[cifs]</td>
 <td><code class="docutils literal notranslate">v6.4.0 -> v7.0.12</code></td>
 </tr>
 <tr>
 <td>[mm1]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm3]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm4]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm7]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">match_type</span> - Logical relation between entries . <span class="li-normal">type: str</span> <span class="li-normal">choices: match-all, match-any, match-eval</span>
 <a id='label64' href="javascript:ContentClick('label65', 'label64');" onmouseover="ContentPreview('label65');" onmouseout="ContentUnpreview('label65');" title="click to collapse or expand..."> more... </a>
 <div id="label65" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>match_type</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[match-all]</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6</code></td>
 <tr>
 <td>[match-any]</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6</code></td>
 <tr>
 <td>[match-eval]</td>
 <td><code class="docutils literal notranslate">v7.2.0 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">nac_quar_log</span> - Enable/disable NAC quarantine logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span>
 <a id='label66' href="javascript:ContentClick('label67', 'label66');" onmouseover="ContentPreview('label67');" onmouseout="ContentUnpreview('label67');" title="click to collapse or expand..."> more... </a>
 <div id="label67" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>nac_quar_log</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">name</span> - Name of table containing the sensor. <span class="li-normal">type: str</span> <span class="li-required">required: true</span>
 <a id='label68' href="javascript:ContentClick('label69', 'label68');" onmouseover="ContentPreview('label69');" onmouseout="ContentUnpreview('label69');" title="click to collapse or expand..."> more... </a>
 <div id="label69" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>name</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">options</span> - Configure DLP options. <span class="li-normal">type: str</span>
 <a id='label70' href="javascript:ContentClick('label71', 'label70');" onmouseover="ContentPreview('label71');" onmouseout="ContentUnpreview('label71');" title="click to collapse or expand..."> more... </a>
 <div id="label71" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>options</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">replacemsg_group</span> - Replacement message group used by this DLP sensor. Source system.replacemsg-group.name. <span class="li-normal">type: str</span>
 <a id='label72' href="javascript:ContentClick('label73', 'label72');" onmouseover="ContentPreview('label73');" onmouseout="ContentUnpreview('label73');" title="click to collapse or expand..."> more... </a>
 <div id="label73" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>replacemsg_group</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">summary_proto</span> - Protocols to always log summary. <span class="li-normal">type: list</span> <span class="li-normal">choices: smtp, pop3, imap, http-get, http-post, ftp, nntp, mapi, ssh, cifs, mm1, mm3, mm4, mm7</span>
 <a id='label74' href="javascript:ContentClick('label75', 'label74');" onmouseover="ContentPreview('label75');" onmouseout="ContentUnpreview('label75');" title="click to collapse or expand..."> more... </a>
 <div id="label75" style="display:none">
 <table border="1">
 <tr>
 <td></td>
 <td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>summary_proto</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12 </code></td>
 </tr>
 <tr>
 <td>[smtp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[pop3]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[imap]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[http-get]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[http-post]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ftp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[nntp]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[mapi]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.12</code></td>
 <tr>
 <td>[ssh]</td>
 <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.12</code></td>
 </tr>
 <tr>
 <td>[cifs]</td>
 <td><code class="docutils literal notranslate">v6.4.0 -> v7.0.12</code></td>
 </tr>
 <tr>
 <td>[mm1]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm3]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm4]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 <tr>
 <td>[mm7]</td>
 <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td>
 </tr>
 </table>
 </div>
 </li>
        </ul>
    </ul>


Notes
-----

.. note::

   - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

   - The module supports check_mode.



Examples
--------

.. code-block:: yaml+jinja
    
    - name: Configure sensors used by DLP blocking.
      fortinet.fortios.fortios_dlp_sensor:
          vdom: "{{ vdom }}"
          state: "present"
          access_token: "<your_own_value>"
          dlp_sensor:
              comment: "Optional comments."
              dlp_log: "enable"
              entries:
                  -
                      count: "1"
                      dictionary: "<your_own_value> (source dlp.dictionary.name dlp.exact-data-match.name)"
                      id: "8"
                      status: "enable"
              eval: "<your_own_value>"
              extended_log: "enable"
              feature_set: "flow"
              filter:
                  -
                      action: "allow"
                      archive: "disable"
                      company_identifier: "myId_16"
                      expiry: "<your_own_value>"
                      file_size: "10"
                      file_type: "0"
                      filter_by: "credit-card"
                      fp_sensitivity:
                          -
                              name: "default_name_22 (source dlp.fp-sensitivity.name)"
                      id: "23"
                      match_percentage: "10"
                      name: "default_name_25"
                      proto: "smtp"
                      regexp: "<your_own_value>"
                      sensitivity:
                          -
                              name: "default_name_29 (source dlp.sensitivity.name)"
                      severity: "info"
                      type: "file"
              flow_based: "enable"
              full_archive_proto: "smtp"
              match_type: "match-all"
              nac_quar_log: "enable"
              name: "default_name_36"
              options: "<your_own_value>"
              replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
              summary_proto: "smtp"


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:

.. raw:: html

    <ul>

    <li> <span class="li-return">build</span> - Build number of the fortigate image <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 1547</span></li>
    <li> <span class="li-return">http_method</span> - Last method used to provision the content into FortiGate <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: PUT</span></li>
    <li> <span class="li-return">http_status</span> - Last result given by FortiGate on last operation applied <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 200</span></li>
    <li> <span class="li-return">mkey</span> - Master key (id) used in the last call to FortiGate <span class="li-normal">returned: success</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: id</span></li>
    <li> <span class="li-return">name</span> - Name of the table used to fulfill the request <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: urlfilter</span></li>
    <li> <span class="li-return">path</span> - Path of the table used to fulfill the request <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: webfilter</span></li>
    <li> <span class="li-return">revision</span> - Internal revision number <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: 17.0.2.10658</span></li>
    <li> <span class="li-return">serial</span> - Serial number of the unit <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: FGVMEVYYQT3AB5352</span></li>
    <li> <span class="li-return">status</span> - Indication of the operation's result <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: success</span></li>
    <li> <span class="li-return">vdom</span> - Virtual domain used <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: root</span></li>
    <li> <span class="li-return">version</span> - Version of the FortiGate <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: v5.6.3</span></li>
    </ul>

Status
------

- This module is not guaranteed to have a backwards compatible interface.


Authors
-------

- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)


.. hint::
    If you notice any issues in this documentation, you can create a pull request to improve it.