fortinet.fortimanager.fmgr_antivirus_profile_nntp 模块 – 配置 NNTP 反病毒选项。
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager。
要在 Playbook 中使用它,请指定:fortinet.fortimanager.fmgr_antivirus_profile_nntp。
fortinet.fortimanager 2.0.0 中的新增功能
概要
- 此模块能够配置 FortiManager 设备。 
- 示例包括所有需要在使用前调整为数据源的参数和值。 
参数
| 参数 | 注释 | 
|---|---|
| 无需使用用户名和密码即可访问 FortiManager 的令牌。 | |
| 请求的 URL 中的参数 (adom)。 | |
| 顶层参数集。 | |
| 选择要阻止的存档类型。 选项 
 | |
| 选择要记录的存档类型。 选项 
 | |
| 启用反病毒扫描服务。 选项 
 | |
| 启用/禁用病毒模拟器。 选项 
 | |
| 启用外部阻止列表。 选项 
 | |
| 启用/禁用 FortiAI 对文件进行扫描。 选项 
 | |
| 启用 FortiNDR 对文件进行扫描。 选项 
 | |
| 启用 FortiSandbox 对文件进行扫描。 选项 
 | |
| 启用/禁用 NNTP 反病毒扫描、监视和隔离。 选项 
 | |
| 启用 FortiGuard 病毒爆发预防服务。 选项 
 | |
| 启用/禁用受感染文件的隔离。 选项 
 | |
| 仅当模块模式与 FortiManager API 结构不同时才设置为 True,模块将继续执行而不验证参数。 选项 
 | |
| 启用/禁用任务日志记录。 选项 
 | |
| 使用 forticloud API 访问令牌验证 Ansible 客户端。 | |
| 请求的 URL 中的参数 (profile)。 | |
| 用于底层 Json RPC 请求的重写方法。 选项 
 | |
| 将覆盖失败条件的 rc 代码列表。 | |
| 将覆盖成功条件的 rc 代码列表。 | |
| 在工作区模式下为 FortiManager 锁定 adom,该值可以是 global 和其他值(包括 root)。 | |
| 等待其他用户释放工作区锁定的最大时间(以秒为单位)。 默认值:  | 
说明
注意
- 从 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: Configure NNTP AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_nntp:
        # 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_nntp:
          archive_block:
            - "encrypted"
            - "corrupted"
            - "multipart"
            - "nested"
            - "mailbomb"
            - "unhandled"
            - "partiallycorrupted"
            - "fileslimit"
            - "timeout"
          archive_log:
            - "encrypted"
            - "corrupted"
            - "multipart"
            - "nested"
            - "mailbomb"
            - "unhandled"
            - "partiallycorrupted"
            - "fileslimit"
            - "timeout"
          emulator: <value in [disable, enable]>
          options:
            - "scan"
            - "file-filter"
            - "quarantine"
            - "avquery"
            - "avmonitor"
          outbreak_prevention: <value in [disabled, files, full-archive, ...]>
          av_scan: <value in [disable, monitor, block]>
          external_blocklist: <value in [disable, monitor, block]>
          quarantine: <value in [disable, enable]>
          fortindr: <value in [disable, block, monitor]>
          fortisandbox: <value in [disable, block, monitor]>
          fortiai: <value in [disable, monitor, block]>
返回值
常见的返回值在此处记录 这里,以下是此模块独有的字段
| 键 | 描述 | 
|---|---|
| 请求的结果。 返回: 总是 | |
| 请求的完整 URL。 返回: 总是 示例:  | |
| API 请求的状态。 返回: 总是 示例:  | |
| API 响应。 返回: 总是 | |
| API 响应的描述性消息。 返回: 总是 示例:  | |
| 目标系统的信息。 返回: 总是 | |
| 请求的状态。 返回: 总是 示例:  | |
| 如果剧本中使用的参数不受当前 FortiManager 版本支持,则会发出警告。 返回: 复杂 | 
