:source: fmgd_antivirus_quarantine.py

:orphan:

.. _fmgd_antivirus_quarantine:

fmgd_antivirus_quarantine -- Configure quarantine options.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.0


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


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
----------------------------------
.. raw:: html

 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>



Parameters
----------
.. raw:: html

 <ul>
 <li><span class="li-head">access_token</span> -The token to access FortiManager without using username and password. <span class="li-normal">type: str</span> <span class="li-required">required: false</span></li> <li><span class="li-head">bypass_validation</span> - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. <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">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">forticloud_access_token</span> - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. <span class="li-normal">type: str</span> <span class="li-required">required: false</span> </li>
 <li><span class="li-head">proposed_method</span> - The overridden method for the underlying Json RPC request. <span class="li-normal">type: str</span> <span class="li-required">required: false</span> <span class="li-normal"> choices: set, update, add</span> </li>
 <li><span class="li-head">rc_succeeded</span> - The rc codes list with which the conditions to succeed will be overriden. <span class="li-normal">type: list</span> <span class="li-required">required: false</span> </li>
 <li><span class="li-head">rc_failed</span> - The rc codes list with which the conditions to fail will be overriden. <span class="li-normal">type: list</span> <span class="li-required">required: false</span> </li>
 <li><span class="li-head">workspace_locking_adom</span> - Acquire the workspace lock if FortiManager is running in workspace mode. <span class="li-normal">type: str</span> <span class="li-required">required: false</span> <span class="li-normal"> choices: global, custom adom including root</span> </li>
 <li><span class="li-head">workspace_locking_timeout</span> - The maximum time in seconds to wait for other users to release workspace lock. <span class="li-normal">type: integer</span> <span class="li-required">required: false</span>  <span class="li-normal">default: 300</span> </li>
 <li><span class="li-head">device</span> - The parameter in requested url <span class="li-normal">type: str</span> <span class="li-required">required: true</span> </li>
 <li><span class="li-head">vdom</span> - The parameter in requested url <span class="li-normal">type: str</span> <span class="li-required">required: true</span> </li>
 <li><span class="li-head">antivirus_quarantine</span> - Configure quarantine options. <span class="li-normal">type: dict</span></li>
 <ul class="ul-self">
 <li><span class="li-head">agelimit</span> Age limit for quarantined files (0 - 479 hours, 0 means forever). <span class="li-normal">type: int</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">destination</span> Choose whether to quarantine files to the fortigate disk or to fortianalyzer or to delete them instead of quarantining them. <span class="li-normal">type: str</span> <span class="li-normal">choices: [NULL, disk, FortiAnalyzer]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">drop_infected</span> <b>(Alias name: drop-infected)</b>  Do not quarantine infected files found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">drop_machine_learning</span> <b>(Alias name: drop-machine-learning)</b>  Do not quarantine files detected by machine learning found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">lowspace</span> Select the method for handling additional files when running low on disk space. <span class="li-normal">type: str</span> <span class="li-normal">choices: [ovrw-old, drop-new]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">maxfilesize</span> Maximum file size to quarantine (0 - 500 mbytes, 0 means unlimited). <span class="li-normal">type: int</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">quarantine_quota</span> <b>(Alias name: quarantine-quota)</b>  The amount of disk space to reserve for quarantining files (0 - 4294967295 mbytes, depends on disk space). <span class="li-normal">type: int</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">store_infected</span> <b>(Alias name: store-infected)</b>  Quarantine infected files found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">store_machine_learning</span> <b>(Alias name: store-machine-learning)</b>  Quarantine files detected by machine learning found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">drop_blocked</span> <b>(Alias name: drop-blocked)</b>  Do not quarantine dropped files found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">store_blocked</span> <b>(Alias name: store-blocked)</b>  Quarantine blocked files found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">drop_heuristic</span> <b>(Alias name: drop-heuristic)</b>  Do not quarantine files detected by heuristics found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">store_heuristic</span> <b>(Alias name: store-heuristic)</b>  Quarantine files detected by heuristics found in sessions using the selected protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> latest</code></p>
 </div>
 </li>
 <li><span class="li-head">drop_intercepted</span> <b>(Alias name: drop-intercepted)</b>  Drop intercepted from a protocol <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> v7.6.2</code></p>
 </div>
 </li>
 <li><span class="li-head">store_intercepted</span> <b>(Alias name: store-intercepted)</b>  Quarantine intercepted from a protocol <span class="li-normal">type: list</span> <span class="li-normal">choices: [imap, smtp, pop3, http, ftp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi]</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">
 <p>Supported Version Ranges: <code class="docutils literal notranslate">v7.2.6 -> v7.2.12</code>, <code class="docutils literal notranslate">v7.4.3 -> v7.6.2</code></p>
 </div>
 </li>
 </ul>
 </ul>



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
--------

.. code-block:: yaml+jinja

  - 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: Configure quarantine options.
        fortinet.fmgdevice.fmgd_antivirus_quarantine:
          # 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>
          antivirus_quarantine:
            # agelimit: <integer>
            # destination: <value in [NULL, disk, FortiAnalyzer]>
            # drop_infected:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "im"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # drop_machine_learning:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # lowspace: <value in [ovrw-old, drop-new]>
            # maxfilesize: <integer>
            # quarantine_quota: <integer>
            # store_infected:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "im"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # store_machine_learning:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # drop_blocked:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # store_blocked:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # drop_heuristic:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "im"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # store_heuristic:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "im"
            #   - "nntp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            #   - "cifs"
            #   - "ssh"
            # drop_intercepted:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"
            # store_intercepted:
            #   - "imap"
            #   - "smtp"
            #   - "pop3"
            #   - "http"
            #   - "ftp"
            #   - "imaps"
            #   - "smtps"
            #   - "pop3s"
            #   - "https"
            #   - "mm1"
            #   - "mm3"
            #   - "mm4"
            #   - "mm7"
            #   - "ftps"
            #   - "mapi"


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">meta</span> - The result of the request.<span class="li-normal">returned: always</span> <span class="li-normal">type: dict</span></li>
 <ul class="ul-self"> <li> <span class="li-return">request_url</span> - The full url requested. <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: /sys/login/user</span></li>
 <li> <span class="li-return">response_code</span> - The status of api request. <span class="li-normal">returned: always</span> <span class="li-normal">type: int</span> <span class="li-normal">sample: 0</span></li>
 <li> <span class="li-return">response_data</span> - The data body of the api response. <span class="li-normal">returned: optional</span> <span class="li-normal">type: list or dict</span></li>
 <li> <span class="li-return">response_message</span> - The descriptive message of the api response. <span class="li-normal">returned: always</span> <span class="li-normal">type: str</span> <span class="li-normal">sample: OK</span></li>
 <li> <span class="li-return">system_information</span> - The information of the target system. <span class="li-normal">returned: always</span> <span class="li-normal">type: dict</span></li>
 </ul>
 <li> <span class="li-return">rc</span> - The status the request. <span class="li-normal">returned: always</span> <span class="li-normal">type: int</span> <span class="li-normal">sample: 0</span></li>
 <li> <span class="li-return">version_check_warning</span> - Warning if the parameters used in the playbook are not supported by the current FortiManager version. <span class="li-normal">returned: if at least one parameter not supported by the current FortiManager version</span> <span class="li-normal">type: list</span> </li>
 </ul>


Status
------

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


Authors
-------

- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)