fortinet.fortimanager.fmgr_antivirus_profile_contentdisarm 模块 – AV 内容清除和重建设置。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_antivirus_profile_contentdisarm。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有需要在使用前调整为数据源的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必填

请求 URL 中的参数 (adom)。

antivirus_profile_contentdisarm

字典

设置的顶级参数。

analytics_suspicious

别名：analytics-suspicious

字符串

启用/禁用使用 CDR 作为确定分析可疑文件的辅助方法。

选项

  • "disable"

  • "enable"

cover_page

别名：cover-page

字符串

启用/禁用在清除的文档中插入封面。

选项

  • "disable"

  • "enable"

detect_only

别名：detect-only

字符串

启用/禁用仅检测可清除的文件，不更改内容。

选项

  • "disable"

  • "enable"

error_action

别名：error-action

字符串

如果 CDR 引擎遇到不可恢复的错误，则采取的操作。

选项

  • "block"

  • "log-only"

  • "ignore"

office_action

别名：office-action

字符串

启用/禁用剥离 Microsoft Office 文档中的 PowerPoint 操作事件。

选项

  • "disable"

  • "enable"

office_dde

别名：office-dde

字符串

启用/禁用剥离 Microsoft Office 文档中的动态数据交换事件。

选项

  • "disable"

  • "enable"

office_embed

别名：office-embed

字符串

启用/禁用剥离 Microsoft Office 文档中的嵌入对象。

选项

  • "disable"

  • "enable"

office_hylink

别名：office-hylink

字符串

启用/禁用剥离 Microsoft Office 文档中的超链接。

选项

  • "disable"

  • "enable"

office_linked

别名：office-linked

字符串

启用/禁用剥离 Microsoft Office 文档中的链接对象。

选项

  • "disable"

  • "enable"

office_macro

别名：office-macro

字符串

启用/禁用剥离 Microsoft Office 文档中的宏。

选项

  • "disable"

  • "enable"

original_file_destination

别名：original-file-destination

字符串

如果删除了活动内容，则发送原始文件的目标。

选项

  • "fortisandbox"

  • "quarantine"

  • "discard"

pdf_act_form

别名：pdf-act-form

字符串

启用/禁用剥离将数据提交到 PDF 文档中其他目标的操作。

选项

  • "disable"

  • "enable"

pdf_act_gotor

别名：pdf-act-gotor

字符串

启用/禁用剥离 PDF 文档中到其他 PDF 的链接。

选项

  • "disable"

  • "enable"

pdf_act_java

别名：pdf-act-java

字符串

启用/禁用剥离 PDF 文档中执行 JavaScript 代码的操作。

选项

  • "disable"

  • "enable"

pdf_act_launch

别名：pdf-act-launch

字符串

启用/禁用剥离 PDF 文档中到外部应用程序的链接。

选项

  • "disable"

  • "enable"

pdf_act_movie

别名：pdf-act-movie

字符串

启用/禁用剥离 PDF 文档中的嵌入式电影。

选项

  • "disable"

  • "enable"

pdf_act_sound

别名：pdf-act-sound

字符串

启用/禁用剥离 PDF 文档中的嵌入式声音文件。

选项

  • "disable"

  • "enable"

pdf_embedfile

别名：pdf-embedfile

字符串

启用/禁用剥离 PDF 文档中的嵌入式文件。

选项

  • "disable"

  • "enable"

pdf_hyperlink

别名：pdf-hyperlink

字符串

启用/禁用剥离 PDF 文档中的超链接。

选项

  • "disable"

  • "enable"

pdf_javacode

别名：pdf-javacode

字符串

启用/禁用剥离 PDF 文档中的 JavaScript 代码。

选项

  • "disable"

  • "enable"

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用FortiCloud API访问令牌认证Ansible客户端。

profile

字符串 / 必填

请求URL中的参数 (profile)。

proposed_method

字符串

底层Json RPC请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将被覆盖的失败条件对应的RC代码列表。

rc_succeeded

列表 / 元素=整数

将被覆盖的成功条件对应的RC代码列表。

workspace_locking_adom

字符串

在工作区模式下运行FortiManager时要锁定的ADOM，值可以是global和其他包括root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

备注

注意

  • 从2.4.0版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在ansible.cfg中设置deprecation_warnings=False来忽略此警告。

  • 此FortiManager模块支持在工作区锁定模式下运行，顶级参数workspace_locking_adom和workspace_locking_timeout有助于完成此工作。

  • 通常，当返回非零RC代码时，运行一个模块可能会失败。您也可以使用参数rc_failed和rc_succeeded覆盖失败或成功的条件。

示例

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

返回值

常见的返回值已在此处记录，以下是此模块特有的字段。

键

描述

meta

字典

请求的结果。

返回值： 始终

request_url

字符串

请求的完整URL。

返回值： 始终

示例： "/sys/login/user"

response_code

整数

API请求的状态。

返回值： 始终

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回值： 始终

response_message

字符串

API响应的描述性消息。

返回值： 始终

示例： "OK."

system_information

字典

目标系统的信息。

返回值： 始终

rc

整数

请求的状态。

返回值： 始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。

返回值： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑链 (@chillancezen)

  • 沈芳 (@fshen01)

  • 卢洪宾 (@fgtdev-hblu)