fortinet.fortimanager.fmgr_antivirus_profile_contentdisarm (2.4.0) — module

AV Content Disarm and Reconstruction settings.

| "added in version" 2.0.0 of fortinet.fortimanager"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

profile:
    description: The parameter (profile) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

antivirus_profile_contentdisarm:
    description: The top level parameters set.
    required: false
    suboptions:
      cover-page:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cover_page. Enable/disable inserting
          a cover page into the disarmed document.
        type: str
      detect-only:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to detect_only. Enable/disable only
          detect disarmable files, do not alter content.
        type: str
      error-action:
        choices:
        - block
        - log-only
        - ignore
        description: Deprecated, please rename it to error_action. Action to be taken
          if CDR engine encounters an unrecoverable error.
        type: str
      office-action:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to office_action. Enable/disable stripping
          of PowerPoint action events in Microsoft Office do...
        type: str
      office-dde:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to office_dde. Enable/disable stripping
          of Dynamic Data Exchange events in Microsoft Office d...
        type: str
      office-embed:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to office_embed. Enable/disable stripping
          of embedded objects in Microsoft Office documents.
        type: str
      office-hylink:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to office_hylink. Enable/disable stripping
          of hyperlinks in Microsoft Office documents.
        type: str
      office-linked:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to office_linked. Enable/disable stripping
          of linked objects in Microsoft Office documents.
        type: str
      office-macro:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to office_macro. Enable/disable stripping
          of macros in Microsoft Office documents.
        type: str
      original-file-destination:
        choices:
        - fortisandbox
        - quarantine
        - discard
        description: Deprecated, please rename it to original_file_destination. Destination
          to send original file if active content is removed.
        type: str
      pdf-act-form:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_act_form. Enable/disable stripping
          of actions that submit data to other targets in PDF...
        type: str
      pdf-act-gotor:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_act_gotor. Enable/disable stripping
          of links to other PDFs in PDF documents.
        type: str
      pdf-act-java:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_act_java. Enable/disable stripping
          of actions that execute JavaScript code in PDF docu...
        type: str
      pdf-act-launch:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_act_launch. Enable/disable stripping
          of links to external applications in PDF documents.
        type: str
      pdf-act-movie:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_act_movie. Enable/disable stripping
          of embedded movies in PDF documents.
        type: str
      pdf-act-sound:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_act_sound. Enable/disable stripping
          of embedded sound files in PDF documents.
        type: str
      pdf-embedfile:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_embedfile. Enable/disable stripping
          of embedded files in PDF documents.
        type: str
      pdf-hyperlink:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_hyperlink. Enable/disable stripping
          of hyperlinks from PDF documents.
        type: str
      pdf-javacode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pdf_javacode. Enable/disable stripping
          of JavaScript code in PDF documents.
        type: str
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list