fortinet.fortimanager.fmgr_antivirus_notification 模块 – 配置反病毒通知列表。

注意

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

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

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

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_antivirus_notification。

fortinet.fortimanager 2.0.0 中的新功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

antivirus_notification

字典

顶层参数集。

comment

字符串

可选注释。

entries

列表 / elements=字典

条目。

name

字符串

病毒名称或前缀

prefix

字符串

启用基于此名称的前缀匹配

选项

  • "禁用"

  • "启用"

status

字符串

启用此条目以进行通知

选项

  • "禁用"

  • "启用"

id

整数 / 必需

ID。

name

字符串

表名称。

bypass_validation

布尔值

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

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

用于基础 Json RPC 请求的覆盖方法。

选项

  • "更新"

  • "设置"

  • "添加"

rc_failed

列表 / elements=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

用于创建、更新或删除对象的指令。

选项

  • "存在"

  • "不存在"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是全局值，也可以是包括 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 可帮助完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

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

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure AntiVirus notification lists.
      fortinet.fortimanager.fmgr_antivirus_notification:
        adom: FortiCarrier
        state: present
        antivirus_notification:
          entries:
            - name: "notification-entry"
              prefix: enable
              status: enable
          id: 1
          name: "notifiction-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the notifications
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "antivirus_notification"
          params:
            adom: "FortiCarrier" # This is FOC-only object, data will only be returned under FortiCarrier adom
            notification: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回：始终

示例： 0

response_data

列表 / elements=字符串

API 响应。

返回：始终

response_message

字符串

API 响应的描述性消息。

返回：始终

示例： "确定。"

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / elements=字符串

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

返回：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)