fortinet.fortimanager.fmgr_antivirus_profile_contentdisarm – AV Content Disarm and Reconstruction settings.

Note

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

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

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

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
antivirus_profile_contentdisarm
dictionary
the top level parameters set
cover-page
string
    Choices:
  • disable
  • enable
Enable/disable inserting a cover page into the disarmed document.
detect-only
string
    Choices:
  • disable
  • enable
Enable/disable only detect disarmable files, do not alter content.
office-embed
string
    Choices:
  • disable
  • enable
Enable/disable stripping of embedded objects in Microsoft Office documents.
office-hylink
string
    Choices:
  • disable
  • enable
Enable/disable stripping of hyperlinks in Microsoft Office documents.
office-linked
string
    Choices:
  • disable
  • enable
Enable/disable stripping of linked objects in Microsoft Office documents.
office-macro
string
    Choices:
  • disable
  • enable
Enable/disable stripping of macros in Microsoft Office documents.
original-file-destination
string
    Choices:
  • fortisandbox
  • quarantine
  • discard
Destination to send original file if active content is removed.
pdf-act-form
string
    Choices:
  • disable
  • enable
Enable/disable stripping of actions that submit data to other targets in PDF documents.
pdf-act-gotor
string
    Choices:
  • disable
  • enable
Enable/disable stripping of links to other PDFs in PDF documents.
pdf-act-java
string
    Choices:
  • disable
  • enable
Enable/disable stripping of actions that execute JavaScript code in PDF documents.
pdf-act-launch
string
    Choices:
  • disable
  • enable
Enable/disable stripping of links to external applications in PDF documents.
pdf-act-movie
string
    Choices:
  • disable
  • enable
Enable/disable stripping of embedded movies in PDF documents.
pdf-act-sound
string
    Choices:
  • disable
  • enable
Enable/disable stripping of embedded sound files in PDF documents.
pdf-embedfile
string
    Choices:
  • disable
  • enable
Enable/disable stripping of embedded files in PDF documents.
pdf-hyperlink
string
    Choices:
  • disable
  • enable
Enable/disable stripping of hyperlinks from PDF documents.
pdf-javacode
string
    Choices:
  • disable
  • enable
Enable/disable stripping of JavaScript code in PDF documents.
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
profile
string / required
the parameter (profile) in requested url
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: AV Content Disarm and Reconstruction settings.
     fmgr_antivirus_profile_contentdisarm:
        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>
        profile: <your own value>
        antivirus_profile_contentdisarm:
           cover-page: <value in [disable, enable]>
           detect-only: <value in [disable, enable]>
           office-embed: <value in [disable, enable]>
           office-hylink: <value in [disable, enable]>
           office-linked: <value in [disable, enable]>
           office-macro: <value in [disable, enable]>
           original-file-destination: <value in [fortisandbox, quarantine, discard]>
           pdf-act-form: <value in [disable, enable]>
           pdf-act-gotor: <value in [disable, enable]>
           pdf-act-java: <value in [disable, enable]>
           pdf-act-launch: <value in [disable, enable]>
           pdf-act-movie: <value in [disable, enable]>
           pdf-act-sound: <value in [disable, enable]>
           pdf-embedfile: <value in [disable, enable]>
           pdf-hyperlink: <value in [disable, enable]>
           pdf-javacode: <value in [disable, enable]>

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)