fmgr_antivirus_profile_contentdisarm – AV Content Disarm and Reconstruction settings.

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

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
antivirus_profile_contentdisarm yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • 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
  • adom - The parameter in requested url type: str required: true
  • profile - The parameter in requested url type: str required: true
  • antivirus_profile_contentdisarm - AV Content Disarm and Reconstruction settings. type: dict
    • cover-page - Enable/disable inserting a cover page into the disarmed document. type: str choices: [disable, enable] more...
    • detect-only - Enable/disable only detect disarmable files, do not alter content. type: str choices: [disable, enable] more...
    • office-embed - Enable/disable stripping of embedded objects in Microsoft Office documents. type: str choices: [disable, enable] more...
    • office-hylink - Enable/disable stripping of hyperlinks in Microsoft Office documents. type: str choices: [disable, enable] more...
    • office-linked - Enable/disable stripping of linked objects in Microsoft Office documents. type: str choices: [disable, enable] more...
    • office-macro - Enable/disable stripping of macros in Microsoft Office documents. type: str choices: [disable, enable] more...
    • original-file-destination - Destination to send original file if active content is removed. type: str choices: [fortisandbox, quarantine, discard] more...
    • pdf-act-form - Enable/disable stripping of actions that submit data to other targets in PDF documents. type: str choices: [disable, enable] more...
    • pdf-act-gotor - Enable/disable stripping of links to other PDFs in PDF documents. type: str choices: [disable, enable] more...
    • pdf-act-java - Enable/disable stripping of actions that execute JavaScript code in PDF documents. type: str choices: [disable, enable] more...
    • pdf-act-launch - Enable/disable stripping of links to external applications in PDF documents. type: str choices: [disable, enable] more...
    • pdf-act-movie - Enable/disable stripping of embedded movies in PDF documents. type: str choices: [disable, enable] more...
    • pdf-act-sound - Enable/disable stripping of embedded sound files in PDF documents. type: str choices: [disable, enable] more...
    • pdf-embedfile - Enable/disable stripping of embedded files in PDF documents. type: str choices: [disable, enable] more...
    • pdf-hyperlink - Enable/disable stripping of hyperlinks from PDF documents. type: str choices: [disable, enable] more...
    • pdf-javacode - Enable/disable stripping of JavaScript code in PDF documents. type: str choices: [disable, enable] more...
    • office-action - Enable/disable stripping of PowerPoint action events in Microsoft Office documents. type: str choices: [disable, enable] more...
    • office-dde - Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office documents. type: str choices: [disable, enable] more...
    • error-action - Action to be taken if CDR engine encounters an unrecoverable error. type: str choices: [block, log-only, ignore] more...

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]>
           office-action: <value in [disable, enable]>
           office-dde: <value in [disable, enable]>
           error-action: <value in [block, log-only, ignore]>

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

Status

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

Authors

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

Hint

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