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

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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

New in fortinet.fortimanager 2.0.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

antivirus_profile_contentdisarm

dictionary

The top level parameters set.

analytics-suspicious

string

Deprecated, please rename it to analytics_suspicious. Enable/disable using CDR as a secondary method for determining suspi…

Choices:

  • "disable"

  • "enable"

cover-page

string

Deprecated, please rename it to cover_page. Enable/disable inserting a cover page into the disarmed document.

Choices:

  • "disable"

  • "enable"

detect-only

string

Deprecated, please rename it to detect_only. Enable/disable only detect disarmable files, do not alter content.

Choices:

  • "disable"

  • "enable"

error-action

string

Deprecated, please rename it to error_action. Action to be taken if CDR engine encounters an unrecoverable error.

Choices:

  • "block"

  • "log-only"

  • "ignore"

office-action

string

Deprecated, please rename it to office_action. Enable/disable stripping of PowerPoint action events in Microsoft Office do…

Choices:

  • "disable"

  • "enable"

office-dde

string

Deprecated, please rename it to office_dde. Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office d…

Choices:

  • "disable"

  • "enable"

office-embed

string

Deprecated, please rename it to office_embed. Enable/disable stripping of embedded objects in Microsoft Office documents.

Choices:

  • "disable"

  • "enable"

string

Deprecated, please rename it to office_hylink. Enable/disable stripping of hyperlinks in Microsoft Office documents.

Choices:

  • "disable"

  • "enable"

office-linked

string

Deprecated, please rename it to office_linked. Enable/disable stripping of linked objects in Microsoft Office documents.

Choices:

  • "disable"

  • "enable"

office-macro

string

Deprecated, please rename it to office_macro. Enable/disable stripping of macros in Microsoft Office documents.

Choices:

  • "disable"

  • "enable"

original-file-destination

string

Deprecated, please rename it to original_file_destination. Destination to send original file if active content is removed.

Choices:

  • "fortisandbox"

  • "quarantine"

  • "discard"

pdf-act-form

string

Deprecated, please rename it to pdf_act_form. Enable/disable stripping of actions that submit data to other targets in PDF…

Choices:

  • "disable"

  • "enable"

pdf-act-gotor

string

Deprecated, please rename it to pdf_act_gotor. Enable/disable stripping of links to other PDFs in PDF documents.

Choices:

  • "disable"

  • "enable"

pdf-act-java

string

Deprecated, please rename it to pdf_act_java. Enable/disable stripping of actions that execute JavaScript code in PDF docu…

Choices:

  • "disable"

  • "enable"

pdf-act-launch

string

Deprecated, please rename it to pdf_act_launch. Enable/disable stripping of links to external applications in PDF documents.

Choices:

  • "disable"

  • "enable"

pdf-act-movie

string

Deprecated, please rename it to pdf_act_movie. Enable/disable stripping of embedded movies in PDF documents.

Choices:

  • "disable"

  • "enable"

pdf-act-sound

string

Deprecated, please rename it to pdf_act_sound. Enable/disable stripping of embedded sound files in PDF documents.

Choices:

  • "disable"

  • "enable"

pdf-embedfile

string

Deprecated, please rename it to pdf_embedfile. Enable/disable stripping of embedded files in PDF documents.

Choices:

  • "disable"

  • "enable"

string

Deprecated, please rename it to pdf_hyperlink. Enable/disable stripping of hyperlinks from PDF documents.

Choices:

  • "disable"

  • "enable"

pdf-javacode

string

Deprecated, please rename it to pdf_javacode. Enable/disable stripping of JavaScript code in PDF documents.

Choices:

  • "disable"

  • "enable"

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

profile

string / required

The parameter (profile) in requested url.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  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.
      fortinet.fortimanager.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]>
          analytics_suspicious: <value in [disable, enable]>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)